use serde::{Deserialize, Serialize};
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(default, deny_unknown_fields)]
pub struct MemoryConfig {
pub max_documents: usize,
pub max_estimated_bytes: usize,
pub max_document_bytes: usize,
pub max_vector_dimensions: usize,
pub max_vector_spaces: usize,
pub max_batch_documents: usize,
pub max_candidates: usize,
pub hnsw_m: usize,
pub ef_construction: usize,
pub ef_search: usize,
}
impl Default for MemoryConfig {
fn default() -> Self {
Self {
max_documents: 1_000_000,
max_estimated_bytes: 1024 * 1024 * 1024,
max_document_bytes: 1024 * 1024,
max_vector_dimensions: 4096,
max_vector_spaces: 32,
max_batch_documents: 10_000,
max_candidates: 4096,
hnsw_m: 16,
ef_construction: 96,
ef_search: 64,
}
}
}
impl MemoryConfig {
pub fn edge() -> Self {
Self {
max_documents: 10_000,
max_estimated_bytes: 16 * 1024 * 1024,
max_document_bytes: 64 * 1024,
max_vector_dimensions: 768,
max_vector_spaces: 4,
max_batch_documents: 256,
max_candidates: 256,
hnsw_m: 8,
ef_construction: 48,
ef_search: 32,
}
}
pub fn research() -> Self {
Self {
max_estimated_bytes: usize::try_from(4u64 * 1024 * 1024 * 1024).unwrap_or(usize::MAX),
max_vector_dimensions: 8192,
ef_construction: 128,
ef_search: 1024,
..Self::default()
}
}
pub(crate) fn validate(&self) -> crate::Result<()> {
if self.max_documents == 0
|| self.max_estimated_bytes == 0
|| self.max_document_bytes == 0
|| self.max_vector_dimensions == 0
|| self.max_vector_spaces == 0
|| self.max_batch_documents == 0
|| self.max_candidates == 0
|| self.hnsw_m < 2
|| self.hnsw_m > 128
|| self.ef_construction < self.hnsw_m
|| self.ef_construction > 4096
|| self.ef_search == 0
|| self.ef_search > 65_536
{
return Err(crate::Error::ConstraintViolation(
"Invalid memory resource/index configuration".into(),
));
}
Ok(())
}
}
#[derive(Debug, Default, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "snake_case")]
pub enum MemoryFusion {
#[default]
Rrf,
Weighted,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct MemoryStats {
pub documents: usize,
pub estimated_resident_bytes: usize,
pub max_estimated_bytes: usize,
pub vector_spaces: usize,
pub indexed_vectors: usize,
pub pending_index_updates: usize,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct MemorySearchDiagnostics {
pub total_documents: usize,
pub candidate_limit: usize,
pub lexical_candidates: usize,
pub vector_candidates: usize,
pub scored_candidates: usize,
pub exact_vector_search: bool,
pub vector_indexes_used: usize,
pub fusion: MemoryFusion,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct MemorySearchResponse {
pub results: Vec<super::MemoryRecallResult>,
pub diagnostics: MemorySearchDiagnostics,
}