use alloc::collections::BTreeMap;
use alloc::string::String;
use alloc::vec::Vec;
use qql_core::ast::{MemoryPlacement, VectorDatatype, VectorDistance};
use serde::{Deserialize, Deserializer, Serialize, Serializer};
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct HnswConfig {
#[serde(skip_serializing_if = "Option::is_none")]
pub m: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub ef_construct: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub full_scan_threshold: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub max_indexing_threads: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub on_disk: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub payload_m: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub inline_storage: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub memory: Option<MemoryPlacement>,
}
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum MaxOptimizationThreads {
Auto,
Threads(u64),
}
impl Serialize for MaxOptimizationThreads {
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
match self {
Self::Auto => serializer.serialize_str("auto"),
Self::Threads(threads) => serializer.serialize_u64(*threads),
}
}
}
impl<'de> Deserialize<'de> for MaxOptimizationThreads {
fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
struct Visitor;
impl serde::de::Visitor<'_> for Visitor {
type Value = MaxOptimizationThreads;
fn expecting(&self, formatter: &mut alloc::fmt::Formatter) -> alloc::fmt::Result {
formatter.write_str("a thread count or \"auto\"")
}
fn visit_u64<E: serde::de::Error>(self, value: u64) -> Result<Self::Value, E> {
Ok(MaxOptimizationThreads::Threads(value))
}
fn visit_i64<E: serde::de::Error>(self, value: i64) -> Result<Self::Value, E> {
u64::try_from(value)
.map(MaxOptimizationThreads::Threads)
.map_err(|_| E::invalid_value(serde::de::Unexpected::Signed(value), &self))
}
fn visit_str<E: serde::de::Error>(self, value: &str) -> Result<Self::Value, E> {
if value.eq_ignore_ascii_case("auto") {
Ok(MaxOptimizationThreads::Auto)
} else {
Err(E::invalid_value(serde::de::Unexpected::Str(value), &self))
}
}
}
deserializer.deserialize_any(Visitor)
}
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct OptimizersConfig {
#[serde(skip_serializing_if = "Option::is_none")]
pub deleted_threshold: Option<f64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub vacuum_min_vector_number: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub default_segment_number: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub max_segment_size: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub memmap_threshold: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub indexing_threshold: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub flush_interval_sec: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub max_optimization_threads: Option<MaxOptimizationThreads>,
#[serde(skip_serializing_if = "Option::is_none")]
pub prevent_unoptimized: Option<bool>,
}
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(untagged)]
pub enum QuantizationConfig {
Scalar {
scalar: ScalarQuantization,
},
Product {
product: ProductQuantization,
},
Binary {
binary: BinaryQuantization,
},
Turbo {
turbo: TurboQuantization,
},
}
#[derive(Debug, Clone)]
pub enum QuantizationConfigDiff {
Disabled,
Config(QuantizationConfig),
}
impl Serialize for QuantizationConfigDiff {
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
match self {
Self::Disabled => serializer.serialize_str("Disabled"),
Self::Config(config) => config.serialize(serializer),
}
}
}
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct ScalarQuantization {
#[serde(rename = "type")]
pub qtype: String,
#[serde(skip_serializing_if = "Option::is_none")]
pub quantile: Option<f64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub always_ram: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub memory: Option<MemoryPlacement>,
}
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct ProductQuantization {
pub compression: String,
#[serde(skip_serializing_if = "Option::is_none")]
pub always_ram: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub memory: Option<MemoryPlacement>,
}
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct BinaryQuantization {
#[serde(skip_serializing_if = "Option::is_none")]
pub always_ram: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub encoding: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub query_encoding: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub memory: Option<MemoryPlacement>,
}
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct TurboQuantization {
#[serde(skip_serializing_if = "Option::is_none")]
pub bits: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub always_ram: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub memory: Option<MemoryPlacement>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize)]
pub struct WalConfig {
#[serde(rename = "wal_capacity_mb", skip_serializing_if = "Option::is_none")]
pub capacity_mb: Option<u64>,
#[serde(rename = "wal_segments_ahead", skip_serializing_if = "Option::is_none")]
pub segments_ahead: Option<u64>,
#[serde(rename = "wal_retain_closed", skip_serializing_if = "Option::is_none")]
pub retain_closed: Option<u64>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize)]
pub struct StrictModeConfig {
#[serde(skip_serializing_if = "Option::is_none")]
pub enabled: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub max_query_limit: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub max_timeout: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub unindexed_filtering_retrieve: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub unindexed_filtering_update: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub search_max_hnsw_ef: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub search_allow_exact: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub search_max_oversampling: Option<f64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub upsert_max_batchsize: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub search_max_batchsize: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub max_collection_vector_size_bytes: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub read_rate_limit: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub write_rate_limit: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub max_collection_payload_size_bytes: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub max_points_count: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub filter_max_conditions: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub condition_max_size: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub multivector_config: Option<StrictModeMultivectorConfig>,
#[serde(skip_serializing_if = "Option::is_none")]
pub sparse_config: Option<StrictModeSparseConfig>,
#[serde(skip_serializing_if = "Option::is_none")]
pub max_payload_index_count: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub max_resident_memory_percent: Option<u64>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize)]
pub struct StrictModeMultivectorConfig {
#[serde(flatten)]
pub vectors: BTreeMap<String, StrictModeMultivector>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize)]
pub struct StrictModeMultivector {
#[serde(skip_serializing_if = "Option::is_none")]
pub max_vectors: Option<u64>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize)]
pub struct StrictModeSparseConfig {
#[serde(flatten)]
pub vectors: BTreeMap<String, StrictModeSparse>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize)]
pub struct StrictModeSparse {
#[serde(skip_serializing_if = "Option::is_none")]
pub max_length: Option<u64>,
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum MultiVectorComparator {
MaxSim,
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
pub struct MultiVectorConfig {
pub comparator: MultiVectorComparator,
}
#[derive(Debug, Clone, Serialize)]
pub struct DenseVectorParams {
pub size: u64,
pub distance: VectorDistance,
#[serde(skip_serializing_if = "Option::is_none")]
pub hnsw_config: Option<HnswConfig>,
#[serde(skip_serializing_if = "Option::is_none")]
pub quantization_config: Option<QuantizationConfig>,
#[serde(skip_serializing_if = "Option::is_none")]
pub on_disk: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub memory: Option<MemoryPlacement>,
#[serde(skip_serializing_if = "Option::is_none")]
pub datatype: Option<VectorDatatype>,
#[serde(skip_serializing_if = "Option::is_none")]
pub multivector_config: Option<MultiVectorConfig>,
}
#[derive(Debug, Clone, Serialize)]
#[serde(untagged)]
pub enum DenseVectorsConfig {
Single(DenseVectorParams),
Named(BTreeMap<String, DenseVectorParams>),
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
#[serde(rename_all = "lowercase")]
pub enum SparseModifier {
None,
Idf,
}
#[derive(Debug, Clone, Serialize)]
pub struct SparseIndexParams {
#[serde(skip_serializing_if = "Option::is_none")]
pub full_scan_threshold: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub on_disk: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub memory: Option<MemoryPlacement>,
#[serde(skip_serializing_if = "Option::is_none")]
pub datatype: Option<VectorDatatype>,
}
#[derive(Debug, Clone, Serialize)]
pub struct SparseVectorParams {
#[serde(skip_serializing_if = "Option::is_none")]
pub index: Option<SparseIndexParams>,
pub modifier: SparseModifier,
}
#[derive(Debug, Clone, Default, Serialize)]
pub struct VectorParamsDiff {
#[serde(skip_serializing_if = "Option::is_none")]
pub hnsw_config: Option<HnswConfig>,
#[serde(skip_serializing_if = "Option::is_none")]
pub quantization_config: Option<QuantizationConfigDiff>,
#[serde(skip_serializing_if = "Option::is_none")]
pub on_disk: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub memory: Option<MemoryPlacement>,
}
#[derive(Debug, Clone, Default, Serialize)]
pub struct SparseVectorParamsDiff {
#[serde(skip_serializing_if = "Option::is_none")]
pub index: Option<SparseIndexParams>,
#[serde(skip_serializing_if = "Option::is_none")]
pub modifier: Option<SparseModifier>,
}
#[derive(Debug, Clone, Default, Serialize)]
pub struct PayloadStorageParams {
#[serde(skip_serializing_if = "Option::is_none")]
pub memory: Option<MemoryPlacement>,
}
#[derive(Debug, Clone, Default, Serialize)]
pub struct CollectionParams {
#[serde(skip_serializing_if = "Option::is_none")]
pub replication_factor: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub write_consistency_factor: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub read_fan_out_factor: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub read_fan_out_delay_ms: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub on_disk_payload: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub payload: Option<PayloadStorageParams>,
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
#[serde(rename_all = "lowercase")]
pub enum ShardingMethod {
Auto,
Custom,
}
#[derive(Debug, Clone, Default, Serialize)]
pub struct CreateCollectionRequest {
#[serde(skip_serializing_if = "Option::is_none")]
pub vectors: Option<DenseVectorsConfig>,
#[serde(skip_serializing_if = "Option::is_none")]
pub sparse_vectors: Option<BTreeMap<String, SparseVectorParams>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub hnsw_config: Option<HnswConfig>,
#[serde(skip_serializing_if = "Option::is_none")]
pub optimizers_config: Option<OptimizersConfig>,
#[serde(skip_serializing_if = "Option::is_none")]
pub params: Option<CollectionParams>,
#[serde(skip_serializing_if = "Option::is_none")]
pub quantization_config: Option<QuantizationConfig>,
#[serde(skip_serializing_if = "Option::is_none")]
pub wal_config: Option<Box<WalConfig>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub strict_mode_config: Option<Box<StrictModeConfig>>,
#[serde(
skip_serializing_if = "Option::is_none",
serialize_with = "crate::value_serde::serialize_ast_pairs_opt"
)]
pub metadata: Option<Vec<(String, qql_core::ast::Value)>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub shard_number: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub sharding_method: Option<ShardingMethod>,
#[serde(skip_serializing_if = "Option::is_none")]
pub shard_keys: Option<Vec<crate::semantic::PlanShardKey>>,
}
#[derive(Debug, Clone, Default, Serialize)]
pub struct UpdateCollectionRequest {
#[serde(skip_serializing_if = "Option::is_none")]
pub optimizers_config: Option<OptimizersConfig>,
#[serde(skip_serializing_if = "Option::is_none")]
pub params: Option<CollectionParams>,
#[serde(skip_serializing_if = "Option::is_none")]
pub hnsw_config: Option<HnswConfig>,
#[serde(skip_serializing_if = "Option::is_none")]
pub quantization_config: Option<QuantizationConfigDiff>,
#[serde(skip_serializing_if = "Option::is_none")]
pub strict_mode_config: Option<Box<StrictModeConfig>>,
#[serde(
skip_serializing_if = "Option::is_none",
serialize_with = "crate::value_serde::serialize_ast_pairs_opt"
)]
pub metadata: Option<Vec<(String, qql_core::ast::Value)>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub vectors: Option<BTreeMap<String, VectorParamsDiff>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub sparse_vectors: Option<BTreeMap<String, SparseVectorParamsDiff>>,
}
#[derive(Debug, Clone, Serialize)]
pub struct CreateShardKeyRequest {
pub shard_key: crate::semantic::PlanShardKey,
#[serde(skip_serializing_if = "Option::is_none")]
pub shards_number: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub replication_factor: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub placement: Option<Vec<u64>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub initial_state: Option<String>,
}
#[derive(Debug, Clone, Serialize)]
pub struct DropShardKeyRequest {
pub shard_key: crate::semantic::PlanShardKey,
}
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
pub struct QuotaConfig {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub enabled: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub max_resident_memory_percent: Option<u64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub max_disk_usage_percent: Option<u64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub release_margin_percent: Option<u64>,
}
#[derive(Debug, Clone, Default, Serialize)]
pub struct SetQuotaRequest {
#[serde(flatten)]
pub config: QuotaConfig,
#[serde(skip)]
pub wait: Option<bool>,
}