use crate::filter_types::*;
use crate::formula_types::{FormulaDefault, PlanFormula};
use crate::semantic::*;
use alloc::collections::BTreeMap;
use alloc::string::String;
use alloc::vec::Vec;
use serde::Serialize;
#[derive(Debug, Clone, Serialize)]
pub struct QueryBatchRequest {
pub searches: Vec<QueryRequest>,
}
#[derive(Debug, Clone, Serialize)]
pub struct QueryRequest {
pub query: QueryVariant,
#[serde(skip_serializing_if = "Option::is_none")]
pub using: Option<String>,
#[serde(skip_serializing_if = "Vec::is_empty")]
pub prefetch: Vec<PrefetchRequest>,
#[serde(skip_serializing_if = "Option::is_none")]
pub filter: Option<FilterExpression>,
#[serde(skip_serializing_if = "Option::is_none")]
pub params: Option<SearchParamsRequest>,
#[serde(skip_serializing_if = "Option::is_none")]
pub score_threshold: Option<f64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub with_payload: Option<PayloadSelectorReq>,
#[serde(skip_serializing_if = "Option::is_none")]
pub with_vector: Option<VectorSelectorReq>,
#[serde(skip_serializing_if = "Option::is_none")]
pub limit: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub offset: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none", rename = "lookup_from")]
pub lookup_from: Option<LookupRequest>,
#[serde(skip_serializing_if = "Option::is_none")]
pub shard_key: Option<crate::semantic::PlanShardKey>,
#[serde(skip)]
pub timeout: Option<u64>,
#[serde(skip)]
pub consistency: Option<ReadConsistencyParam>,
}
#[derive(Debug, Clone, Serialize)]
pub struct QueryGroupsRequest {
pub query: QueryVariant,
#[serde(skip_serializing_if = "Option::is_none")]
pub using: Option<String>,
#[serde(skip_serializing_if = "Vec::is_empty")]
pub prefetch: Vec<PrefetchRequest>,
#[serde(skip_serializing_if = "Option::is_none")]
pub filter: Option<FilterExpression>,
#[serde(skip_serializing_if = "Option::is_none")]
pub params: Option<SearchParamsRequest>,
#[serde(skip_serializing_if = "Option::is_none")]
pub score_threshold: Option<f64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub with_payload: Option<PayloadSelectorReq>,
#[serde(skip_serializing_if = "Option::is_none")]
pub with_vector: Option<VectorSelectorReq>,
pub group_by: String,
pub group_size: u64,
pub limit: u64,
#[serde(skip_serializing_if = "Option::is_none")]
pub with_lookup: Option<WithLookupValue>,
#[serde(skip_serializing_if = "Option::is_none", rename = "lookup_from")]
pub lookup_from: Option<LookupRequest>,
#[serde(skip_serializing_if = "Option::is_none")]
pub shard_key: Option<crate::semantic::PlanShardKey>,
#[serde(skip)]
pub timeout: Option<u64>,
#[serde(skip)]
pub consistency: Option<ReadConsistencyParam>,
#[serde(skip)]
pub group_offset: Option<u64>,
}
#[derive(Debug, Clone, PartialEq)]
pub enum ReadConsistencyParam {
Factor(u64),
Majority,
Quorum,
All,
}
impl ReadConsistencyParam {
pub fn to_query_value(&self) -> String {
match self {
Self::Factor(n) => n.to_string(),
Self::Majority => "majority".into(),
Self::Quorum => "quorum".into(),
Self::All => "all".into(),
}
}
}
impl From<&qql_core::ast::ReadConsistency> for ReadConsistencyParam {
fn from(value: &qql_core::ast::ReadConsistency) -> Self {
match value {
qql_core::ast::ReadConsistency::Factor(n) => Self::Factor(*n),
qql_core::ast::ReadConsistency::Majority => Self::Majority,
qql_core::ast::ReadConsistency::Quorum => Self::Quorum,
qql_core::ast::ReadConsistency::All => Self::All,
}
}
}
#[derive(Debug, Clone, Serialize)]
#[serde(untagged)]
pub enum WithLookupValue {
Collection(String),
Full(WithLookup),
}
#[derive(Debug, Clone, Serialize)]
pub struct WithLookup {
pub collection: String,
#[serde(skip_serializing_if = "Option::is_none")]
pub with_payload: Option<PayloadSelectorReq>,
#[serde(skip_serializing_if = "Option::is_none")]
pub with_vectors: Option<VectorSelectorReq>,
}
#[derive(Debug, Clone, Serialize)]
pub struct AcornSearchParams {
pub enable: bool,
#[serde(skip_serializing_if = "Option::is_none")]
pub max_selectivity: Option<f64>,
}
#[derive(Debug, Clone, Serialize)]
pub struct SearchParamsRequest {
#[serde(skip_serializing_if = "Option::is_none")]
pub hnsw_ef: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub exact: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub acorn: Option<AcornSearchParams>,
#[serde(skip_serializing_if = "Option::is_none")]
pub indexed_only: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub quantization: Option<QuantizationSearchRequest>,
#[serde(skip_serializing_if = "Option::is_none")]
pub idf: Option<IdfSearchParams>,
}
#[derive(Debug, Clone, Serialize)]
pub struct QuantizationSearchRequest {
#[serde(skip_serializing_if = "Option::is_none")]
pub ignore: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub rescore: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub oversampling: Option<f64>,
}
#[derive(Debug, Clone)]
pub enum IdfSearchParams {
Global,
Corpus {
corpus: FilterExpression,
},
}
impl Serialize for IdfSearchParams {
fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
use serde::ser::SerializeMap;
match self {
IdfSearchParams::Global => serializer.serialize_str("global"),
IdfSearchParams::Corpus { corpus } => {
let mut map = serializer.serialize_map(Some(1))?;
map.serialize_entry("corpus", corpus)?;
map.end()
}
}
}
}
#[derive(Debug, Clone, Serialize)]
pub struct NearestQuery {
pub nearest: PlanQueryInput,
#[serde(skip_serializing_if = "Option::is_none")]
pub mmr: Option<MmrQueryParams>,
}
#[derive(Debug, Clone, Serialize)]
pub struct MmrQueryParams {
pub diversity: f64,
pub candidates_limit: u64,
}
#[derive(Debug, Clone, Serialize)]
#[serde(untagged)]
pub enum QueryVariant {
Nearest(NearestQuery),
Recommend {
recommend: RecommendQuery,
},
Context {
context: Vec<ContextPair>,
},
Discover {
discover: DiscoverQuery,
},
OrderBy {
order_by: OrderByQuery,
},
Sample {
sample: String,
},
Fusion {
fusion: String,
},
Rrf(RrfQuery),
Formula(FormulaQuery),
RelevanceFeedback {
relevance_feedback: RelevanceFeedbackInput,
},
}
#[derive(Debug, Clone, Serialize)]
pub struct RrfParams {
#[serde(skip_serializing_if = "Option::is_none")]
pub k: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub weights: Option<Vec<f64>>,
}
#[derive(Debug, Clone, Serialize)]
pub struct RrfQuery {
pub rrf: RrfParams,
}
#[derive(Debug, Clone, Serialize)]
pub struct FormulaQuery {
pub formula: PlanFormula,
#[serde(skip_serializing_if = "Option::is_none")]
pub defaults: Option<BTreeMap<String, FormulaDefault>>,
}
#[derive(Debug, Clone, Serialize)]
pub struct RelevanceFeedbackInput {
pub target: PlanQueryInput,
pub feedback: Vec<FeedbackItem>,
pub strategy: FeedbackStrategy,
}
#[derive(Debug, Clone, Serialize)]
pub struct FeedbackItem {
pub example: PlanQueryInput,
pub score: f64,
}
#[derive(Debug, Clone, Serialize)]
pub struct FeedbackStrategy {
pub naive: NaiveFeedbackStrategyParams,
}
#[derive(Debug, Clone, Serialize)]
pub struct NaiveFeedbackStrategyParams {
pub a: f64,
pub b: f64,
pub c: f64,
}
#[derive(Debug, Clone, Serialize)]
pub struct RecommendQuery {
pub positive: Vec<PlanQueryInput>,
pub negative: Vec<PlanQueryInput>,
#[serde(skip_serializing_if = "Option::is_none")]
pub strategy: Option<String>,
}
#[derive(Debug, Clone, Serialize)]
pub struct ContextPair {
pub positive: PlanQueryInput,
pub negative: PlanQueryInput,
}
#[derive(Debug, Clone, Serialize)]
pub struct DiscoverQuery {
pub target: PlanQueryInput,
pub context: Vec<ContextPair>,
}
#[derive(Debug, Clone, Serialize)]
pub struct OrderByQuery {
pub key: String,
#[serde(skip_serializing_if = "Option::is_none")]
pub direction: Option<String>,
#[serde(
skip_serializing_if = "Option::is_none",
serialize_with = "crate::value_serde::serialize_ast_value_opt"
)]
pub start_from: Option<qql_core::ast::Value>,
}
#[derive(Debug, Clone, Serialize)]
pub struct PrefetchRequest {
#[serde(skip_serializing_if = "Option::is_none")]
pub query: Option<QueryVariant>,
#[serde(skip_serializing_if = "Option::is_none")]
pub using: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub filter: Option<FilterExpression>,
#[serde(skip_serializing_if = "Option::is_none")]
pub params: Option<SearchParamsRequest>,
#[serde(skip_serializing_if = "Option::is_none")]
pub score_threshold: Option<f64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub limit: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub lookup_from: Option<LookupRequest>,
#[serde(skip_serializing_if = "Option::is_none")]
pub prefetch: Option<Vec<PrefetchRequest>>,
}
#[derive(Debug, Clone, Serialize)]
pub struct LookupRequest {
pub collection: String,
#[serde(skip_serializing_if = "Option::is_none")]
pub vector: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub shard_key: Option<crate::semantic::PlanShardKey>,
}
#[derive(Debug, Clone, Serialize)]
#[serde(untagged)]
pub enum PayloadSelectorReq {
All(bool),
Include {
include: Vec<String>,
},
Exclude {
exclude: Vec<String>,
},
}
#[derive(Debug, Clone, Serialize)]
#[serde(untagged)]
pub enum VectorSelectorReq {
All(bool),
Names(Vec<String>),
}