1use serde::{Deserialize, Serialize};
2
3pub type VectorId = String;
5
6pub type NamespaceId = String;
8
9#[derive(Debug, Clone, Serialize, Deserialize)]
11pub struct Vector {
12 pub id: VectorId,
13 pub values: Vec<f32>,
14 #[serde(skip_serializing_if = "Option::is_none")]
15 pub metadata: Option<serde_json::Value>,
16 #[serde(skip_serializing_if = "Option::is_none")]
18 pub ttl_seconds: Option<u64>,
19 #[serde(skip_serializing_if = "Option::is_none")]
21 pub expires_at: Option<u64>,
22}
23
24impl Vector {
25 pub fn is_expired(&self) -> bool {
27 if let Some(expires_at) = self.expires_at {
28 let now = std::time::SystemTime::now()
29 .duration_since(std::time::UNIX_EPOCH)
30 .unwrap_or_default()
31 .as_secs();
32 now >= expires_at
33 } else {
34 false
35 }
36 }
37
38 #[inline]
41 pub fn is_expired_at(&self, now_secs: u64) -> bool {
42 self.expires_at.is_some_and(|exp| now_secs >= exp)
43 }
44
45 pub fn apply_ttl(&mut self) {
47 if let Some(ttl) = self.ttl_seconds {
48 let now = std::time::SystemTime::now()
49 .duration_since(std::time::UNIX_EPOCH)
50 .unwrap_or_default()
51 .as_secs();
52 self.expires_at = Some(now + ttl);
53 }
54 }
55
56 pub fn remaining_ttl(&self) -> Option<u64> {
58 self.expires_at.and_then(|expires_at| {
59 let now = std::time::SystemTime::now()
60 .duration_since(std::time::UNIX_EPOCH)
61 .unwrap_or_default()
62 .as_secs();
63 if now < expires_at {
64 Some(expires_at - now)
65 } else {
66 None
67 }
68 })
69 }
70}
71
72#[derive(Debug, Deserialize)]
74pub struct UpsertRequest {
75 pub vectors: Vec<Vector>,
76}
77
78#[derive(Debug, Serialize, Deserialize)]
80pub struct UpsertResponse {
81 pub upserted_count: usize,
82}
83
84#[derive(Debug, Deserialize)]
87pub struct ColumnUpsertRequest {
88 pub ids: Vec<VectorId>,
90 pub vectors: Vec<Vec<f32>>,
92 #[serde(default)]
95 pub attributes: std::collections::HashMap<String, Vec<serde_json::Value>>,
96 #[serde(default)]
98 pub ttl_seconds: Option<u64>,
99 #[serde(default)]
101 pub dimension: Option<usize>,
102}
103
104impl ColumnUpsertRequest {
105 pub fn to_vectors(&self) -> Result<Vec<Vector>, String> {
107 let count = self.ids.len();
108
109 if self.vectors.len() != count {
111 return Err(format!(
112 "vectors array length ({}) doesn't match ids array length ({})",
113 self.vectors.len(),
114 count
115 ));
116 }
117
118 for (attr_name, attr_values) in &self.attributes {
119 if attr_values.len() != count {
120 return Err(format!(
121 "attribute '{}' array length ({}) doesn't match ids array length ({})",
122 attr_name,
123 attr_values.len(),
124 count
125 ));
126 }
127 }
128
129 let expected_dim = if let Some(dim) = self.dimension {
132 Some(dim)
133 } else {
134 self.vectors.first().map(|v| v.len())
135 };
136
137 if let Some(expected) = expected_dim {
138 for (i, vec) in self.vectors.iter().enumerate() {
139 if vec.len() != expected {
140 return Err(format!(
141 "vectors[{}] has dimension {} but expected {}",
142 i,
143 vec.len(),
144 expected
145 ));
146 }
147 }
148 }
149
150 let mut vectors = Vec::with_capacity(count);
152 for i in 0..count {
153 let metadata = if self.attributes.is_empty() {
155 None
156 } else {
157 let mut meta = serde_json::Map::new();
158 for (attr_name, attr_values) in &self.attributes {
159 let value = &attr_values[i];
160 if !value.is_null() {
161 meta.insert(attr_name.clone(), value.clone());
162 }
163 }
164 if meta.is_empty() {
165 None
166 } else {
167 Some(serde_json::Value::Object(meta))
168 }
169 };
170
171 let mut vector = Vector {
172 id: self.ids[i].clone(),
173 values: self.vectors[i].clone(),
174 metadata,
175 ttl_seconds: self.ttl_seconds,
176 expires_at: None,
177 };
178 vector.apply_ttl();
179 vectors.push(vector);
180 }
181
182 Ok(vectors)
183 }
184}
185
186#[derive(Debug, Clone, Copy, Default, Deserialize, Serialize, PartialEq, Eq)]
188#[serde(rename_all = "snake_case")]
189pub enum DistanceMetric {
190 #[default]
191 Cosine,
192 Euclidean,
193 DotProduct,
194}
195
196#[derive(Debug, Clone, Copy, Default, Deserialize, Serialize, PartialEq, Eq)]
203#[serde(rename_all = "snake_case")]
204pub enum ReadConsistency {
205 Strong,
207 #[default]
209 Eventual,
210 #[serde(rename = "bounded_staleness")]
212 BoundedStaleness,
213}
214
215#[derive(Debug, Clone, Copy, Default, Deserialize, Serialize, PartialEq, Eq)]
217pub struct StalenessConfig {
218 #[serde(default = "default_max_staleness_ms")]
220 pub max_staleness_ms: u64,
221}
222
223fn default_max_staleness_ms() -> u64 {
224 5000 }
226
227#[derive(Debug, Deserialize)]
229pub struct QueryRequest {
230 pub vector: Vec<f32>,
231 #[serde(default = "default_top_k")]
232 pub top_k: usize,
233 #[serde(default)]
234 pub distance_metric: DistanceMetric,
235 #[serde(default = "default_true")]
236 pub include_metadata: bool,
237 #[serde(default)]
238 pub include_vectors: bool,
239 #[serde(default)]
241 pub filter: Option<FilterExpression>,
242 #[serde(default)]
244 pub cursor: Option<String>,
245 #[serde(default)]
248 pub consistency: ReadConsistency,
249 #[serde(default)]
251 pub staleness_config: Option<StalenessConfig>,
252}
253
254fn default_top_k() -> usize {
255 10
256}
257
258fn default_true() -> bool {
259 true
260}
261
262#[derive(Debug, Serialize, Deserialize)]
264pub struct SearchResult {
265 pub id: VectorId,
266 pub score: f32,
267 #[serde(skip_serializing_if = "Option::is_none")]
268 pub metadata: Option<serde_json::Value>,
269 #[serde(skip_serializing_if = "Option::is_none")]
270 pub vector: Option<Vec<f32>>,
271}
272
273#[derive(Debug, Serialize, Deserialize)]
275pub struct QueryResponse {
276 pub results: Vec<SearchResult>,
277 #[serde(skip_serializing_if = "Option::is_none")]
279 pub next_cursor: Option<String>,
280 #[serde(skip_serializing_if = "Option::is_none")]
282 pub has_more: Option<bool>,
283 #[serde(default)]
285 pub search_time_ms: u64,
286}
287
288#[derive(Debug, Clone, Serialize, Deserialize)]
294pub struct PaginationCursor {
295 pub last_score: f32,
297 pub last_id: String,
299}
300
301impl PaginationCursor {
302 pub fn new(last_score: f32, last_id: String) -> Self {
304 Self {
305 last_score,
306 last_id,
307 }
308 }
309
310 pub fn encode(&self) -> String {
312 use base64::{engine::general_purpose::URL_SAFE_NO_PAD, Engine as _};
313 let json = serde_json::to_string(self).unwrap_or_default();
314 URL_SAFE_NO_PAD.encode(json.as_bytes())
315 }
316
317 pub fn decode(cursor: &str) -> Option<Self> {
319 use base64::{engine::general_purpose::URL_SAFE_NO_PAD, Engine as _};
320 let bytes = URL_SAFE_NO_PAD.decode(cursor).ok()?;
321 let json = String::from_utf8(bytes).ok()?;
322 serde_json::from_str(&json).ok()
323 }
324}
325
326#[derive(Debug, Deserialize)]
328pub struct DeleteRequest {
329 pub ids: Vec<VectorId>,
330}
331
332#[derive(Debug, Serialize)]
334pub struct DeleteResponse {
335 pub deleted_count: usize,
336}
337
338#[derive(Debug, Clone, Deserialize)]
344pub struct BatchQueryItem {
345 #[serde(default)]
347 pub id: Option<String>,
348 pub vector: Vec<f32>,
350 #[serde(default = "default_batch_top_k")]
352 pub top_k: u32,
353 #[serde(default)]
355 pub filter: Option<FilterExpression>,
356 #[serde(default)]
358 pub include_metadata: bool,
359 #[serde(default)]
361 pub consistency: ReadConsistency,
362 #[serde(default)]
364 pub staleness_config: Option<StalenessConfig>,
365}
366
367fn default_batch_top_k() -> u32 {
368 10
369}
370
371#[derive(Debug, Deserialize)]
373pub struct BatchQueryRequest {
374 pub queries: Vec<BatchQueryItem>,
376}
377
378#[derive(Debug, Serialize)]
380pub struct BatchQueryResult {
381 #[serde(skip_serializing_if = "Option::is_none")]
383 pub id: Option<String>,
384 pub results: Vec<SearchResult>,
386 pub latency_ms: f64,
388 #[serde(skip_serializing_if = "Option::is_none")]
390 pub error: Option<String>,
391}
392
393#[derive(Debug, Serialize)]
395pub struct BatchQueryResponse {
396 pub results: Vec<BatchQueryResult>,
398 pub total_latency_ms: f64,
400 pub query_count: usize,
402}
403
404#[derive(Debug, Deserialize)]
410pub struct MultiVectorSearchRequest {
411 pub positive_vectors: Vec<Vec<f32>>,
413 #[serde(default)]
415 pub positive_weights: Option<Vec<f32>>,
416 #[serde(default)]
418 pub negative_vectors: Option<Vec<Vec<f32>>>,
419 #[serde(default)]
421 pub negative_weights: Option<Vec<f32>>,
422 #[serde(default = "default_top_k")]
424 pub top_k: usize,
425 #[serde(default)]
427 pub distance_metric: DistanceMetric,
428 #[serde(default)]
430 pub score_threshold: Option<f32>,
431 #[serde(default)]
433 pub enable_mmr: bool,
434 #[serde(default = "default_mmr_lambda")]
436 pub mmr_lambda: f32,
437 #[serde(default = "default_true")]
439 pub include_metadata: bool,
440 #[serde(default)]
442 pub include_vectors: bool,
443 #[serde(default)]
445 pub filter: Option<FilterExpression>,
446 #[serde(default)]
448 pub consistency: ReadConsistency,
449 #[serde(default)]
451 pub staleness_config: Option<StalenessConfig>,
452}
453
454fn default_mmr_lambda() -> f32 {
455 0.5
456}
457
458#[derive(Debug, Serialize, Deserialize)]
460pub struct MultiVectorSearchResult {
461 pub id: VectorId,
462 pub score: f32,
464 #[serde(skip_serializing_if = "Option::is_none")]
466 pub mmr_score: Option<f32>,
467 #[serde(skip_serializing_if = "Option::is_none")]
469 pub original_rank: Option<usize>,
470 #[serde(skip_serializing_if = "Option::is_none")]
471 pub metadata: Option<serde_json::Value>,
472 #[serde(skip_serializing_if = "Option::is_none")]
473 pub vector: Option<Vec<f32>>,
474}
475
476#[derive(Debug, Serialize, Deserialize)]
478pub struct MultiVectorSearchResponse {
479 pub results: Vec<MultiVectorSearchResult>,
480 #[serde(skip_serializing_if = "Option::is_none")]
482 pub computed_query_vector: Option<Vec<f32>>,
483}
484
485#[derive(Debug, Serialize, Deserialize)]
491pub struct IndexDocumentRequest {
492 pub id: String,
493 pub text: String,
494 #[serde(skip_serializing_if = "Option::is_none")]
495 pub metadata: Option<serde_json::Value>,
496}
497
498#[derive(Debug, Deserialize)]
500pub struct IndexDocumentsRequest {
501 pub documents: Vec<IndexDocumentRequest>,
502}
503
504#[derive(Debug, Serialize, Deserialize)]
506pub struct IndexDocumentsResponse {
507 pub indexed_count: usize,
508}
509
510#[derive(Debug, Deserialize)]
512pub struct FullTextSearchRequest {
513 pub query: String,
514 #[serde(default = "default_top_k")]
515 pub top_k: usize,
516 #[serde(default)]
518 pub filter: Option<FilterExpression>,
519}
520
521#[derive(Debug, Serialize, Deserialize)]
523pub struct FullTextSearchResult {
524 pub id: String,
525 pub score: f32,
526 #[serde(skip_serializing_if = "Option::is_none")]
527 pub metadata: Option<serde_json::Value>,
528}
529
530#[derive(Debug, Serialize, Deserialize)]
532pub struct FullTextSearchResponse {
533 pub results: Vec<FullTextSearchResult>,
534 #[serde(default)]
536 pub search_time_ms: u64,
537}
538
539#[derive(Debug, Deserialize)]
541pub struct DeleteDocumentsRequest {
542 pub ids: Vec<String>,
543}
544
545#[derive(Debug, Serialize)]
547pub struct DeleteDocumentsResponse {
548 pub deleted_count: usize,
549}
550
551#[derive(Debug, Serialize)]
553pub struct FullTextIndexStats {
554 pub document_count: u32,
555 pub unique_terms: usize,
556 pub avg_doc_length: f32,
557}
558
559#[derive(Debug, Deserialize)]
565pub struct HybridSearchRequest {
566 #[serde(default)]
569 pub vector: Option<Vec<f32>>,
570 pub text: String,
572 #[serde(default = "default_top_k")]
574 pub top_k: usize,
575 #[serde(default = "default_vector_weight")]
578 pub vector_weight: f32,
579 #[serde(default)]
581 pub distance_metric: DistanceMetric,
582 #[serde(default = "default_true")]
584 pub include_metadata: bool,
585 #[serde(default)]
587 pub include_vectors: bool,
588 #[serde(default)]
590 pub filter: Option<FilterExpression>,
591}
592
593fn default_vector_weight() -> f32 {
594 0.5 }
596
597#[derive(Debug, Serialize, Deserialize)]
599pub struct HybridSearchResult {
600 pub id: String,
601 pub score: f32,
603 pub vector_score: f32,
605 pub text_score: f32,
607 #[serde(skip_serializing_if = "Option::is_none")]
608 pub metadata: Option<serde_json::Value>,
609 #[serde(skip_serializing_if = "Option::is_none")]
610 pub vector: Option<Vec<f32>>,
611}
612
613#[derive(Debug, Serialize, Deserialize)]
615pub struct HybridSearchResponse {
616 pub results: Vec<HybridSearchResult>,
617 #[serde(default)]
619 pub search_time_ms: u64,
620}
621
622#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
628#[serde(untagged)]
629pub enum FilterValue {
630 String(String),
631 Number(f64),
632 Integer(i64),
633 Boolean(bool),
634 StringArray(Vec<String>),
635 NumberArray(Vec<f64>),
636}
637
638impl FilterValue {
639 pub fn as_f64(&self) -> Option<f64> {
641 match self {
642 FilterValue::Number(n) => Some(*n),
643 FilterValue::Integer(i) => Some(*i as f64),
644 _ => None,
645 }
646 }
647
648 pub fn as_str(&self) -> Option<&str> {
650 match self {
651 FilterValue::String(s) => Some(s.as_str()),
652 _ => None,
653 }
654 }
655
656 pub fn as_bool(&self) -> Option<bool> {
658 match self {
659 FilterValue::Boolean(b) => Some(*b),
660 _ => None,
661 }
662 }
663}
664
665#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
667#[serde(rename_all = "snake_case")]
668pub enum FilterCondition {
669 #[serde(rename = "$eq")]
671 Eq(FilterValue),
672 #[serde(rename = "$ne")]
674 Ne(FilterValue),
675 #[serde(rename = "$gt")]
677 Gt(FilterValue),
678 #[serde(rename = "$gte")]
680 Gte(FilterValue),
681 #[serde(rename = "$lt")]
683 Lt(FilterValue),
684 #[serde(rename = "$lte")]
686 Lte(FilterValue),
687 #[serde(rename = "$in")]
689 In(Vec<FilterValue>),
690 #[serde(rename = "$nin")]
692 NotIn(Vec<FilterValue>),
693 #[serde(rename = "$exists")]
695 Exists(bool),
696 #[serde(rename = "$contains")]
701 Contains(String),
702 #[serde(rename = "$icontains")]
704 IContains(String),
705 #[serde(rename = "$startsWith")]
707 StartsWith(String),
708 #[serde(rename = "$endsWith")]
710 EndsWith(String),
711 #[serde(rename = "$glob")]
713 Glob(String),
714 #[serde(rename = "$regex")]
716 Regex(String),
717}
718
719#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
721#[serde(untagged)]
722pub enum FilterExpression {
723 And {
725 #[serde(rename = "$and")]
726 conditions: Vec<FilterExpression>,
727 },
728 Or {
730 #[serde(rename = "$or")]
731 conditions: Vec<FilterExpression>,
732 },
733 Field {
735 #[serde(flatten)]
736 field: std::collections::HashMap<String, FilterCondition>,
737 },
738}
739
740#[derive(Debug, Clone, Serialize, Deserialize, Default)]
746pub struct QuotaConfig {
747 #[serde(skip_serializing_if = "Option::is_none")]
749 pub max_vectors: Option<u64>,
750 #[serde(skip_serializing_if = "Option::is_none")]
752 pub max_storage_bytes: Option<u64>,
753 #[serde(skip_serializing_if = "Option::is_none")]
755 pub max_dimensions: Option<usize>,
756 #[serde(skip_serializing_if = "Option::is_none")]
758 pub max_metadata_bytes: Option<usize>,
759 #[serde(default)]
761 pub enforcement: QuotaEnforcement,
762}
763
764#[derive(Debug, Clone, Copy, Serialize, Deserialize, Default, PartialEq, Eq)]
766#[serde(rename_all = "snake_case")]
767pub enum QuotaEnforcement {
768 None,
770 Soft,
772 #[default]
774 Hard,
775}
776
777#[derive(Debug, Clone, Serialize, Deserialize, Default)]
779pub struct QuotaUsage {
780 pub vector_count: u64,
782 pub storage_bytes: u64,
784 pub avg_dimensions: Option<usize>,
786 pub avg_metadata_bytes: Option<usize>,
788 pub last_updated: u64,
790}
791
792impl QuotaUsage {
793 pub fn new(vector_count: u64, storage_bytes: u64) -> Self {
795 let now = std::time::SystemTime::now()
796 .duration_since(std::time::UNIX_EPOCH)
797 .unwrap_or_default()
798 .as_secs();
799 Self {
800 vector_count,
801 storage_bytes,
802 avg_dimensions: None,
803 avg_metadata_bytes: None,
804 last_updated: now,
805 }
806 }
807
808 pub fn touch(&mut self) {
810 self.last_updated = std::time::SystemTime::now()
811 .duration_since(std::time::UNIX_EPOCH)
812 .unwrap_or_default()
813 .as_secs();
814 }
815}
816
817#[derive(Debug, Clone, Serialize, Deserialize)]
819pub struct QuotaStatus {
820 pub namespace: String,
822 pub config: QuotaConfig,
824 pub usage: QuotaUsage,
826 #[serde(skip_serializing_if = "Option::is_none")]
828 pub vector_usage_percent: Option<f32>,
829 #[serde(skip_serializing_if = "Option::is_none")]
831 pub storage_usage_percent: Option<f32>,
832 pub is_exceeded: bool,
834 #[serde(skip_serializing_if = "Vec::is_empty")]
836 pub exceeded_quotas: Vec<String>,
837}
838
839impl QuotaStatus {
840 pub fn new(namespace: String, config: QuotaConfig, usage: QuotaUsage) -> Self {
842 let vector_usage_percent = config
843 .max_vectors
844 .map(|max| (usage.vector_count as f32 / max as f32) * 100.0);
845
846 let storage_usage_percent = config
847 .max_storage_bytes
848 .map(|max| (usage.storage_bytes as f32 / max as f32) * 100.0);
849
850 let mut exceeded_quotas = Vec::new();
851
852 if let Some(max) = config.max_vectors {
853 if usage.vector_count > max {
854 exceeded_quotas.push("max_vectors".to_string());
855 }
856 }
857
858 if let Some(max) = config.max_storage_bytes {
859 if usage.storage_bytes > max {
860 exceeded_quotas.push("max_storage_bytes".to_string());
861 }
862 }
863
864 let is_exceeded = !exceeded_quotas.is_empty();
865
866 Self {
867 namespace,
868 config,
869 usage,
870 vector_usage_percent,
871 storage_usage_percent,
872 is_exceeded,
873 exceeded_quotas,
874 }
875 }
876}
877
878#[derive(Debug, Deserialize)]
880pub struct SetQuotaRequest {
881 pub config: QuotaConfig,
883}
884
885#[derive(Debug, Serialize)]
887pub struct SetQuotaResponse {
888 pub success: bool,
890 pub namespace: String,
892 pub config: QuotaConfig,
894 pub message: String,
896}
897
898#[derive(Debug, Clone, Serialize)]
900pub struct QuotaCheckResult {
901 pub allowed: bool,
903 #[serde(skip_serializing_if = "Option::is_none")]
905 pub reason: Option<String>,
906 pub usage: QuotaUsage,
908 #[serde(skip_serializing_if = "Option::is_none")]
910 pub exceeded_quota: Option<String>,
911}
912
913#[derive(Debug, Serialize)]
915pub struct QuotaListResponse {
916 pub quotas: Vec<QuotaStatus>,
918 pub total: u64,
920 #[serde(skip_serializing_if = "Option::is_none")]
922 pub default_config: Option<QuotaConfig>,
923}
924
925#[derive(Debug, Serialize)]
927pub struct DefaultQuotaResponse {
928 pub config: Option<QuotaConfig>,
930}
931
932#[derive(Debug, Deserialize)]
934pub struct SetDefaultQuotaRequest {
935 pub config: Option<QuotaConfig>,
937}
938
939#[derive(Debug, Deserialize)]
941pub struct QuotaCheckRequest {
942 pub vector_ids: Vec<String>,
944 #[serde(default)]
946 pub dimensions: Option<usize>,
947 #[serde(default)]
949 pub metadata_bytes: Option<usize>,
950}
951
952#[derive(Debug, Deserialize)]
958pub struct ExportRequest {
959 #[serde(default = "default_export_top_k")]
961 pub top_k: usize,
962 #[serde(skip_serializing_if = "Option::is_none")]
964 pub cursor: Option<String>,
965 #[serde(default = "default_true")]
967 pub include_vectors: bool,
968 #[serde(default = "default_true")]
970 pub include_metadata: bool,
971}
972
973fn default_export_top_k() -> usize {
974 1000
975}
976
977impl Default for ExportRequest {
978 fn default() -> Self {
979 Self {
980 top_k: 1000,
981 cursor: None,
982 include_vectors: true,
983 include_metadata: true,
984 }
985 }
986}
987
988#[derive(Debug, Clone, Serialize, Deserialize)]
990pub struct ExportedVector {
991 pub id: String,
993 #[serde(skip_serializing_if = "Option::is_none")]
995 pub values: Option<Vec<f32>>,
996 #[serde(skip_serializing_if = "Option::is_none")]
998 pub metadata: Option<serde_json::Value>,
999 #[serde(skip_serializing_if = "Option::is_none")]
1001 pub ttl_seconds: Option<u64>,
1002}
1003
1004impl From<&Vector> for ExportedVector {
1005 fn from(v: &Vector) -> Self {
1006 Self {
1007 id: v.id.clone(),
1008 values: Some(v.values.clone()),
1009 metadata: v.metadata.clone(),
1010 ttl_seconds: v.ttl_seconds,
1011 }
1012 }
1013}
1014
1015#[derive(Debug, Serialize)]
1017pub struct ExportResponse {
1018 pub vectors: Vec<ExportedVector>,
1020 #[serde(skip_serializing_if = "Option::is_none")]
1022 pub next_cursor: Option<String>,
1023 pub total_count: usize,
1025 pub returned_count: usize,
1027}
1028
1029#[derive(Debug, Clone, Serialize, Deserialize)]
1036#[serde(untagged)]
1037pub enum RankBy {
1038 VectorSearch {
1041 field: String,
1042 method: VectorSearchMethod,
1043 query_vector: Vec<f32>,
1044 },
1045 FullTextSearch {
1047 field: String,
1048 method: String, query: String,
1050 },
1051 AttributeOrder {
1053 field: String,
1054 direction: SortDirection,
1055 },
1056 Sum(Vec<RankBy>),
1058 Max(Vec<RankBy>),
1060 Product { weight: f32, ranking: Box<RankBy> },
1062}
1063
1064#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq, Default)]
1066pub enum VectorSearchMethod {
1067 #[default]
1069 ANN,
1070 #[serde(rename = "kNN")]
1072 KNN,
1073}
1074
1075#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
1077#[serde(rename_all = "lowercase")]
1078#[derive(Default)]
1079pub enum SortDirection {
1080 Asc,
1081 #[default]
1082 Desc,
1083}
1084
1085#[derive(Debug, Deserialize)]
1087pub struct UnifiedQueryRequest {
1088 pub rank_by: RankByInput,
1090 #[serde(default = "default_top_k")]
1092 pub top_k: usize,
1093 #[serde(default)]
1095 pub filter: Option<FilterExpression>,
1096 #[serde(default = "default_true")]
1098 pub include_metadata: bool,
1099 #[serde(default)]
1101 pub include_vectors: bool,
1102 #[serde(default)]
1104 pub distance_metric: DistanceMetric,
1105}
1106
1107#[derive(Debug, Clone, Serialize, Deserialize)]
1115#[serde(from = "serde_json::Value")]
1116pub struct RankByInput(pub RankBy);
1117
1118impl From<serde_json::Value> for RankByInput {
1119 fn from(value: serde_json::Value) -> Self {
1120 RankByInput(parse_rank_by(&value).unwrap_or_else(|| {
1121 RankBy::AttributeOrder {
1123 field: "id".to_string(),
1124 direction: SortDirection::Asc,
1125 }
1126 }))
1127 }
1128}
1129
1130fn parse_rank_by(value: &serde_json::Value) -> Option<RankBy> {
1132 let arr = value.as_array()?;
1133 if arr.is_empty() {
1134 return None;
1135 }
1136
1137 let first = arr.first()?.as_str()?;
1138
1139 match first {
1140 "Sum" => {
1142 let rankings = arr.get(1)?.as_array()?;
1143 let parsed: Option<Vec<RankBy>> = rankings.iter().map(parse_rank_by).collect();
1144 Some(RankBy::Sum(parsed?))
1145 }
1146 "Max" => {
1147 let rankings = arr.get(1)?.as_array()?;
1148 let parsed: Option<Vec<RankBy>> = rankings.iter().map(parse_rank_by).collect();
1149 Some(RankBy::Max(parsed?))
1150 }
1151 "Product" => {
1152 let weight = arr.get(1)?.as_f64()? as f32;
1153 let ranking = parse_rank_by(arr.get(2)?)?;
1154 Some(RankBy::Product {
1155 weight,
1156 ranking: Box::new(ranking),
1157 })
1158 }
1159 "ANN" => {
1161 let query_vector = parse_vector_array(arr.get(1)?)?;
1162 Some(RankBy::VectorSearch {
1163 field: "vector".to_string(),
1164 method: VectorSearchMethod::ANN,
1165 query_vector,
1166 })
1167 }
1168 "kNN" => {
1169 let query_vector = parse_vector_array(arr.get(1)?)?;
1170 Some(RankBy::VectorSearch {
1171 field: "vector".to_string(),
1172 method: VectorSearchMethod::KNN,
1173 query_vector,
1174 })
1175 }
1176 field => {
1178 let second = arr.get(1)?;
1179
1180 if let Some(method_str) = second.as_str() {
1182 match method_str {
1183 "ANN" => {
1184 let query_vector = parse_vector_array(arr.get(2)?)?;
1185 Some(RankBy::VectorSearch {
1186 field: field.to_string(),
1187 method: VectorSearchMethod::ANN,
1188 query_vector,
1189 })
1190 }
1191 "kNN" => {
1192 let query_vector = parse_vector_array(arr.get(2)?)?;
1193 Some(RankBy::VectorSearch {
1194 field: field.to_string(),
1195 method: VectorSearchMethod::KNN,
1196 query_vector,
1197 })
1198 }
1199 "BM25" => {
1200 let query = arr.get(2)?.as_str()?;
1201 Some(RankBy::FullTextSearch {
1202 field: field.to_string(),
1203 method: "BM25".to_string(),
1204 query: query.to_string(),
1205 })
1206 }
1207 "asc" => Some(RankBy::AttributeOrder {
1208 field: field.to_string(),
1209 direction: SortDirection::Asc,
1210 }),
1211 "desc" => Some(RankBy::AttributeOrder {
1212 field: field.to_string(),
1213 direction: SortDirection::Desc,
1214 }),
1215 _ => None,
1216 }
1217 } else {
1218 None
1219 }
1220 }
1221 }
1222}
1223
1224fn parse_vector_array(value: &serde_json::Value) -> Option<Vec<f32>> {
1226 let arr = value.as_array()?;
1227 arr.iter().map(|v| v.as_f64().map(|n| n as f32)).collect()
1228}
1229
1230#[derive(Debug, Serialize, Deserialize)]
1232pub struct UnifiedQueryResponse {
1233 pub results: Vec<UnifiedSearchResult>,
1235 #[serde(skip_serializing_if = "Option::is_none")]
1237 pub next_cursor: Option<String>,
1238}
1239
1240#[derive(Debug, Serialize, Deserialize)]
1242pub struct UnifiedSearchResult {
1243 pub id: String,
1245 #[serde(rename = "$dist", skip_serializing_if = "Option::is_none")]
1248 pub dist: Option<f32>,
1249 #[serde(skip_serializing_if = "Option::is_none")]
1251 pub metadata: Option<serde_json::Value>,
1252 #[serde(skip_serializing_if = "Option::is_none")]
1254 pub vector: Option<Vec<f32>>,
1255}
1256
1257#[derive(Debug, Clone, Serialize, Deserialize)]
1263pub enum AggregateFunction {
1264 Count,
1266 Sum { field: String },
1268 Avg { field: String },
1270 Min { field: String },
1272 Max { field: String },
1274}
1275
1276#[derive(Debug, Clone, Serialize, Deserialize)]
1278#[serde(from = "serde_json::Value")]
1279pub struct AggregateFunctionInput(pub AggregateFunction);
1280
1281impl From<serde_json::Value> for AggregateFunctionInput {
1282 fn from(value: serde_json::Value) -> Self {
1283 parse_aggregate_function(&value)
1284 .map(AggregateFunctionInput)
1285 .unwrap_or_else(|| {
1286 AggregateFunctionInput(AggregateFunction::Count)
1288 })
1289 }
1290}
1291
1292fn parse_aggregate_function(value: &serde_json::Value) -> Option<AggregateFunction> {
1294 let arr = value.as_array()?;
1295 if arr.is_empty() {
1296 return None;
1297 }
1298
1299 let func_name = arr.first()?.as_str()?;
1300
1301 match func_name {
1302 "Count" => Some(AggregateFunction::Count),
1303 "Sum" => {
1304 let field = arr.get(1)?.as_str()?;
1305 Some(AggregateFunction::Sum {
1306 field: field.to_string(),
1307 })
1308 }
1309 "Avg" => {
1310 let field = arr.get(1)?.as_str()?;
1311 Some(AggregateFunction::Avg {
1312 field: field.to_string(),
1313 })
1314 }
1315 "Min" => {
1316 let field = arr.get(1)?.as_str()?;
1317 Some(AggregateFunction::Min {
1318 field: field.to_string(),
1319 })
1320 }
1321 "Max" => {
1322 let field = arr.get(1)?.as_str()?;
1323 Some(AggregateFunction::Max {
1324 field: field.to_string(),
1325 })
1326 }
1327 _ => None,
1328 }
1329}
1330
1331#[derive(Debug, Deserialize)]
1333pub struct AggregationRequest {
1334 pub aggregate_by: std::collections::HashMap<String, AggregateFunctionInput>,
1337 #[serde(default)]
1340 pub group_by: Vec<String>,
1341 #[serde(default)]
1343 pub filter: Option<FilterExpression>,
1344 #[serde(default = "default_agg_limit")]
1346 pub limit: usize,
1347}
1348
1349fn default_agg_limit() -> usize {
1350 100
1351}
1352
1353#[derive(Debug, Serialize, Deserialize)]
1355pub struct AggregationResponse {
1356 #[serde(skip_serializing_if = "Option::is_none")]
1358 pub aggregations: Option<std::collections::HashMap<String, serde_json::Value>>,
1359 #[serde(skip_serializing_if = "Option::is_none")]
1361 pub aggregation_groups: Option<Vec<AggregationGroup>>,
1362}
1363
1364#[derive(Debug, Serialize, Deserialize)]
1366pub struct AggregationGroup {
1367 #[serde(flatten)]
1369 pub group_key: std::collections::HashMap<String, serde_json::Value>,
1370 #[serde(flatten)]
1372 pub aggregations: std::collections::HashMap<String, serde_json::Value>,
1373}
1374
1375#[derive(Debug, Clone, Serialize, Deserialize)]
1381pub struct TextDocument {
1382 pub id: VectorId,
1384 pub text: String,
1386 #[serde(skip_serializing_if = "Option::is_none")]
1388 pub metadata: Option<serde_json::Value>,
1389 #[serde(skip_serializing_if = "Option::is_none")]
1391 pub ttl_seconds: Option<u64>,
1392}
1393
1394#[derive(Debug, Deserialize)]
1396pub struct TextUpsertRequest {
1397 pub documents: Vec<TextDocument>,
1399 #[serde(default)]
1401 pub model: Option<EmbeddingModelType>,
1402}
1403
1404#[derive(Debug, Serialize, Deserialize)]
1406pub struct TextUpsertResponse {
1407 pub upserted_count: usize,
1409 pub tokens_processed: usize,
1411 pub model: EmbeddingModelType,
1413 pub embedding_time_ms: u64,
1415}
1416
1417#[derive(Debug, Deserialize)]
1419pub struct TextQueryRequest {
1420 pub text: String,
1422 #[serde(default = "default_top_k")]
1424 pub top_k: usize,
1425 #[serde(default)]
1427 pub filter: Option<FilterExpression>,
1428 #[serde(default)]
1430 pub include_vectors: bool,
1431 #[serde(default = "default_true")]
1433 pub include_text: bool,
1434 #[serde(default)]
1436 pub model: Option<EmbeddingModelType>,
1437}
1438
1439#[derive(Debug, Serialize, Deserialize)]
1441pub struct TextQueryResponse {
1442 pub results: Vec<TextSearchResult>,
1444 pub model: EmbeddingModelType,
1446 pub embedding_time_ms: u64,
1448 pub search_time_ms: u64,
1450}
1451
1452#[derive(Debug, Serialize, Deserialize)]
1454pub struct TextSearchResult {
1455 pub id: VectorId,
1457 pub score: f32,
1459 #[serde(skip_serializing_if = "Option::is_none")]
1461 pub text: Option<String>,
1462 #[serde(skip_serializing_if = "Option::is_none")]
1464 pub metadata: Option<serde_json::Value>,
1465 #[serde(skip_serializing_if = "Option::is_none")]
1467 pub vector: Option<Vec<f32>>,
1468}
1469
1470#[derive(Debug, Deserialize)]
1472pub struct BatchTextQueryRequest {
1473 pub queries: Vec<String>,
1475 #[serde(default = "default_top_k")]
1477 pub top_k: usize,
1478 #[serde(default)]
1480 pub filter: Option<FilterExpression>,
1481 #[serde(default)]
1483 pub include_vectors: bool,
1484 #[serde(default)]
1486 pub model: Option<EmbeddingModelType>,
1487}
1488
1489#[derive(Debug, Serialize, Deserialize)]
1491pub struct BatchTextQueryResponse {
1492 pub results: Vec<Vec<TextSearchResult>>,
1494 pub model: EmbeddingModelType,
1496 pub embedding_time_ms: u64,
1498 pub search_time_ms: u64,
1500}
1501
1502#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Default)]
1510pub enum EmbeddingModelType {
1511 #[default]
1513 #[serde(rename = "minilm")]
1514 MiniLM,
1515 #[serde(rename = "bge-small")]
1517 BgeSmall,
1518 #[serde(rename = "e5-small")]
1520 E5Small,
1521}
1522
1523impl EmbeddingModelType {
1524 pub fn dimension(&self) -> usize {
1526 match self {
1527 EmbeddingModelType::MiniLM => 384,
1528 EmbeddingModelType::BgeSmall => 384,
1529 EmbeddingModelType::E5Small => 384,
1530 }
1531 }
1532}
1533
1534impl std::fmt::Display for EmbeddingModelType {
1535 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1536 match self {
1537 EmbeddingModelType::MiniLM => write!(f, "minilm"),
1538 EmbeddingModelType::BgeSmall => write!(f, "bge-small"),
1539 EmbeddingModelType::E5Small => write!(f, "e5-small"),
1540 }
1541 }
1542}
1543
1544#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
1550#[serde(rename_all = "snake_case")]
1551#[derive(Default)]
1552pub enum MemoryType {
1553 #[default]
1555 Episodic,
1556 Semantic,
1558 Procedural,
1560 Working,
1562}
1563
1564impl std::fmt::Display for MemoryType {
1565 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1566 match self {
1567 MemoryType::Episodic => write!(f, "episodic"),
1568 MemoryType::Semantic => write!(f, "semantic"),
1569 MemoryType::Procedural => write!(f, "procedural"),
1570 MemoryType::Working => write!(f, "working"),
1571 }
1572 }
1573}
1574
1575#[derive(Debug, Clone, Serialize, Deserialize)]
1577pub struct Memory {
1578 pub id: String,
1579 #[serde(default)]
1580 pub memory_type: MemoryType,
1581 pub content: String,
1582 pub agent_id: String,
1583 #[serde(skip_serializing_if = "Option::is_none")]
1584 pub session_id: Option<String>,
1585 #[serde(default = "default_importance")]
1586 pub importance: f32,
1587 #[serde(default)]
1588 pub tags: Vec<String>,
1589 #[serde(skip_serializing_if = "Option::is_none")]
1590 pub metadata: Option<serde_json::Value>,
1591 pub created_at: u64,
1592 pub last_accessed_at: u64,
1593 #[serde(default)]
1594 pub access_count: u32,
1595 #[serde(skip_serializing_if = "Option::is_none")]
1596 pub ttl_seconds: Option<u64>,
1597 #[serde(skip_serializing_if = "Option::is_none")]
1598 pub expires_at: Option<u64>,
1599}
1600
1601fn default_importance() -> f32 {
1602 0.5
1603}
1604
1605impl Memory {
1606 pub fn new(id: String, content: String, agent_id: String, memory_type: MemoryType) -> Self {
1608 let now = std::time::SystemTime::now()
1609 .duration_since(std::time::UNIX_EPOCH)
1610 .unwrap_or_default()
1611 .as_secs();
1612 Self {
1613 id,
1614 memory_type,
1615 content,
1616 agent_id,
1617 session_id: None,
1618 importance: 0.5,
1619 tags: Vec::new(),
1620 metadata: None,
1621 created_at: now,
1622 last_accessed_at: now,
1623 access_count: 0,
1624 ttl_seconds: None,
1625 expires_at: None,
1626 }
1627 }
1628
1629 pub fn is_expired(&self) -> bool {
1631 if let Some(expires_at) = self.expires_at {
1632 let now = std::time::SystemTime::now()
1633 .duration_since(std::time::UNIX_EPOCH)
1634 .unwrap_or_default()
1635 .as_secs();
1636 now >= expires_at
1637 } else {
1638 false
1639 }
1640 }
1641
1642 pub fn to_vector_metadata(&self) -> serde_json::Value {
1644 let mut meta = serde_json::Map::new();
1645 meta.insert("_dakera_type".to_string(), serde_json::json!("memory"));
1646 meta.insert(
1647 "memory_type".to_string(),
1648 serde_json::json!(self.memory_type),
1649 );
1650 meta.insert("content".to_string(), serde_json::json!(self.content));
1651 meta.insert("agent_id".to_string(), serde_json::json!(self.agent_id));
1652 if let Some(ref sid) = self.session_id {
1653 meta.insert("session_id".to_string(), serde_json::json!(sid));
1654 }
1655 meta.insert("importance".to_string(), serde_json::json!(self.importance));
1656 meta.insert("tags".to_string(), serde_json::json!(self.tags));
1657 meta.insert("created_at".to_string(), serde_json::json!(self.created_at));
1658 meta.insert(
1659 "last_accessed_at".to_string(),
1660 serde_json::json!(self.last_accessed_at),
1661 );
1662 meta.insert(
1663 "access_count".to_string(),
1664 serde_json::json!(self.access_count),
1665 );
1666 if let Some(ref ttl) = self.ttl_seconds {
1667 meta.insert("ttl_seconds".to_string(), serde_json::json!(ttl));
1668 }
1669 if let Some(ref expires) = self.expires_at {
1670 meta.insert("expires_at".to_string(), serde_json::json!(expires));
1671 }
1672 if let Some(ref user_meta) = self.metadata {
1673 meta.insert("user_metadata".to_string(), user_meta.clone());
1674 }
1675 serde_json::Value::Object(meta)
1676 }
1677
1678 pub fn to_vector(&self, embedding: Vec<f32>) -> Vector {
1680 let mut v = Vector {
1681 id: self.id.clone(),
1682 values: embedding,
1683 metadata: Some(self.to_vector_metadata()),
1684 ttl_seconds: self.ttl_seconds,
1685 expires_at: self.expires_at,
1686 };
1687 v.apply_ttl();
1688 v
1689 }
1690
1691 pub fn from_vector(vector: &Vector) -> Option<Self> {
1693 let meta = vector.metadata.as_ref()?.as_object()?;
1694 let entry_type = meta.get("_dakera_type")?.as_str()?;
1695 if entry_type != "memory" {
1696 return None;
1697 }
1698
1699 Some(Memory {
1700 id: vector.id.clone(),
1701 memory_type: serde_json::from_value(meta.get("memory_type")?.clone())
1702 .unwrap_or_default(),
1703 content: meta.get("content")?.as_str()?.to_string(),
1704 agent_id: meta.get("agent_id")?.as_str()?.to_string(),
1705 session_id: meta
1706 .get("session_id")
1707 .and_then(|v| v.as_str())
1708 .map(String::from),
1709 importance: meta
1710 .get("importance")
1711 .and_then(|v| v.as_f64())
1712 .unwrap_or(0.5) as f32,
1713 tags: meta
1714 .get("tags")
1715 .and_then(|v| serde_json::from_value(v.clone()).ok())
1716 .unwrap_or_default(),
1717 metadata: meta.get("user_metadata").cloned(),
1718 created_at: meta.get("created_at").and_then(|v| v.as_u64()).unwrap_or(0),
1719 last_accessed_at: meta
1720 .get("last_accessed_at")
1721 .and_then(|v| v.as_u64())
1722 .unwrap_or(0),
1723 access_count: meta
1724 .get("access_count")
1725 .and_then(|v| v.as_u64())
1726 .unwrap_or(0) as u32,
1727 ttl_seconds: vector.ttl_seconds,
1728 expires_at: vector.expires_at,
1729 })
1730 }
1731}
1732
1733#[derive(Debug, Clone, Serialize, Deserialize)]
1735pub struct Session {
1736 pub id: String,
1737 pub agent_id: String,
1738 pub started_at: u64,
1739 #[serde(skip_serializing_if = "Option::is_none")]
1740 pub ended_at: Option<u64>,
1741 #[serde(skip_serializing_if = "Option::is_none")]
1742 pub summary: Option<String>,
1743 #[serde(skip_serializing_if = "Option::is_none")]
1744 pub metadata: Option<serde_json::Value>,
1745 #[serde(default)]
1747 pub memory_count: usize,
1748}
1749
1750impl Session {
1751 pub fn new(id: String, agent_id: String) -> Self {
1752 let now = std::time::SystemTime::now()
1753 .duration_since(std::time::UNIX_EPOCH)
1754 .unwrap_or_default()
1755 .as_secs();
1756 Self {
1757 id,
1758 agent_id,
1759 started_at: now,
1760 ended_at: None,
1761 summary: None,
1762 metadata: None,
1763 memory_count: 0,
1764 }
1765 }
1766
1767 pub fn to_vector_metadata(&self) -> serde_json::Value {
1769 let mut meta = serde_json::Map::new();
1770 meta.insert("_dakera_type".to_string(), serde_json::json!("session"));
1771 meta.insert("agent_id".to_string(), serde_json::json!(self.agent_id));
1772 meta.insert("started_at".to_string(), serde_json::json!(self.started_at));
1773 if let Some(ref ended) = self.ended_at {
1774 meta.insert("ended_at".to_string(), serde_json::json!(ended));
1775 }
1776 if let Some(ref summary) = self.summary {
1777 meta.insert("summary".to_string(), serde_json::json!(summary));
1778 }
1779 if let Some(ref user_meta) = self.metadata {
1780 meta.insert("user_metadata".to_string(), user_meta.clone());
1781 }
1782 meta.insert(
1783 "memory_count".to_string(),
1784 serde_json::json!(self.memory_count),
1785 );
1786 serde_json::Value::Object(meta)
1787 }
1788
1789 pub fn to_vector(&self, embedding: Vec<f32>) -> Vector {
1791 Vector {
1792 id: self.id.clone(),
1793 values: embedding,
1794 metadata: Some(self.to_vector_metadata()),
1795 ttl_seconds: None,
1796 expires_at: None,
1797 }
1798 }
1799
1800 pub fn from_vector(vector: &Vector) -> Option<Self> {
1802 let meta = vector.metadata.as_ref()?.as_object()?;
1803 let entry_type = meta.get("_dakera_type")?.as_str()?;
1804 if entry_type != "session" {
1805 return None;
1806 }
1807
1808 Some(Session {
1809 id: vector.id.clone(),
1810 agent_id: meta.get("agent_id")?.as_str()?.to_string(),
1811 started_at: meta.get("started_at").and_then(|v| v.as_u64()).unwrap_or(0),
1812 ended_at: meta.get("ended_at").and_then(|v| v.as_u64()),
1813 summary: meta
1814 .get("summary")
1815 .and_then(|v| v.as_str())
1816 .map(String::from),
1817 metadata: meta.get("user_metadata").cloned(),
1818 memory_count: meta
1819 .get("memory_count")
1820 .and_then(|v| v.as_u64())
1821 .unwrap_or(0) as usize,
1822 })
1823 }
1824}
1825
1826#[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize)]
1828#[serde(rename_all = "snake_case")]
1829#[derive(Default)]
1830pub enum DecayStrategy {
1831 #[default]
1832 Exponential,
1833 Linear,
1834 StepFunction,
1835 PowerLaw,
1837 Logarithmic,
1839 Flat,
1841}
1842
1843#[derive(Debug, Clone, Serialize, Deserialize)]
1845pub struct DecayConfig {
1846 #[serde(default)]
1847 pub strategy: DecayStrategy,
1848 #[serde(default = "default_half_life_hours")]
1849 pub half_life_hours: f64,
1850 #[serde(default = "default_min_importance")]
1851 pub min_importance: f32,
1852}
1853
1854fn default_half_life_hours() -> f64 {
1855 168.0 }
1857
1858fn default_min_importance() -> f32 {
1859 0.01
1860}
1861
1862impl Default for DecayConfig {
1863 fn default() -> Self {
1864 Self {
1865 strategy: DecayStrategy::default(),
1866 half_life_hours: default_half_life_hours(),
1867 min_importance: default_min_importance(),
1868 }
1869 }
1870}
1871
1872#[derive(Debug, Deserialize)]
1878pub struct StoreMemoryRequest {
1879 pub content: String,
1880 pub agent_id: String,
1881 #[serde(default)]
1882 pub memory_type: MemoryType,
1883 #[serde(skip_serializing_if = "Option::is_none")]
1884 pub session_id: Option<String>,
1885 #[serde(default = "default_importance")]
1886 pub importance: f32,
1887 #[serde(default)]
1888 pub tags: Vec<String>,
1889 #[serde(skip_serializing_if = "Option::is_none")]
1890 pub metadata: Option<serde_json::Value>,
1891 #[serde(skip_serializing_if = "Option::is_none")]
1892 pub ttl_seconds: Option<u64>,
1893 #[serde(skip_serializing_if = "Option::is_none")]
1898 pub expires_at: Option<u64>,
1899 #[serde(skip_serializing_if = "Option::is_none")]
1901 pub id: Option<String>,
1902}
1903
1904#[derive(Debug, Serialize)]
1906pub struct StoreMemoryResponse {
1907 pub memory: Memory,
1908 pub embedding_time_ms: u64,
1909}
1910
1911#[derive(Debug, Deserialize)]
1913pub struct RecallRequest {
1914 pub query: String,
1915 pub agent_id: String,
1916 #[serde(default = "default_top_k")]
1917 pub top_k: usize,
1918 #[serde(default)]
1919 pub memory_type: Option<MemoryType>,
1920 #[serde(default)]
1921 pub session_id: Option<String>,
1922 #[serde(default)]
1923 pub tags: Option<Vec<String>>,
1924 #[serde(default)]
1925 pub min_importance: Option<f32>,
1926 #[serde(default = "default_true")]
1928 pub importance_weighted: bool,
1929 #[serde(default)]
1931 pub include_associated: bool,
1932 #[serde(default)]
1934 pub associated_memories_cap: Option<usize>,
1935 #[serde(default)]
1937 pub since: Option<String>,
1938 #[serde(default)]
1940 pub until: Option<String>,
1941}
1942
1943#[derive(Debug, Serialize, Deserialize)]
1945pub struct RecallResult {
1946 pub memory: Memory,
1947 pub score: f32,
1948 #[serde(skip_serializing_if = "Option::is_none")]
1950 pub weighted_score: Option<f32>,
1951 #[serde(skip_serializing_if = "Option::is_none")]
1953 pub smart_score: Option<f32>,
1954}
1955
1956#[derive(Debug, Serialize)]
1958pub struct RecallResponse {
1959 pub memories: Vec<RecallResult>,
1960 pub query_embedding_time_ms: u64,
1961 pub search_time_ms: u64,
1962 #[serde(skip_serializing_if = "Option::is_none")]
1965 pub associated_memories: Option<Vec<RecallResult>>,
1966}
1967
1968#[derive(Debug, Deserialize)]
1970pub struct ForgetRequest {
1971 pub agent_id: String,
1972 #[serde(default)]
1973 pub memory_ids: Option<Vec<String>>,
1974 #[serde(default)]
1975 pub memory_type: Option<MemoryType>,
1976 #[serde(default)]
1977 pub session_id: Option<String>,
1978 #[serde(default)]
1979 pub tags: Option<Vec<String>>,
1980 #[serde(default)]
1982 pub below_importance: Option<f32>,
1983}
1984
1985#[derive(Debug, Serialize)]
1987pub struct ForgetResponse {
1988 pub deleted_count: usize,
1989}
1990
1991#[derive(Debug, Deserialize)]
1993pub struct UpdateMemoryRequest {
1994 #[serde(default)]
1995 pub content: Option<String>,
1996 #[serde(default)]
1997 pub importance: Option<f32>,
1998 #[serde(default)]
1999 pub tags: Option<Vec<String>>,
2000 #[serde(default)]
2001 pub metadata: Option<serde_json::Value>,
2002 #[serde(default)]
2003 pub memory_type: Option<MemoryType>,
2004}
2005
2006#[derive(Debug, Deserialize)]
2008pub struct UpdateImportanceRequest {
2009 pub memory_id: String,
2010 pub importance: f32,
2011 pub agent_id: String,
2012}
2013
2014#[derive(Debug, Deserialize)]
2016pub struct ConsolidateRequest {
2017 pub agent_id: String,
2018 #[serde(default)]
2020 pub memory_ids: Option<Vec<String>>,
2021 #[serde(default = "default_consolidation_threshold")]
2023 pub threshold: f32,
2024 #[serde(default)]
2026 pub target_type: Option<MemoryType>,
2027}
2028
2029fn default_consolidation_threshold() -> f32 {
2030 0.85
2031}
2032
2033#[derive(Debug, Serialize)]
2035pub struct ConsolidateResponse {
2036 pub consolidated_memory: Memory,
2037 pub source_memory_ids: Vec<String>,
2038 pub memories_removed: usize,
2039}
2040
2041#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
2043#[serde(rename_all = "lowercase")]
2044pub enum FeedbackSignal {
2045 Upvote,
2047 Downvote,
2049 Flag,
2051 Positive,
2053 Negative,
2055}
2056
2057#[derive(Debug, Clone, Serialize, Deserialize)]
2059pub struct FeedbackHistoryEntry {
2060 pub signal: FeedbackSignal,
2061 pub timestamp: u64,
2062 pub old_importance: f32,
2063 pub new_importance: f32,
2064}
2065
2066#[derive(Debug, Deserialize)]
2068pub struct FeedbackRequest {
2069 pub agent_id: String,
2070 pub memory_id: String,
2071 pub signal: FeedbackSignal,
2072}
2073
2074#[derive(Debug, Deserialize)]
2076pub struct MemoryFeedbackRequest {
2077 pub agent_id: String,
2078 pub signal: FeedbackSignal,
2079}
2080
2081#[derive(Debug, Serialize)]
2083pub struct FeedbackResponse {
2084 pub memory_id: String,
2085 pub new_importance: f32,
2086 pub signal: FeedbackSignal,
2087}
2088
2089#[derive(Debug, Serialize)]
2091pub struct FeedbackHistoryResponse {
2092 pub memory_id: String,
2093 pub entries: Vec<FeedbackHistoryEntry>,
2094}
2095
2096#[derive(Debug, Serialize)]
2098pub struct AgentFeedbackSummary {
2099 pub agent_id: String,
2100 pub upvotes: u64,
2101 pub downvotes: u64,
2102 pub flags: u64,
2103 pub total_feedback: u64,
2104 pub health_score: f32,
2106}
2107
2108#[derive(Debug, Deserialize)]
2110pub struct MemoryImportancePatchRequest {
2111 pub agent_id: String,
2112 pub importance: f32,
2113}
2114
2115#[derive(Debug, Deserialize)]
2117pub struct FeedbackHealthQuery {
2118 pub agent_id: String,
2119}
2120
2121#[derive(Debug, Serialize)]
2123pub struct FeedbackHealthResponse {
2124 pub agent_id: String,
2125 pub health_score: f32,
2127 pub memory_count: usize,
2128 pub avg_importance: f32,
2129}
2130
2131#[derive(Debug, Deserialize)]
2133pub struct SearchMemoriesRequest {
2134 pub agent_id: String,
2135 #[serde(default)]
2136 pub query: Option<String>,
2137 #[serde(default)]
2138 pub memory_type: Option<MemoryType>,
2139 #[serde(default)]
2140 pub session_id: Option<String>,
2141 #[serde(default)]
2142 pub tags: Option<Vec<String>>,
2143 #[serde(default)]
2144 pub min_importance: Option<f32>,
2145 #[serde(default)]
2146 pub max_importance: Option<f32>,
2147 #[serde(default)]
2148 pub created_after: Option<u64>,
2149 #[serde(default)]
2150 pub created_before: Option<u64>,
2151 #[serde(default = "default_top_k")]
2152 pub top_k: usize,
2153 #[serde(default)]
2154 pub sort_by: Option<MemorySortField>,
2155}
2156
2157#[derive(Debug, Clone, Copy, Serialize, Deserialize)]
2159#[serde(rename_all = "snake_case")]
2160pub enum MemorySortField {
2161 CreatedAt,
2162 LastAccessedAt,
2163 Importance,
2164 AccessCount,
2165}
2166
2167#[derive(Debug, Serialize)]
2169pub struct SearchMemoriesResponse {
2170 pub memories: Vec<RecallResult>,
2171 pub total_count: usize,
2172}
2173
2174#[derive(Debug, Deserialize)]
2180pub struct SessionStartRequest {
2181 pub agent_id: String,
2182 #[serde(skip_serializing_if = "Option::is_none")]
2183 pub metadata: Option<serde_json::Value>,
2184 #[serde(skip_serializing_if = "Option::is_none")]
2186 pub id: Option<String>,
2187}
2188
2189#[derive(Debug, Serialize)]
2191pub struct SessionStartResponse {
2192 pub session: Session,
2193}
2194
2195#[derive(Debug, Deserialize)]
2197pub struct SessionEndRequest {
2198 #[serde(default)]
2199 pub summary: Option<String>,
2200 #[serde(default)]
2202 pub auto_summarize: bool,
2203}
2204
2205#[derive(Debug, Serialize)]
2207pub struct SessionEndResponse {
2208 pub session: Session,
2209 pub memory_count: usize,
2210}
2211
2212#[derive(Debug, Serialize)]
2214pub struct ListSessionsResponse {
2215 pub sessions: Vec<Session>,
2216 pub total: usize,
2217}
2218
2219#[derive(Debug, Serialize)]
2221pub struct SessionMemoriesResponse {
2222 pub session: Session,
2223 pub memories: Vec<Memory>,
2224 #[serde(skip_serializing_if = "Option::is_none")]
2226 pub total: Option<usize>,
2227}
2228
2229#[derive(Debug, Serialize, Deserialize, Clone)]
2235pub struct AgentSummary {
2236 pub agent_id: String,
2237 pub memory_count: usize,
2238 pub session_count: usize,
2239 pub active_sessions: usize,
2240}
2241
2242#[derive(Debug, Serialize)]
2244pub struct AgentStats {
2245 pub agent_id: String,
2246 pub total_memories: usize,
2247 pub memories_by_type: std::collections::HashMap<String, usize>,
2248 pub total_sessions: usize,
2249 pub active_sessions: usize,
2250 pub avg_importance: f32,
2251 pub oldest_memory_at: Option<u64>,
2252 pub newest_memory_at: Option<u64>,
2253}
2254
2255#[derive(Debug, Deserialize)]
2257pub struct KnowledgeGraphRequest {
2258 pub agent_id: String,
2259 pub memory_id: String,
2260 #[serde(default = "default_graph_depth")]
2261 pub depth: usize,
2262 #[serde(default = "default_graph_min_similarity")]
2263 pub min_similarity: f32,
2264}
2265
2266fn default_graph_depth() -> usize {
2267 2
2268}
2269
2270fn default_graph_min_similarity() -> f32 {
2271 0.7
2272}
2273
2274#[derive(Debug, Serialize)]
2276pub struct KnowledgeGraphNode {
2277 pub memory: Memory,
2278 pub similarity: f32,
2279 pub related: Vec<KnowledgeGraphEdge>,
2280}
2281
2282#[derive(Debug, Serialize)]
2284pub struct KnowledgeGraphEdge {
2285 pub memory_id: String,
2286 pub similarity: f32,
2287 pub shared_tags: Vec<String>,
2288}
2289
2290#[derive(Debug, Serialize)]
2292pub struct KnowledgeGraphResponse {
2293 pub root: KnowledgeGraphNode,
2294 pub total_nodes: usize,
2295}
2296
2297fn default_full_graph_max_nodes() -> usize {
2302 200
2303}
2304
2305fn default_full_graph_min_similarity() -> f32 {
2306 0.50
2307}
2308
2309fn default_full_graph_cluster_threshold() -> f32 {
2310 0.60
2311}
2312
2313fn default_full_graph_max_edges_per_node() -> usize {
2314 8
2315}
2316
2317#[derive(Debug, Deserialize)]
2319pub struct FullKnowledgeGraphRequest {
2320 pub agent_id: String,
2321 #[serde(default = "default_full_graph_max_nodes")]
2322 pub max_nodes: usize,
2323 #[serde(default = "default_full_graph_min_similarity")]
2324 pub min_similarity: f32,
2325 #[serde(default = "default_full_graph_cluster_threshold")]
2326 pub cluster_threshold: f32,
2327 #[serde(default = "default_full_graph_max_edges_per_node")]
2328 pub max_edges_per_node: usize,
2329}
2330
2331#[derive(Debug, Serialize)]
2333pub struct FullGraphNode {
2334 pub id: String,
2335 pub content: String,
2336 pub memory_type: String,
2337 pub importance: f32,
2338 pub tags: Vec<String>,
2339 pub created_at: Option<String>,
2340 pub cluster_id: usize,
2341 pub centrality: f32,
2342}
2343
2344#[derive(Debug, Serialize)]
2346pub struct FullGraphEdge {
2347 pub source: String,
2348 pub target: String,
2349 pub similarity: f32,
2350 pub shared_tags: Vec<String>,
2351}
2352
2353#[derive(Debug, Serialize)]
2355pub struct GraphCluster {
2356 pub id: usize,
2357 pub node_count: usize,
2358 pub top_tags: Vec<String>,
2359 pub avg_importance: f32,
2360}
2361
2362#[derive(Debug, Serialize)]
2364pub struct GraphStats {
2365 pub total_memories: usize,
2366 pub included_memories: usize,
2367 pub total_edges: usize,
2368 pub cluster_count: usize,
2369 pub density: f32,
2370 pub hub_memory_id: Option<String>,
2371}
2372
2373#[derive(Debug, Serialize)]
2375pub struct FullKnowledgeGraphResponse {
2376 pub nodes: Vec<FullGraphNode>,
2377 pub edges: Vec<FullGraphEdge>,
2378 pub clusters: Vec<GraphCluster>,
2379 pub stats: GraphStats,
2380}
2381
2382#[derive(Debug, Deserialize)]
2384pub struct SummarizeRequest {
2385 pub agent_id: String,
2386 pub memory_ids: Vec<String>,
2387 #[serde(default)]
2388 pub target_type: Option<MemoryType>,
2389}
2390
2391#[derive(Debug, Serialize)]
2393pub struct SummarizeResponse {
2394 pub summary_memory: Memory,
2395 pub source_count: usize,
2396}
2397
2398#[derive(Debug, Deserialize)]
2400pub struct DeduplicateRequest {
2401 pub agent_id: String,
2402 #[serde(default = "default_dedup_threshold")]
2403 pub threshold: f32,
2404 #[serde(default)]
2405 pub memory_type: Option<MemoryType>,
2406 #[serde(default)]
2408 pub dry_run: bool,
2409}
2410
2411fn default_dedup_threshold() -> f32 {
2412 0.92
2413}
2414
2415#[derive(Debug, Serialize)]
2417pub struct DuplicateGroup {
2418 pub canonical_id: String,
2419 pub duplicate_ids: Vec<String>,
2420 pub avg_similarity: f32,
2421}
2422
2423#[derive(Debug, Serialize)]
2425pub struct DeduplicateResponse {
2426 pub groups: Vec<DuplicateGroup>,
2427 pub duplicates_found: usize,
2428 pub duplicates_merged: usize,
2429}
2430
2431fn default_cross_agent_min_similarity() -> f32 {
2436 0.3
2437}
2438
2439fn default_cross_agent_max_nodes_per_agent() -> usize {
2440 50
2441}
2442
2443fn default_cross_agent_max_cross_edges() -> usize {
2444 200
2445}
2446
2447#[derive(Debug, Deserialize)]
2449pub struct CrossAgentNetworkRequest {
2450 #[serde(default)]
2452 pub agent_ids: Option<Vec<String>>,
2453 #[serde(default = "default_cross_agent_min_similarity")]
2455 pub min_similarity: f32,
2456 #[serde(default = "default_cross_agent_max_nodes_per_agent")]
2458 pub max_nodes_per_agent: usize,
2459 #[serde(default)]
2461 pub min_importance: f32,
2462 #[serde(default = "default_cross_agent_max_cross_edges")]
2464 pub max_cross_edges: usize,
2465}
2466
2467#[derive(Debug, Serialize)]
2469pub struct AgentNetworkInfo {
2470 pub agent_id: String,
2471 pub memory_count: usize,
2472 pub avg_importance: f32,
2473}
2474
2475#[derive(Debug, Serialize)]
2477pub struct AgentNetworkNode {
2478 pub id: String,
2479 pub agent_id: String,
2480 pub content: String,
2481 pub importance: f32,
2482 pub tags: Vec<String>,
2483 pub memory_type: String,
2484 pub created_at: u64,
2485}
2486
2487#[derive(Debug, Serialize)]
2489pub struct AgentNetworkEdge {
2490 pub source: String,
2491 pub target: String,
2492 pub source_agent: String,
2493 pub target_agent: String,
2494 pub similarity: f32,
2495}
2496
2497#[derive(Debug, Serialize)]
2499pub struct AgentNetworkStats {
2500 pub total_agents: usize,
2501 pub total_nodes: usize,
2502 pub total_cross_edges: usize,
2503 pub density: f32,
2504}
2505
2506#[derive(Debug, Serialize)]
2508pub struct CrossAgentNetworkResponse {
2509 pub node_count: usize,
2510 pub agents: Vec<AgentNetworkInfo>,
2511 pub nodes: Vec<AgentNetworkNode>,
2512 pub edges: Vec<AgentNetworkEdge>,
2513 pub stats: AgentNetworkStats,
2514}
2515
2516#[derive(Debug, Deserialize, Default)]
2524pub struct BatchMemoryFilter {
2525 #[serde(default)]
2527 pub tags: Option<Vec<String>>,
2528 #[serde(default)]
2530 pub min_importance: Option<f32>,
2531 #[serde(default)]
2533 pub max_importance: Option<f32>,
2534 #[serde(default)]
2536 pub created_after: Option<u64>,
2537 #[serde(default)]
2539 pub created_before: Option<u64>,
2540 #[serde(default)]
2542 pub memory_type: Option<MemoryType>,
2543 #[serde(default)]
2545 pub session_id: Option<String>,
2546}
2547
2548impl BatchMemoryFilter {
2549 pub fn has_any(&self) -> bool {
2551 self.tags.is_some()
2552 || self.min_importance.is_some()
2553 || self.max_importance.is_some()
2554 || self.created_after.is_some()
2555 || self.created_before.is_some()
2556 || self.memory_type.is_some()
2557 || self.session_id.is_some()
2558 }
2559
2560 pub fn matches(&self, memory: &Memory) -> bool {
2562 if let Some(ref tags) = self.tags {
2563 if !tags.is_empty() && !tags.iter().all(|t| memory.tags.contains(t)) {
2564 return false;
2565 }
2566 }
2567 if let Some(min) = self.min_importance {
2568 if memory.importance < min {
2569 return false;
2570 }
2571 }
2572 if let Some(max) = self.max_importance {
2573 if memory.importance > max {
2574 return false;
2575 }
2576 }
2577 if let Some(after) = self.created_after {
2578 if memory.created_at < after {
2579 return false;
2580 }
2581 }
2582 if let Some(before) = self.created_before {
2583 if memory.created_at > before {
2584 return false;
2585 }
2586 }
2587 if let Some(ref mt) = self.memory_type {
2588 if memory.memory_type != *mt {
2589 return false;
2590 }
2591 }
2592 if let Some(ref sid) = self.session_id {
2593 if memory.session_id.as_ref() != Some(sid) {
2594 return false;
2595 }
2596 }
2597 true
2598 }
2599}
2600
2601#[derive(Debug, Deserialize)]
2603pub struct BatchRecallRequest {
2604 pub agent_id: String,
2606 #[serde(default)]
2608 pub filter: BatchMemoryFilter,
2609 #[serde(default = "default_batch_limit")]
2611 pub limit: usize,
2612}
2613
2614fn default_batch_limit() -> usize {
2615 100
2616}
2617
2618#[derive(Debug, Serialize)]
2620pub struct BatchRecallResponse {
2621 pub memories: Vec<Memory>,
2622 pub total: usize,
2623 pub filtered: usize,
2624}
2625
2626#[derive(Debug, Deserialize)]
2628pub struct BatchForgetRequest {
2629 pub agent_id: String,
2631 pub filter: BatchMemoryFilter,
2633}
2634
2635#[derive(Debug, Serialize)]
2637pub struct BatchForgetResponse {
2638 pub deleted_count: usize,
2639}
2640
2641#[derive(Debug, Deserialize)]
2648pub struct NamespaceEntityConfigRequest {
2649 pub extract_entities: bool,
2651 #[serde(default)]
2654 pub entity_types: Vec<String>,
2655}
2656
2657#[derive(Debug, Serialize, Deserialize)]
2659pub struct NamespaceEntityConfigResponse {
2660 pub namespace: String,
2661 pub extract_entities: bool,
2662 pub entity_types: Vec<String>,
2663}
2664
2665#[derive(Debug, Deserialize)]
2668pub struct ExtractEntitiesRequest {
2669 pub content: String,
2671 #[serde(default)]
2674 pub entity_types: Vec<String>,
2675}
2676
2677#[derive(Debug, Clone, Serialize, Deserialize)]
2679pub struct EntityResult {
2680 pub entity_type: String,
2681 pub value: String,
2682 pub score: f32,
2683 pub start: usize,
2684 pub end: usize,
2685 pub tag: String,
2687}
2688
2689#[derive(Debug, Serialize)]
2691pub struct ExtractEntitiesResponse {
2692 pub entities: Vec<EntityResult>,
2693 pub count: usize,
2694}
2695
2696#[derive(Debug, Deserialize)]
2702pub struct GraphTraverseQuery {
2703 #[serde(default = "default_ce5_graph_depth")]
2705 pub depth: u32,
2706}
2707
2708fn default_ce5_graph_depth() -> u32 {
2709 3
2710}
2711
2712#[derive(Debug, Deserialize)]
2714pub struct GraphPathQuery {
2715 pub to: String,
2717}
2718
2719#[derive(Debug, Deserialize)]
2721pub struct MemoryLinkRequest {
2722 pub target_id: String,
2724 #[serde(skip_serializing_if = "Option::is_none")]
2726 pub label: Option<String>,
2727 pub agent_id: String,
2729}
2730
2731#[derive(Debug, Serialize)]
2733pub struct GraphTraverseResponse {
2734 pub root_id: String,
2735 pub depth: u32,
2736 pub node_count: usize,
2737 pub nodes: Vec<GraphNodeResponse>,
2738}
2739
2740#[derive(Debug, Serialize)]
2742pub struct GraphNodeResponse {
2743 pub memory_id: String,
2744 pub depth: u32,
2745 pub edges: Vec<GraphEdgeResponse>,
2746}
2747
2748#[derive(Debug, Serialize)]
2750pub struct GraphEdgeResponse {
2751 pub from_id: String,
2752 pub to_id: String,
2753 pub edge_type: String,
2754 pub weight: f32,
2755 pub created_at: u64,
2756}
2757
2758#[derive(Debug, Serialize)]
2760pub struct GraphPathResponse {
2761 pub from_id: String,
2762 pub to_id: String,
2763 pub path: Vec<String>,
2765 pub hop_count: usize,
2766}
2767
2768#[derive(Debug, Serialize)]
2770pub struct MemoryLinkResponse {
2771 pub from_id: String,
2772 pub to_id: String,
2773 pub edge_type: String,
2774}
2775
2776#[derive(Debug, Serialize)]
2778pub struct GraphExportResponse {
2779 pub agent_id: String,
2780 pub namespace: String,
2781 pub node_count: usize,
2782 pub edge_count: usize,
2783 pub edges: Vec<GraphEdgeResponse>,
2784}
2785
2786#[derive(Debug, Deserialize)]
2792pub struct KgQueryParams {
2793 pub agent_id: String,
2795 #[serde(default)]
2797 pub root_id: Option<String>,
2798 #[serde(default)]
2800 pub edge_type: Option<String>,
2801 #[serde(default)]
2803 pub min_weight: Option<f32>,
2804 #[serde(default = "default_kg_depth")]
2806 pub max_depth: u32,
2807 #[serde(default = "default_kg_limit")]
2809 pub limit: usize,
2810}
2811
2812fn default_kg_depth() -> u32 {
2813 3
2814}
2815
2816fn default_kg_limit() -> usize {
2817 100
2818}
2819
2820#[derive(Debug, Serialize)]
2822pub struct KgQueryResponse {
2823 pub agent_id: String,
2824 pub node_count: usize,
2825 pub edge_count: usize,
2826 pub edges: Vec<GraphEdgeResponse>,
2827}
2828
2829#[derive(Debug, Deserialize)]
2831pub struct KgPathParams {
2832 pub agent_id: String,
2834 pub from: String,
2836 pub to: String,
2838}
2839
2840#[derive(Debug, Serialize)]
2842pub struct KgPathResponse {
2843 pub agent_id: String,
2844 pub from_id: String,
2845 pub to_id: String,
2846 pub hop_count: usize,
2847 pub path: Vec<String>,
2848}
2849
2850#[derive(Debug, Deserialize)]
2852pub struct KgExportParams {
2853 pub agent_id: String,
2855 #[serde(default = "default_kg_format")]
2857 pub format: String,
2858}
2859
2860fn default_kg_format() -> String {
2861 "json".to_string()
2862}
2863
2864#[derive(Debug, Serialize)]
2866pub struct KgExportJsonResponse {
2867 pub agent_id: String,
2868 pub format: String,
2869 pub node_count: usize,
2870 pub edge_count: usize,
2871 pub edges: Vec<GraphEdgeResponse>,
2872}
2873
2874fn default_working_ttl() -> Option<u64> {
2879 Some(14_400) }
2881fn default_episodic_ttl() -> Option<u64> {
2882 Some(2_592_000) }
2884fn default_semantic_ttl() -> Option<u64> {
2885 Some(31_536_000) }
2887fn default_procedural_ttl() -> Option<u64> {
2888 Some(63_072_000) }
2890fn default_working_decay() -> DecayStrategy {
2891 DecayStrategy::Exponential
2892}
2893fn default_episodic_decay() -> DecayStrategy {
2894 DecayStrategy::PowerLaw
2895}
2896fn default_semantic_decay() -> DecayStrategy {
2897 DecayStrategy::Logarithmic
2898}
2899fn default_procedural_decay() -> DecayStrategy {
2900 DecayStrategy::Flat
2901}
2902fn default_sr_factor() -> f64 {
2903 1.0
2904}
2905fn default_sr_base_interval() -> u64 {
2906 86_400 }
2908fn default_consolidation_enabled() -> bool {
2909 false
2910}
2911fn default_policy_consolidation_threshold() -> f32 {
2912 0.92
2913}
2914fn default_consolidation_interval_hours() -> u32 {
2915 24
2916}
2917
2918#[derive(Debug, Clone, Serialize, Deserialize)]
2923pub struct MemoryPolicy {
2924 #[serde(
2927 default = "default_working_ttl",
2928 skip_serializing_if = "Option::is_none"
2929 )]
2930 pub working_ttl_seconds: Option<u64>,
2931 #[serde(
2933 default = "default_episodic_ttl",
2934 skip_serializing_if = "Option::is_none"
2935 )]
2936 pub episodic_ttl_seconds: Option<u64>,
2937 #[serde(
2939 default = "default_semantic_ttl",
2940 skip_serializing_if = "Option::is_none"
2941 )]
2942 pub semantic_ttl_seconds: Option<u64>,
2943 #[serde(
2945 default = "default_procedural_ttl",
2946 skip_serializing_if = "Option::is_none"
2947 )]
2948 pub procedural_ttl_seconds: Option<u64>,
2949
2950 #[serde(default = "default_working_decay")]
2953 pub working_decay: DecayStrategy,
2954 #[serde(default = "default_episodic_decay")]
2956 pub episodic_decay: DecayStrategy,
2957 #[serde(default = "default_semantic_decay")]
2959 pub semantic_decay: DecayStrategy,
2960 #[serde(default = "default_procedural_decay")]
2962 pub procedural_decay: DecayStrategy,
2963
2964 #[serde(default = "default_sr_factor")]
2969 pub spaced_repetition_factor: f64,
2970 #[serde(default = "default_sr_base_interval")]
2972 pub spaced_repetition_base_interval_seconds: u64,
2973
2974 #[serde(default = "default_consolidation_enabled")]
2977 pub consolidation_enabled: bool,
2978 #[serde(default = "default_policy_consolidation_threshold")]
2980 pub consolidation_threshold: f32,
2981 #[serde(default = "default_consolidation_interval_hours")]
2983 pub consolidation_interval_hours: u32,
2984 #[serde(default)]
2986 pub consolidated_count: u64,
2987}
2988
2989impl Default for MemoryPolicy {
2990 fn default() -> Self {
2991 Self {
2992 working_ttl_seconds: default_working_ttl(),
2993 episodic_ttl_seconds: default_episodic_ttl(),
2994 semantic_ttl_seconds: default_semantic_ttl(),
2995 procedural_ttl_seconds: default_procedural_ttl(),
2996 working_decay: default_working_decay(),
2997 episodic_decay: default_episodic_decay(),
2998 semantic_decay: default_semantic_decay(),
2999 procedural_decay: default_procedural_decay(),
3000 spaced_repetition_factor: default_sr_factor(),
3001 spaced_repetition_base_interval_seconds: default_sr_base_interval(),
3002 consolidation_enabled: default_consolidation_enabled(),
3003 consolidation_threshold: default_policy_consolidation_threshold(),
3004 consolidation_interval_hours: default_consolidation_interval_hours(),
3005 consolidated_count: 0,
3006 }
3007 }
3008}
3009
3010impl MemoryPolicy {
3011 pub fn ttl_for_type(&self, memory_type: &MemoryType) -> Option<u64> {
3013 match memory_type {
3014 MemoryType::Working => self.working_ttl_seconds,
3015 MemoryType::Episodic => self.episodic_ttl_seconds,
3016 MemoryType::Semantic => self.semantic_ttl_seconds,
3017 MemoryType::Procedural => self.procedural_ttl_seconds,
3018 }
3019 }
3020
3021 pub fn decay_for_type(&self, memory_type: &MemoryType) -> DecayStrategy {
3023 match memory_type {
3024 MemoryType::Working => self.working_decay,
3025 MemoryType::Episodic => self.episodic_decay,
3026 MemoryType::Semantic => self.semantic_decay,
3027 MemoryType::Procedural => self.procedural_decay,
3028 }
3029 }
3030
3031 pub fn spaced_repetition_extension(&self, access_count: u32) -> u64 {
3035 if self.spaced_repetition_factor <= 0.0 {
3036 return 0;
3037 }
3038 let ext = access_count as f64
3039 * self.spaced_repetition_factor
3040 * self.spaced_repetition_base_interval_seconds as f64;
3041 ext.round() as u64
3042 }
3043}