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 = "bge-large")]
1514 BgeLarge,
1515 #[serde(rename = "minilm")]
1517 MiniLM,
1518 #[serde(rename = "bge-small")]
1520 BgeSmall,
1521 #[serde(rename = "e5-small")]
1523 E5Small,
1524}
1525
1526impl EmbeddingModelType {
1527 pub fn dimension(&self) -> usize {
1529 match self {
1530 EmbeddingModelType::BgeLarge => 1024,
1531 EmbeddingModelType::MiniLM => 384,
1532 EmbeddingModelType::BgeSmall => 384,
1533 EmbeddingModelType::E5Small => 384,
1534 }
1535 }
1536}
1537
1538impl std::fmt::Display for EmbeddingModelType {
1539 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1540 match self {
1541 EmbeddingModelType::BgeLarge => write!(f, "bge-large"),
1542 EmbeddingModelType::MiniLM => write!(f, "minilm"),
1543 EmbeddingModelType::BgeSmall => write!(f, "bge-small"),
1544 EmbeddingModelType::E5Small => write!(f, "e5-small"),
1545 }
1546 }
1547}
1548
1549#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
1555#[serde(rename_all = "snake_case")]
1556#[derive(Default)]
1557pub enum MemoryType {
1558 #[default]
1560 Episodic,
1561 Semantic,
1563 Procedural,
1565 Working,
1567}
1568
1569impl std::fmt::Display for MemoryType {
1570 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1571 match self {
1572 MemoryType::Episodic => write!(f, "episodic"),
1573 MemoryType::Semantic => write!(f, "semantic"),
1574 MemoryType::Procedural => write!(f, "procedural"),
1575 MemoryType::Working => write!(f, "working"),
1576 }
1577 }
1578}
1579
1580#[derive(Debug, Clone, Serialize, Deserialize)]
1582pub struct Memory {
1583 pub id: String,
1584 #[serde(default)]
1585 pub memory_type: MemoryType,
1586 pub content: String,
1587 pub agent_id: String,
1588 #[serde(skip_serializing_if = "Option::is_none")]
1589 pub session_id: Option<String>,
1590 #[serde(default = "default_importance")]
1591 pub importance: f32,
1592 #[serde(default)]
1593 pub tags: Vec<String>,
1594 #[serde(skip_serializing_if = "Option::is_none")]
1595 pub metadata: Option<serde_json::Value>,
1596 pub created_at: u64,
1597 pub last_accessed_at: u64,
1598 #[serde(default)]
1599 pub access_count: u32,
1600 #[serde(skip_serializing_if = "Option::is_none")]
1601 pub ttl_seconds: Option<u64>,
1602 #[serde(skip_serializing_if = "Option::is_none")]
1603 pub expires_at: Option<u64>,
1604}
1605
1606fn default_importance() -> f32 {
1607 0.5
1608}
1609
1610impl Memory {
1611 pub fn new(id: String, content: String, agent_id: String, memory_type: MemoryType) -> Self {
1613 let now = std::time::SystemTime::now()
1614 .duration_since(std::time::UNIX_EPOCH)
1615 .unwrap_or_default()
1616 .as_secs();
1617 Self {
1618 id,
1619 memory_type,
1620 content,
1621 agent_id,
1622 session_id: None,
1623 importance: 0.5,
1624 tags: Vec::new(),
1625 metadata: None,
1626 created_at: now,
1627 last_accessed_at: now,
1628 access_count: 0,
1629 ttl_seconds: None,
1630 expires_at: None,
1631 }
1632 }
1633
1634 pub fn is_expired(&self) -> bool {
1636 if let Some(expires_at) = self.expires_at {
1637 let now = std::time::SystemTime::now()
1638 .duration_since(std::time::UNIX_EPOCH)
1639 .unwrap_or_default()
1640 .as_secs();
1641 now >= expires_at
1642 } else {
1643 false
1644 }
1645 }
1646
1647 pub fn to_vector_metadata(&self) -> serde_json::Value {
1649 let mut meta = serde_json::Map::new();
1650 meta.insert("_dakera_type".to_string(), serde_json::json!("memory"));
1651 meta.insert(
1652 "memory_type".to_string(),
1653 serde_json::json!(self.memory_type),
1654 );
1655 meta.insert("content".to_string(), serde_json::json!(self.content));
1656 meta.insert("agent_id".to_string(), serde_json::json!(self.agent_id));
1657 if let Some(ref sid) = self.session_id {
1658 meta.insert("session_id".to_string(), serde_json::json!(sid));
1659 }
1660 meta.insert("importance".to_string(), serde_json::json!(self.importance));
1661 meta.insert("tags".to_string(), serde_json::json!(self.tags));
1662 meta.insert("created_at".to_string(), serde_json::json!(self.created_at));
1663 meta.insert(
1664 "last_accessed_at".to_string(),
1665 serde_json::json!(self.last_accessed_at),
1666 );
1667 meta.insert(
1668 "access_count".to_string(),
1669 serde_json::json!(self.access_count),
1670 );
1671 if let Some(ref ttl) = self.ttl_seconds {
1672 meta.insert("ttl_seconds".to_string(), serde_json::json!(ttl));
1673 }
1674 if let Some(ref expires) = self.expires_at {
1675 meta.insert("expires_at".to_string(), serde_json::json!(expires));
1676 }
1677 if let Some(ref user_meta) = self.metadata {
1678 meta.insert("user_metadata".to_string(), user_meta.clone());
1679 }
1680 serde_json::Value::Object(meta)
1681 }
1682
1683 pub fn to_vector(&self, embedding: Vec<f32>) -> Vector {
1685 let mut v = Vector {
1686 id: self.id.clone(),
1687 values: embedding,
1688 metadata: Some(self.to_vector_metadata()),
1689 ttl_seconds: self.ttl_seconds,
1690 expires_at: self.expires_at,
1691 };
1692 v.apply_ttl();
1693 v
1694 }
1695
1696 pub fn from_vector(vector: &Vector) -> Option<Self> {
1698 let meta = vector.metadata.as_ref()?.as_object()?;
1699 let entry_type = meta.get("_dakera_type")?.as_str()?;
1700 if entry_type != "memory" {
1701 return None;
1702 }
1703
1704 Some(Memory {
1705 id: vector.id.clone(),
1706 memory_type: serde_json::from_value(meta.get("memory_type")?.clone())
1707 .unwrap_or_default(),
1708 content: meta.get("content")?.as_str()?.to_string(),
1709 agent_id: meta.get("agent_id")?.as_str()?.to_string(),
1710 session_id: meta
1711 .get("session_id")
1712 .and_then(|v| v.as_str())
1713 .map(String::from),
1714 importance: meta
1715 .get("importance")
1716 .and_then(|v| v.as_f64())
1717 .unwrap_or(0.5) as f32,
1718 tags: meta
1719 .get("tags")
1720 .and_then(|v| serde_json::from_value(v.clone()).ok())
1721 .unwrap_or_default(),
1722 metadata: meta.get("user_metadata").cloned(),
1723 created_at: meta.get("created_at").and_then(|v| v.as_u64()).unwrap_or(0),
1724 last_accessed_at: meta
1725 .get("last_accessed_at")
1726 .and_then(|v| v.as_u64())
1727 .unwrap_or(0),
1728 access_count: meta
1729 .get("access_count")
1730 .and_then(|v| v.as_u64())
1731 .unwrap_or(0) as u32,
1732 ttl_seconds: vector.ttl_seconds,
1733 expires_at: vector.expires_at,
1734 })
1735 }
1736}
1737
1738#[derive(Debug, Clone, Serialize, Deserialize)]
1740pub struct Session {
1741 pub id: String,
1742 pub agent_id: String,
1743 pub started_at: u64,
1744 #[serde(skip_serializing_if = "Option::is_none")]
1745 pub ended_at: Option<u64>,
1746 #[serde(skip_serializing_if = "Option::is_none")]
1747 pub summary: Option<String>,
1748 #[serde(skip_serializing_if = "Option::is_none")]
1749 pub metadata: Option<serde_json::Value>,
1750 #[serde(default)]
1752 pub memory_count: usize,
1753}
1754
1755impl Session {
1756 pub fn new(id: String, agent_id: String) -> Self {
1757 let now = std::time::SystemTime::now()
1758 .duration_since(std::time::UNIX_EPOCH)
1759 .unwrap_or_default()
1760 .as_secs();
1761 Self {
1762 id,
1763 agent_id,
1764 started_at: now,
1765 ended_at: None,
1766 summary: None,
1767 metadata: None,
1768 memory_count: 0,
1769 }
1770 }
1771
1772 pub fn to_vector_metadata(&self) -> serde_json::Value {
1774 let mut meta = serde_json::Map::new();
1775 meta.insert("_dakera_type".to_string(), serde_json::json!("session"));
1776 meta.insert("agent_id".to_string(), serde_json::json!(self.agent_id));
1777 meta.insert("started_at".to_string(), serde_json::json!(self.started_at));
1778 if let Some(ref ended) = self.ended_at {
1779 meta.insert("ended_at".to_string(), serde_json::json!(ended));
1780 }
1781 if let Some(ref summary) = self.summary {
1782 meta.insert("summary".to_string(), serde_json::json!(summary));
1783 }
1784 if let Some(ref user_meta) = self.metadata {
1785 meta.insert("user_metadata".to_string(), user_meta.clone());
1786 }
1787 meta.insert(
1788 "memory_count".to_string(),
1789 serde_json::json!(self.memory_count),
1790 );
1791 serde_json::Value::Object(meta)
1792 }
1793
1794 pub fn to_vector(&self, embedding: Vec<f32>) -> Vector {
1796 Vector {
1797 id: self.id.clone(),
1798 values: embedding,
1799 metadata: Some(self.to_vector_metadata()),
1800 ttl_seconds: None,
1801 expires_at: None,
1802 }
1803 }
1804
1805 pub fn from_vector(vector: &Vector) -> Option<Self> {
1807 let meta = vector.metadata.as_ref()?.as_object()?;
1808 let entry_type = meta.get("_dakera_type")?.as_str()?;
1809 if entry_type != "session" {
1810 return None;
1811 }
1812
1813 Some(Session {
1814 id: vector.id.clone(),
1815 agent_id: meta.get("agent_id")?.as_str()?.to_string(),
1816 started_at: meta.get("started_at").and_then(|v| v.as_u64()).unwrap_or(0),
1817 ended_at: meta.get("ended_at").and_then(|v| v.as_u64()),
1818 summary: meta
1819 .get("summary")
1820 .and_then(|v| v.as_str())
1821 .map(String::from),
1822 metadata: meta.get("user_metadata").cloned(),
1823 memory_count: meta
1824 .get("memory_count")
1825 .and_then(|v| v.as_u64())
1826 .unwrap_or(0) as usize,
1827 })
1828 }
1829}
1830
1831#[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize)]
1833#[serde(rename_all = "snake_case")]
1834#[derive(Default)]
1835pub enum DecayStrategy {
1836 #[default]
1837 Exponential,
1838 Linear,
1839 StepFunction,
1840 PowerLaw,
1842 Logarithmic,
1844 Flat,
1846}
1847
1848#[derive(Debug, Clone, Serialize, Deserialize)]
1850pub struct DecayConfig {
1851 #[serde(default)]
1852 pub strategy: DecayStrategy,
1853 #[serde(default = "default_half_life_hours")]
1854 pub half_life_hours: f64,
1855 #[serde(default = "default_min_importance")]
1856 pub min_importance: f32,
1857}
1858
1859fn default_half_life_hours() -> f64 {
1860 168.0 }
1862
1863fn default_min_importance() -> f32 {
1864 0.01
1865}
1866
1867impl Default for DecayConfig {
1868 fn default() -> Self {
1869 Self {
1870 strategy: DecayStrategy::default(),
1871 half_life_hours: default_half_life_hours(),
1872 min_importance: default_min_importance(),
1873 }
1874 }
1875}
1876
1877#[derive(Debug, Deserialize)]
1883pub struct StoreMemoryRequest {
1884 pub content: String,
1885 pub agent_id: String,
1886 #[serde(default)]
1887 pub memory_type: MemoryType,
1888 #[serde(skip_serializing_if = "Option::is_none")]
1889 pub session_id: Option<String>,
1890 #[serde(default = "default_importance")]
1891 pub importance: f32,
1892 #[serde(default)]
1893 pub tags: Vec<String>,
1894 #[serde(skip_serializing_if = "Option::is_none")]
1895 pub metadata: Option<serde_json::Value>,
1896 #[serde(skip_serializing_if = "Option::is_none")]
1897 pub ttl_seconds: Option<u64>,
1898 #[serde(skip_serializing_if = "Option::is_none")]
1903 pub expires_at: Option<u64>,
1904 #[serde(skip_serializing_if = "Option::is_none")]
1906 pub id: Option<String>,
1907}
1908
1909#[derive(Debug, Serialize)]
1911pub struct StoreMemoryResponse {
1912 pub memory: Memory,
1913 pub embedding_time_ms: u64,
1914}
1915
1916#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq, Default)]
1920#[serde(rename_all = "lowercase")]
1921pub enum RoutingMode {
1922 #[default]
1924 Auto,
1925 Vector,
1927 Bm25,
1929 Hybrid,
1931}
1932
1933#[derive(Debug, Deserialize)]
1935pub struct RecallRequest {
1936 pub query: String,
1937 pub agent_id: String,
1938 #[serde(default = "default_top_k")]
1939 pub top_k: usize,
1940 #[serde(default)]
1941 pub memory_type: Option<MemoryType>,
1942 #[serde(default)]
1943 pub session_id: Option<String>,
1944 #[serde(default)]
1945 pub tags: Option<Vec<String>>,
1946 #[serde(default)]
1947 pub min_importance: Option<f32>,
1948 #[serde(default = "default_true")]
1950 pub importance_weighted: bool,
1951 #[serde(default)]
1953 pub include_associated: bool,
1954 #[serde(default)]
1956 pub associated_memories_cap: Option<usize>,
1957 #[serde(default)]
1959 pub since: Option<String>,
1960 #[serde(default)]
1962 pub until: Option<String>,
1963 #[serde(default)]
1966 pub associated_memories_depth: Option<u8>,
1967 #[serde(default)]
1970 pub associated_memories_min_weight: Option<f32>,
1971 #[serde(default)]
1975 pub routing: RoutingMode,
1976 #[serde(default = "default_true")]
1980 pub rerank: bool,
1981}
1982
1983#[derive(Debug, Serialize, Deserialize)]
1985pub struct RecallResult {
1986 pub memory: Memory,
1987 pub score: f32,
1988 #[serde(skip_serializing_if = "Option::is_none")]
1990 pub weighted_score: Option<f32>,
1991 #[serde(skip_serializing_if = "Option::is_none")]
1993 pub smart_score: Option<f32>,
1994 #[serde(skip_serializing_if = "Option::is_none")]
1997 pub depth: Option<u8>,
1998}
1999
2000#[derive(Debug, Serialize)]
2002pub struct RecallResponse {
2003 pub memories: Vec<RecallResult>,
2004 pub query_embedding_time_ms: u64,
2005 pub search_time_ms: u64,
2006 #[serde(skip_serializing_if = "Option::is_none")]
2009 pub associated_memories: Option<Vec<RecallResult>>,
2010}
2011
2012#[derive(Debug, Deserialize)]
2014pub struct ForgetRequest {
2015 pub agent_id: String,
2016 #[serde(default)]
2017 pub memory_ids: Option<Vec<String>>,
2018 #[serde(default)]
2019 pub memory_type: Option<MemoryType>,
2020 #[serde(default)]
2021 pub session_id: Option<String>,
2022 #[serde(default)]
2023 pub tags: Option<Vec<String>>,
2024 #[serde(default)]
2026 pub below_importance: Option<f32>,
2027}
2028
2029#[derive(Debug, Serialize)]
2031pub struct ForgetResponse {
2032 pub deleted_count: usize,
2033}
2034
2035#[derive(Debug, Deserialize)]
2037pub struct UpdateMemoryRequest {
2038 #[serde(default)]
2039 pub content: Option<String>,
2040 #[serde(default)]
2041 pub importance: Option<f32>,
2042 #[serde(default)]
2043 pub tags: Option<Vec<String>>,
2044 #[serde(default)]
2045 pub metadata: Option<serde_json::Value>,
2046 #[serde(default)]
2047 pub memory_type: Option<MemoryType>,
2048}
2049
2050#[derive(Debug, Deserialize)]
2052pub struct UpdateImportanceRequest {
2053 pub memory_id: String,
2054 pub importance: f32,
2055 pub agent_id: String,
2056}
2057
2058#[derive(Debug, Deserialize)]
2060pub struct ConsolidateRequest {
2061 pub agent_id: String,
2062 #[serde(default)]
2064 pub memory_ids: Option<Vec<String>>,
2065 #[serde(default = "default_consolidation_threshold")]
2067 pub threshold: f32,
2068 #[serde(default)]
2070 pub target_type: Option<MemoryType>,
2071}
2072
2073fn default_consolidation_threshold() -> f32 {
2074 0.85
2075}
2076
2077#[derive(Debug, Serialize)]
2079pub struct ConsolidateResponse {
2080 pub consolidated_memory: Memory,
2081 pub source_memory_ids: Vec<String>,
2082 pub memories_removed: usize,
2083}
2084
2085#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
2087#[serde(rename_all = "lowercase")]
2088pub enum FeedbackSignal {
2089 Upvote,
2091 Downvote,
2093 Flag,
2095 Positive,
2097 Negative,
2099}
2100
2101#[derive(Debug, Clone, Serialize, Deserialize)]
2103pub struct FeedbackHistoryEntry {
2104 pub signal: FeedbackSignal,
2105 pub timestamp: u64,
2106 pub old_importance: f32,
2107 pub new_importance: f32,
2108}
2109
2110#[derive(Debug, Deserialize)]
2112pub struct FeedbackRequest {
2113 pub agent_id: String,
2114 pub memory_id: String,
2115 pub signal: FeedbackSignal,
2116}
2117
2118#[derive(Debug, Deserialize)]
2120pub struct MemoryFeedbackRequest {
2121 pub agent_id: String,
2122 pub signal: FeedbackSignal,
2123}
2124
2125#[derive(Debug, Serialize)]
2127pub struct FeedbackResponse {
2128 pub memory_id: String,
2129 pub new_importance: f32,
2130 pub signal: FeedbackSignal,
2131}
2132
2133#[derive(Debug, Serialize)]
2135pub struct FeedbackHistoryResponse {
2136 pub memory_id: String,
2137 pub entries: Vec<FeedbackHistoryEntry>,
2138}
2139
2140#[derive(Debug, Serialize)]
2142pub struct AgentFeedbackSummary {
2143 pub agent_id: String,
2144 pub upvotes: u64,
2145 pub downvotes: u64,
2146 pub flags: u64,
2147 pub total_feedback: u64,
2148 pub health_score: f32,
2150}
2151
2152#[derive(Debug, Deserialize)]
2154pub struct MemoryImportancePatchRequest {
2155 pub agent_id: String,
2156 pub importance: f32,
2157}
2158
2159#[derive(Debug, Deserialize)]
2161pub struct FeedbackHealthQuery {
2162 pub agent_id: String,
2163}
2164
2165#[derive(Debug, Serialize)]
2167pub struct FeedbackHealthResponse {
2168 pub agent_id: String,
2169 pub health_score: f32,
2171 pub memory_count: usize,
2172 pub avg_importance: f32,
2173}
2174
2175#[derive(Debug, Deserialize)]
2177pub struct SearchMemoriesRequest {
2178 pub agent_id: String,
2179 #[serde(default)]
2180 pub query: Option<String>,
2181 #[serde(default)]
2182 pub memory_type: Option<MemoryType>,
2183 #[serde(default)]
2184 pub session_id: Option<String>,
2185 #[serde(default)]
2186 pub tags: Option<Vec<String>>,
2187 #[serde(default)]
2188 pub min_importance: Option<f32>,
2189 #[serde(default)]
2190 pub max_importance: Option<f32>,
2191 #[serde(default)]
2192 pub created_after: Option<u64>,
2193 #[serde(default)]
2194 pub created_before: Option<u64>,
2195 #[serde(default = "default_top_k")]
2196 pub top_k: usize,
2197 #[serde(default)]
2198 pub sort_by: Option<MemorySortField>,
2199 #[serde(default)]
2201 pub routing: RoutingMode,
2202 #[serde(default)]
2205 pub rerank: bool,
2206}
2207
2208#[derive(Debug, Clone, Copy, Serialize, Deserialize)]
2210#[serde(rename_all = "snake_case")]
2211pub enum MemorySortField {
2212 CreatedAt,
2213 LastAccessedAt,
2214 Importance,
2215 AccessCount,
2216}
2217
2218#[derive(Debug, Serialize)]
2220pub struct SearchMemoriesResponse {
2221 pub memories: Vec<RecallResult>,
2222 pub total_count: usize,
2223}
2224
2225#[derive(Debug, Deserialize)]
2231pub struct SessionStartRequest {
2232 pub agent_id: String,
2233 #[serde(skip_serializing_if = "Option::is_none")]
2234 pub metadata: Option<serde_json::Value>,
2235 #[serde(skip_serializing_if = "Option::is_none")]
2237 pub id: Option<String>,
2238}
2239
2240#[derive(Debug, Serialize)]
2242pub struct SessionStartResponse {
2243 pub session: Session,
2244}
2245
2246#[derive(Debug, Deserialize)]
2248pub struct SessionEndRequest {
2249 #[serde(default)]
2250 pub summary: Option<String>,
2251 #[serde(default)]
2253 pub auto_summarize: bool,
2254}
2255
2256#[derive(Debug, Serialize)]
2258pub struct SessionEndResponse {
2259 pub session: Session,
2260 pub memory_count: usize,
2261}
2262
2263#[derive(Debug, Serialize)]
2265pub struct ListSessionsResponse {
2266 pub sessions: Vec<Session>,
2267 pub total: usize,
2268}
2269
2270#[derive(Debug, Serialize)]
2272pub struct SessionMemoriesResponse {
2273 pub session: Session,
2274 pub memories: Vec<Memory>,
2275 #[serde(skip_serializing_if = "Option::is_none")]
2277 pub total: Option<usize>,
2278}
2279
2280#[derive(Debug, Serialize, Deserialize, Clone)]
2286pub struct AgentSummary {
2287 pub agent_id: String,
2288 pub memory_count: usize,
2289 pub session_count: usize,
2290 pub active_sessions: usize,
2291}
2292
2293#[derive(Debug, Serialize)]
2295pub struct AgentStats {
2296 pub agent_id: String,
2297 pub total_memories: usize,
2298 pub memories_by_type: std::collections::HashMap<String, usize>,
2299 pub total_sessions: usize,
2300 pub active_sessions: usize,
2301 pub avg_importance: f32,
2302 pub oldest_memory_at: Option<u64>,
2303 pub newest_memory_at: Option<u64>,
2304}
2305
2306#[derive(Debug, Serialize)]
2312pub struct WakeUpResponse {
2313 pub agent_id: String,
2314 pub memories: Vec<Memory>,
2316 pub total_available: usize,
2318}
2319
2320#[derive(Debug, Deserialize)]
2322pub struct KnowledgeGraphRequest {
2323 pub agent_id: String,
2324 pub memory_id: String,
2325 #[serde(default = "default_graph_depth")]
2326 pub depth: usize,
2327 #[serde(default = "default_graph_min_similarity")]
2328 pub min_similarity: f32,
2329}
2330
2331fn default_graph_depth() -> usize {
2332 2
2333}
2334
2335fn default_graph_min_similarity() -> f32 {
2336 0.7
2337}
2338
2339#[derive(Debug, Serialize)]
2341pub struct KnowledgeGraphNode {
2342 pub memory: Memory,
2343 pub similarity: f32,
2344 pub related: Vec<KnowledgeGraphEdge>,
2345}
2346
2347#[derive(Debug, Serialize)]
2349pub struct KnowledgeGraphEdge {
2350 pub memory_id: String,
2351 pub similarity: f32,
2352 pub shared_tags: Vec<String>,
2353}
2354
2355#[derive(Debug, Serialize)]
2357pub struct KnowledgeGraphResponse {
2358 pub root: KnowledgeGraphNode,
2359 pub total_nodes: usize,
2360}
2361
2362fn default_full_graph_max_nodes() -> usize {
2367 200
2368}
2369
2370fn default_full_graph_min_similarity() -> f32 {
2371 0.50
2372}
2373
2374fn default_full_graph_cluster_threshold() -> f32 {
2375 0.60
2376}
2377
2378fn default_full_graph_max_edges_per_node() -> usize {
2379 8
2380}
2381
2382#[derive(Debug, Deserialize)]
2384pub struct FullKnowledgeGraphRequest {
2385 pub agent_id: String,
2386 #[serde(default = "default_full_graph_max_nodes")]
2387 pub max_nodes: usize,
2388 #[serde(default = "default_full_graph_min_similarity")]
2389 pub min_similarity: f32,
2390 #[serde(default = "default_full_graph_cluster_threshold")]
2391 pub cluster_threshold: f32,
2392 #[serde(default = "default_full_graph_max_edges_per_node")]
2393 pub max_edges_per_node: usize,
2394}
2395
2396#[derive(Debug, Serialize)]
2398pub struct FullGraphNode {
2399 pub id: String,
2400 pub content: String,
2401 pub memory_type: String,
2402 pub importance: f32,
2403 pub tags: Vec<String>,
2404 pub created_at: Option<String>,
2405 pub cluster_id: usize,
2406 pub centrality: f32,
2407}
2408
2409#[derive(Debug, Serialize)]
2411pub struct FullGraphEdge {
2412 pub source: String,
2413 pub target: String,
2414 pub similarity: f32,
2415 pub shared_tags: Vec<String>,
2416}
2417
2418#[derive(Debug, Serialize)]
2420pub struct GraphCluster {
2421 pub id: usize,
2422 pub node_count: usize,
2423 pub top_tags: Vec<String>,
2424 pub avg_importance: f32,
2425}
2426
2427#[derive(Debug, Serialize)]
2429pub struct GraphStats {
2430 pub total_memories: usize,
2431 pub included_memories: usize,
2432 pub total_edges: usize,
2433 pub cluster_count: usize,
2434 pub density: f32,
2435 pub hub_memory_id: Option<String>,
2436}
2437
2438#[derive(Debug, Serialize)]
2440pub struct FullKnowledgeGraphResponse {
2441 pub nodes: Vec<FullGraphNode>,
2442 pub edges: Vec<FullGraphEdge>,
2443 pub clusters: Vec<GraphCluster>,
2444 pub stats: GraphStats,
2445}
2446
2447#[derive(Debug, Deserialize)]
2449pub struct SummarizeRequest {
2450 pub agent_id: String,
2451 pub memory_ids: Vec<String>,
2452 #[serde(default)]
2453 pub target_type: Option<MemoryType>,
2454}
2455
2456#[derive(Debug, Serialize)]
2458pub struct SummarizeResponse {
2459 pub summary_memory: Memory,
2460 pub source_count: usize,
2461}
2462
2463#[derive(Debug, Deserialize)]
2465pub struct DeduplicateRequest {
2466 pub agent_id: String,
2467 #[serde(default = "default_dedup_threshold")]
2468 pub threshold: f32,
2469 #[serde(default)]
2470 pub memory_type: Option<MemoryType>,
2471 #[serde(default)]
2473 pub dry_run: bool,
2474}
2475
2476fn default_dedup_threshold() -> f32 {
2477 0.92
2478}
2479
2480#[derive(Debug, Serialize)]
2482pub struct DuplicateGroup {
2483 pub canonical_id: String,
2484 pub duplicate_ids: Vec<String>,
2485 pub avg_similarity: f32,
2486}
2487
2488#[derive(Debug, Serialize)]
2490pub struct DeduplicateResponse {
2491 pub groups: Vec<DuplicateGroup>,
2492 pub duplicates_found: usize,
2493 pub duplicates_merged: usize,
2494}
2495
2496fn default_cross_agent_min_similarity() -> f32 {
2501 0.3
2502}
2503
2504fn default_cross_agent_max_nodes_per_agent() -> usize {
2505 50
2506}
2507
2508fn default_cross_agent_max_cross_edges() -> usize {
2509 200
2510}
2511
2512#[derive(Debug, Deserialize)]
2514pub struct CrossAgentNetworkRequest {
2515 #[serde(default)]
2517 pub agent_ids: Option<Vec<String>>,
2518 #[serde(default = "default_cross_agent_min_similarity")]
2520 pub min_similarity: f32,
2521 #[serde(default = "default_cross_agent_max_nodes_per_agent")]
2523 pub max_nodes_per_agent: usize,
2524 #[serde(default)]
2526 pub min_importance: f32,
2527 #[serde(default = "default_cross_agent_max_cross_edges")]
2529 pub max_cross_edges: usize,
2530}
2531
2532#[derive(Debug, Serialize)]
2534pub struct AgentNetworkInfo {
2535 pub agent_id: String,
2536 pub memory_count: usize,
2537 pub avg_importance: f32,
2538}
2539
2540#[derive(Debug, Serialize)]
2542pub struct AgentNetworkNode {
2543 pub id: String,
2544 pub agent_id: String,
2545 pub content: String,
2546 pub importance: f32,
2547 pub tags: Vec<String>,
2548 pub memory_type: String,
2549 pub created_at: u64,
2550}
2551
2552#[derive(Debug, Serialize)]
2554pub struct AgentNetworkEdge {
2555 pub source: String,
2556 pub target: String,
2557 pub source_agent: String,
2558 pub target_agent: String,
2559 pub similarity: f32,
2560}
2561
2562#[derive(Debug, Serialize)]
2564pub struct AgentNetworkStats {
2565 pub total_agents: usize,
2566 pub total_nodes: usize,
2567 pub total_cross_edges: usize,
2568 pub density: f32,
2569}
2570
2571#[derive(Debug, Serialize)]
2573pub struct CrossAgentNetworkResponse {
2574 pub node_count: usize,
2575 pub agents: Vec<AgentNetworkInfo>,
2576 pub nodes: Vec<AgentNetworkNode>,
2577 pub edges: Vec<AgentNetworkEdge>,
2578 pub stats: AgentNetworkStats,
2579}
2580
2581#[derive(Debug, Deserialize, Default)]
2589pub struct BatchMemoryFilter {
2590 #[serde(default)]
2592 pub tags: Option<Vec<String>>,
2593 #[serde(default)]
2595 pub min_importance: Option<f32>,
2596 #[serde(default)]
2598 pub max_importance: Option<f32>,
2599 #[serde(default)]
2601 pub created_after: Option<u64>,
2602 #[serde(default)]
2604 pub created_before: Option<u64>,
2605 #[serde(default)]
2607 pub memory_type: Option<MemoryType>,
2608 #[serde(default)]
2610 pub session_id: Option<String>,
2611}
2612
2613impl BatchMemoryFilter {
2614 pub fn has_any(&self) -> bool {
2616 self.tags.is_some()
2617 || self.min_importance.is_some()
2618 || self.max_importance.is_some()
2619 || self.created_after.is_some()
2620 || self.created_before.is_some()
2621 || self.memory_type.is_some()
2622 || self.session_id.is_some()
2623 }
2624
2625 pub fn matches(&self, memory: &Memory) -> bool {
2627 if let Some(ref tags) = self.tags {
2628 if !tags.is_empty() && !tags.iter().all(|t| memory.tags.contains(t)) {
2629 return false;
2630 }
2631 }
2632 if let Some(min) = self.min_importance {
2633 if memory.importance < min {
2634 return false;
2635 }
2636 }
2637 if let Some(max) = self.max_importance {
2638 if memory.importance > max {
2639 return false;
2640 }
2641 }
2642 if let Some(after) = self.created_after {
2643 if memory.created_at < after {
2644 return false;
2645 }
2646 }
2647 if let Some(before) = self.created_before {
2648 if memory.created_at > before {
2649 return false;
2650 }
2651 }
2652 if let Some(ref mt) = self.memory_type {
2653 if memory.memory_type != *mt {
2654 return false;
2655 }
2656 }
2657 if let Some(ref sid) = self.session_id {
2658 if memory.session_id.as_ref() != Some(sid) {
2659 return false;
2660 }
2661 }
2662 true
2663 }
2664}
2665
2666#[derive(Debug, Deserialize)]
2668pub struct BatchRecallRequest {
2669 pub agent_id: String,
2671 #[serde(default)]
2673 pub filter: BatchMemoryFilter,
2674 #[serde(default = "default_batch_limit")]
2676 pub limit: usize,
2677}
2678
2679fn default_batch_limit() -> usize {
2680 100
2681}
2682
2683#[derive(Debug, Serialize)]
2685pub struct BatchRecallResponse {
2686 pub memories: Vec<Memory>,
2687 pub total: usize,
2688 pub filtered: usize,
2689}
2690
2691#[derive(Debug, Deserialize)]
2693pub struct BatchForgetRequest {
2694 pub agent_id: String,
2696 pub filter: BatchMemoryFilter,
2698}
2699
2700#[derive(Debug, Serialize)]
2702pub struct BatchForgetResponse {
2703 pub deleted_count: usize,
2704}
2705
2706#[derive(Debug, Deserialize)]
2713pub struct NamespaceEntityConfigRequest {
2714 pub extract_entities: bool,
2716 #[serde(default)]
2719 pub entity_types: Vec<String>,
2720}
2721
2722#[derive(Debug, Serialize, Deserialize)]
2724pub struct NamespaceEntityConfigResponse {
2725 pub namespace: String,
2726 pub extract_entities: bool,
2727 pub entity_types: Vec<String>,
2728}
2729
2730#[derive(Debug, Deserialize)]
2733pub struct ExtractEntitiesRequest {
2734 pub content: String,
2736 #[serde(default)]
2739 pub entity_types: Vec<String>,
2740}
2741
2742#[derive(Debug, Clone, Serialize, Deserialize)]
2744pub struct EntityResult {
2745 pub entity_type: String,
2746 pub value: String,
2747 pub score: f32,
2748 pub start: usize,
2749 pub end: usize,
2750 pub tag: String,
2752}
2753
2754#[derive(Debug, Serialize)]
2756pub struct ExtractEntitiesResponse {
2757 pub entities: Vec<EntityResult>,
2758 pub count: usize,
2759}
2760
2761#[derive(Debug, Deserialize)]
2767pub struct GraphTraverseQuery {
2768 #[serde(default = "default_ce5_graph_depth")]
2770 pub depth: u32,
2771}
2772
2773fn default_ce5_graph_depth() -> u32 {
2774 3
2775}
2776
2777#[derive(Debug, Deserialize)]
2779pub struct GraphPathQuery {
2780 pub to: String,
2782}
2783
2784#[derive(Debug, Deserialize)]
2786pub struct MemoryLinkRequest {
2787 pub target_id: String,
2789 #[serde(skip_serializing_if = "Option::is_none")]
2791 pub label: Option<String>,
2792 pub agent_id: String,
2794}
2795
2796#[derive(Debug, Serialize)]
2798pub struct GraphTraverseResponse {
2799 pub root_id: String,
2800 pub depth: u32,
2801 pub node_count: usize,
2802 pub nodes: Vec<GraphNodeResponse>,
2803}
2804
2805#[derive(Debug, Serialize)]
2807pub struct GraphNodeResponse {
2808 pub memory_id: String,
2809 pub depth: u32,
2810 pub edges: Vec<GraphEdgeResponse>,
2811}
2812
2813#[derive(Debug, Serialize)]
2815pub struct GraphEdgeResponse {
2816 pub from_id: String,
2817 pub to_id: String,
2818 pub edge_type: String,
2819 pub weight: f32,
2820 pub created_at: u64,
2821}
2822
2823#[derive(Debug, Serialize)]
2825pub struct GraphPathResponse {
2826 pub from_id: String,
2827 pub to_id: String,
2828 pub path: Vec<String>,
2830 pub hop_count: usize,
2831}
2832
2833#[derive(Debug, Serialize)]
2835pub struct MemoryLinkResponse {
2836 pub from_id: String,
2837 pub to_id: String,
2838 pub edge_type: String,
2839}
2840
2841#[derive(Debug, Serialize)]
2843pub struct GraphExportResponse {
2844 pub agent_id: String,
2845 pub namespace: String,
2846 pub node_count: usize,
2847 pub edge_count: usize,
2848 pub edges: Vec<GraphEdgeResponse>,
2849}
2850
2851#[derive(Debug, Deserialize)]
2857pub struct KgQueryParams {
2858 pub agent_id: String,
2860 #[serde(default)]
2862 pub root_id: Option<String>,
2863 #[serde(default)]
2865 pub edge_type: Option<String>,
2866 #[serde(default)]
2868 pub min_weight: Option<f32>,
2869 #[serde(default = "default_kg_depth")]
2871 pub max_depth: u32,
2872 #[serde(default = "default_kg_limit")]
2874 pub limit: usize,
2875}
2876
2877fn default_kg_depth() -> u32 {
2878 3
2879}
2880
2881fn default_kg_limit() -> usize {
2882 100
2883}
2884
2885#[derive(Debug, Serialize)]
2887pub struct KgQueryResponse {
2888 pub agent_id: String,
2889 pub node_count: usize,
2890 pub edge_count: usize,
2891 pub edges: Vec<GraphEdgeResponse>,
2892}
2893
2894#[derive(Debug, Deserialize)]
2896pub struct KgPathParams {
2897 pub agent_id: String,
2899 pub from: String,
2901 pub to: String,
2903}
2904
2905#[derive(Debug, Serialize)]
2907pub struct KgPathResponse {
2908 pub agent_id: String,
2909 pub from_id: String,
2910 pub to_id: String,
2911 pub hop_count: usize,
2912 pub path: Vec<String>,
2913}
2914
2915#[derive(Debug, Deserialize)]
2917pub struct KgExportParams {
2918 pub agent_id: String,
2920 #[serde(default = "default_kg_format")]
2922 pub format: String,
2923}
2924
2925fn default_kg_format() -> String {
2926 "json".to_string()
2927}
2928
2929#[derive(Debug, Serialize)]
2931pub struct KgExportJsonResponse {
2932 pub agent_id: String,
2933 pub format: String,
2934 pub node_count: usize,
2935 pub edge_count: usize,
2936 pub edges: Vec<GraphEdgeResponse>,
2937}
2938
2939fn default_working_ttl() -> Option<u64> {
2944 Some(14_400) }
2946fn default_episodic_ttl() -> Option<u64> {
2947 Some(2_592_000) }
2949fn default_semantic_ttl() -> Option<u64> {
2950 Some(31_536_000) }
2952fn default_procedural_ttl() -> Option<u64> {
2953 Some(63_072_000) }
2955fn default_working_decay() -> DecayStrategy {
2956 DecayStrategy::Exponential
2957}
2958fn default_episodic_decay() -> DecayStrategy {
2959 DecayStrategy::PowerLaw
2960}
2961fn default_semantic_decay() -> DecayStrategy {
2962 DecayStrategy::Logarithmic
2963}
2964fn default_procedural_decay() -> DecayStrategy {
2965 DecayStrategy::Flat
2966}
2967fn default_sr_factor() -> f64 {
2968 1.0
2969}
2970fn default_sr_base_interval() -> u64 {
2971 86_400 }
2973fn default_consolidation_enabled() -> bool {
2974 false
2975}
2976fn default_policy_consolidation_threshold() -> f32 {
2977 0.92
2978}
2979fn default_consolidation_interval_hours() -> u32 {
2980 24
2981}
2982fn default_store_dedup_threshold() -> f32 {
2983 0.95
2984}
2985
2986#[derive(Debug, Clone, Serialize, Deserialize)]
2991pub struct MemoryPolicy {
2992 #[serde(
2995 default = "default_working_ttl",
2996 skip_serializing_if = "Option::is_none"
2997 )]
2998 pub working_ttl_seconds: Option<u64>,
2999 #[serde(
3001 default = "default_episodic_ttl",
3002 skip_serializing_if = "Option::is_none"
3003 )]
3004 pub episodic_ttl_seconds: Option<u64>,
3005 #[serde(
3007 default = "default_semantic_ttl",
3008 skip_serializing_if = "Option::is_none"
3009 )]
3010 pub semantic_ttl_seconds: Option<u64>,
3011 #[serde(
3013 default = "default_procedural_ttl",
3014 skip_serializing_if = "Option::is_none"
3015 )]
3016 pub procedural_ttl_seconds: Option<u64>,
3017
3018 #[serde(default = "default_working_decay")]
3021 pub working_decay: DecayStrategy,
3022 #[serde(default = "default_episodic_decay")]
3024 pub episodic_decay: DecayStrategy,
3025 #[serde(default = "default_semantic_decay")]
3027 pub semantic_decay: DecayStrategy,
3028 #[serde(default = "default_procedural_decay")]
3030 pub procedural_decay: DecayStrategy,
3031
3032 #[serde(default = "default_sr_factor")]
3037 pub spaced_repetition_factor: f64,
3038 #[serde(default = "default_sr_base_interval")]
3040 pub spaced_repetition_base_interval_seconds: u64,
3041
3042 #[serde(default = "default_consolidation_enabled")]
3045 pub consolidation_enabled: bool,
3046 #[serde(default = "default_policy_consolidation_threshold")]
3048 pub consolidation_threshold: f32,
3049 #[serde(default = "default_consolidation_interval_hours")]
3051 pub consolidation_interval_hours: u32,
3052 #[serde(default)]
3054 pub consolidated_count: u64,
3055
3056 #[serde(default)]
3060 pub rate_limit_enabled: bool,
3061 #[serde(default, skip_serializing_if = "Option::is_none")]
3064 pub rate_limit_stores_per_minute: Option<u32>,
3065 #[serde(default, skip_serializing_if = "Option::is_none")]
3068 pub rate_limit_recalls_per_minute: Option<u32>,
3069
3070 #[serde(default)]
3078 pub dedup_on_store: bool,
3079 #[serde(default = "default_store_dedup_threshold")]
3081 pub dedup_threshold: f32,
3082}
3083
3084impl Default for MemoryPolicy {
3085 fn default() -> Self {
3086 Self {
3087 working_ttl_seconds: default_working_ttl(),
3088 episodic_ttl_seconds: default_episodic_ttl(),
3089 semantic_ttl_seconds: default_semantic_ttl(),
3090 procedural_ttl_seconds: default_procedural_ttl(),
3091 working_decay: default_working_decay(),
3092 episodic_decay: default_episodic_decay(),
3093 semantic_decay: default_semantic_decay(),
3094 procedural_decay: default_procedural_decay(),
3095 spaced_repetition_factor: default_sr_factor(),
3096 spaced_repetition_base_interval_seconds: default_sr_base_interval(),
3097 consolidation_enabled: default_consolidation_enabled(),
3098 consolidation_threshold: default_policy_consolidation_threshold(),
3099 consolidation_interval_hours: default_consolidation_interval_hours(),
3100 consolidated_count: 0,
3101 rate_limit_enabled: false,
3102 rate_limit_stores_per_minute: None,
3103 rate_limit_recalls_per_minute: None,
3104 dedup_on_store: false,
3105 dedup_threshold: default_store_dedup_threshold(),
3106 }
3107 }
3108}
3109
3110impl MemoryPolicy {
3111 pub fn ttl_for_type(&self, memory_type: &MemoryType) -> Option<u64> {
3113 match memory_type {
3114 MemoryType::Working => self.working_ttl_seconds,
3115 MemoryType::Episodic => self.episodic_ttl_seconds,
3116 MemoryType::Semantic => self.semantic_ttl_seconds,
3117 MemoryType::Procedural => self.procedural_ttl_seconds,
3118 }
3119 }
3120
3121 pub fn decay_for_type(&self, memory_type: &MemoryType) -> DecayStrategy {
3123 match memory_type {
3124 MemoryType::Working => self.working_decay,
3125 MemoryType::Episodic => self.episodic_decay,
3126 MemoryType::Semantic => self.semantic_decay,
3127 MemoryType::Procedural => self.procedural_decay,
3128 }
3129 }
3130
3131 pub fn spaced_repetition_extension(&self, access_count: u32) -> u64 {
3135 if self.spaced_repetition_factor <= 0.0 {
3136 return 0;
3137 }
3138 let ext = access_count as f64
3139 * self.spaced_repetition_factor
3140 * self.spaced_repetition_base_interval_seconds as f64;
3141 ext.round() as u64
3142 }
3143}