synaptic-store 0.4.0

Key-value storage for Synaptic agents: Store trait and InMemoryStore
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
use std::collections::HashMap;
use std::sync::Arc;

use async_trait::async_trait;
use serde_json::Value;
use tokio::sync::RwLock;

// Re-export Store trait and Item from core
pub use synaptic_core::{now_iso, Embeddings, Item, Store, SynapticError};

fn namespace_key(namespace: &[&str]) -> String {
    namespace.join("::")
}

/// BM25 scoring for a single query against a document.
fn bm25_score(query: &str, document: &str, avg_doc_len: f64, total_docs: usize) -> f64 {
    let k1 = 1.2;
    let b = 0.75;
    let query_terms: Vec<&str> = query.split_whitespace().collect();
    let doc_terms: Vec<&str> = document.split_whitespace().collect();
    let doc_len = doc_terms.len() as f64;

    let mut score = 0.0;
    for qt in &query_terms {
        let qt_lower = qt.to_lowercase();
        let tf = doc_terms
            .iter()
            .filter(|dt| dt.to_lowercase() == qt_lower)
            .count() as f64;
        if tf == 0.0 {
            continue;
        }
        let idf = ((total_docs as f64 - 1.0 + 0.5) / (1.0 + 0.5) + 1.0).ln();
        let numerator = tf * (k1 + 1.0);
        let denominator = tf + k1 * (1.0 - b + b * doc_len / avg_doc_len.max(1.0));
        score += idf * numerator / denominator;
    }
    score
}

/// Cosine similarity between two vectors.
fn cosine_similarity(a: &[f32], b: &[f32]) -> f64 {
    if a.len() != b.len() || a.is_empty() {
        return 0.0;
    }
    let mut dot = 0.0f64;
    let mut norm_a = 0.0f64;
    let mut norm_b = 0.0f64;
    for (x, y) in a.iter().zip(b.iter()) {
        let x = *x as f64;
        let y = *y as f64;
        dot += x * y;
        norm_a += x * x;
        norm_b += y * y;
    }
    let denom = norm_a.sqrt() * norm_b.sqrt();
    if denom == 0.0 {
        0.0
    } else {
        dot / denom
    }
}

/// Thread-safe in-memory implementation of `Store`.
///
/// Supports optional embedding-based semantic search via [`with_embeddings`](InMemoryStore::with_embeddings).
pub struct InMemoryStore {
    data: Arc<RwLock<HashMap<String, HashMap<String, Item>>>>,
    /// Optional embeddings model for semantic search.
    embeddings: Option<Arc<dyn Embeddings>>,
    /// Pre-computed embedding vectors, keyed by `namespace_key::item_key`.
    vectors: Arc<RwLock<HashMap<String, Vec<f32>>>>,
    /// When true, search uses hybrid BM25 + embedding via Reciprocal Rank Fusion.
    hybrid: bool,
}

impl Default for InMemoryStore {
    fn default() -> Self {
        Self {
            data: Arc::new(RwLock::new(HashMap::new())),
            embeddings: None,
            vectors: Arc::new(RwLock::new(HashMap::new())),
            hybrid: false,
        }
    }
}

impl InMemoryStore {
    pub fn new() -> Self {
        Self::default()
    }

    /// Enable embedding-based semantic search.
    ///
    /// When configured, [`Store::search()`] with a query will use embedding
    /// similarity instead of substring matching. Items are ranked by cosine
    /// similarity and `Item::score` is populated.
    pub fn with_embeddings(mut self, embeddings: Arc<dyn Embeddings>) -> Self {
        self.embeddings = Some(embeddings);
        self
    }

    /// Enable hybrid search combining BM25 text scoring and embedding similarity
    /// via Reciprocal Rank Fusion (RRF).
    ///
    /// When configured, [`Store::search()`] with a query will:
    /// 1. Compute cosine similarity scores using embeddings
    /// 2. Compute BM25 text relevance scores
    /// 3. Fuse rankings via RRF: `score = 1/(60+embed_rank) + 1/(60+bm25_rank)`
    pub fn with_hybrid_search(mut self, embeddings: Arc<dyn Embeddings>) -> Self {
        self.embeddings = Some(embeddings);
        self.hybrid = true;
        self
    }
}

#[async_trait]
impl Store for InMemoryStore {
    async fn get(&self, namespace: &[&str], key: &str) -> Result<Option<Item>, SynapticError> {
        let data = self.data.read().await;
        let ns_key = namespace_key(namespace);
        Ok(data.get(&ns_key).and_then(|ns| ns.get(key).cloned()))
    }

    async fn search(
        &self,
        namespace: &[&str],
        query: Option<&str>,
        limit: usize,
    ) -> Result<Vec<Item>, SynapticError> {
        let data = self.data.read().await;
        let ns_key = namespace_key(namespace);

        let Some(ns) = data.get(&ns_key) else {
            return Ok(vec![]);
        };

        // Hybrid search: BM25 + embedding similarity fused via RRF
        if self.hybrid {
            if let (Some(ref embeddings), Some(q)) = (&self.embeddings, query) {
                let query_vec = embeddings.embed_query(q).await?;
                let vectors = self.vectors.read().await;

                // Compute embedding scores
                let mut embed_scored: Vec<(&String, f64)> = ns
                    .keys()
                    .map(|key| {
                        let vec_key = format!("{}::{}", ns_key, key);
                        let score = vectors
                            .get(&vec_key)
                            .map(|v| cosine_similarity(v, &query_vec))
                            .unwrap_or(0.0);
                        (key, score)
                    })
                    .collect();
                embed_scored
                    .sort_by(|a, b| b.1.partial_cmp(&a.1).unwrap_or(std::cmp::Ordering::Equal));

                // Build embed rank map (rank 0 = best)
                let embed_rank: HashMap<&String, usize> = embed_scored
                    .iter()
                    .enumerate()
                    .map(|(rank, (key, _))| (*key, rank))
                    .collect();

                // Compute BM25 scores
                let total_docs = ns.len();
                let avg_doc_len = if total_docs > 0 {
                    ns.values()
                        .map(|item| {
                            let text = item
                                .value
                                .as_str()
                                .unwrap_or(&item.value.to_string())
                                .to_string();
                            text.split_whitespace().count() as f64
                        })
                        .sum::<f64>()
                        / total_docs as f64
                } else {
                    1.0
                };

                let mut bm25_scored: Vec<(&String, f64)> = ns
                    .iter()
                    .map(|(key, item)| {
                        let text = item
                            .value
                            .as_str()
                            .unwrap_or(&item.value.to_string())
                            .to_string();
                        let score = bm25_score(q, &text, avg_doc_len, total_docs);
                        (key, score)
                    })
                    .collect();
                bm25_scored
                    .sort_by(|a, b| b.1.partial_cmp(&a.1).unwrap_or(std::cmp::Ordering::Equal));

                // Build BM25 rank map
                let bm25_rank: HashMap<&String, usize> = bm25_scored
                    .iter()
                    .enumerate()
                    .map(|(rank, (key, _))| (*key, rank))
                    .collect();

                // Reciprocal Rank Fusion
                let k = 60.0;
                let mut fused: Vec<(Item, f64)> = ns
                    .iter()
                    .map(|(key, item)| {
                        let e_rank = embed_rank.get(key).copied().unwrap_or(ns.len()) as f64;
                        let b_rank = bm25_rank.get(key).copied().unwrap_or(ns.len()) as f64;
                        let fused_score = 1.0 / (k + e_rank) + 1.0 / (k + b_rank);
                        let mut item = item.clone();
                        item.score = Some(fused_score);
                        (item, fused_score)
                    })
                    .collect();

                fused.sort_by(|a, b| b.1.partial_cmp(&a.1).unwrap_or(std::cmp::Ordering::Equal));
                fused.truncate(limit);

                return Ok(fused.into_iter().map(|(item, _)| item).collect());
            }
        }

        // If embeddings are configured (non-hybrid) and a query is provided, use semantic search
        if let (Some(ref embeddings), Some(q)) = (&self.embeddings, query) {
            let query_vec = embeddings.embed_query(q).await?;
            let vectors = self.vectors.read().await;

            let mut scored: Vec<(Item, f64)> = ns
                .iter()
                .map(|(key, item)| {
                    let vec_key = format!("{}::{}", ns_key, key);
                    let score = vectors
                        .get(&vec_key)
                        .map(|v| cosine_similarity(v, &query_vec))
                        .unwrap_or(0.0);
                    let mut item = item.clone();
                    item.score = Some(score);
                    (item, score)
                })
                .collect();

            // Sort by score descending
            scored.sort_by(|a, b| b.1.partial_cmp(&a.1).unwrap_or(std::cmp::Ordering::Equal));
            scored.truncate(limit);

            return Ok(scored.into_iter().map(|(item, _)| item).collect());
        }

        // Fallback: substring search
        let items: Vec<Item> = ns
            .values()
            .filter(|item| {
                if let Some(q) = query {
                    // Simple substring search in key and value
                    item.key.contains(q) || item.value.to_string().contains(q)
                } else {
                    true
                }
            })
            .take(limit)
            .cloned()
            .collect();

        Ok(items)
    }

    async fn put(&self, namespace: &[&str], key: &str, value: Value) -> Result<(), SynapticError> {
        let mut data = self.data.write().await;
        let ns_key = namespace_key(namespace);
        let ns = data.entry(ns_key.clone()).or_default();
        let now = now_iso();

        let item = if let Some(existing) = ns.get(key) {
            Item {
                namespace: namespace.iter().map(|s| s.to_string()).collect(),
                key: key.to_string(),
                value: value.clone(),
                created_at: existing.created_at.clone(),
                updated_at: now,
                score: None,
            }
        } else {
            Item {
                namespace: namespace.iter().map(|s| s.to_string()).collect(),
                key: key.to_string(),
                value: value.clone(),
                created_at: now.clone(),
                updated_at: now,
                score: None,
            }
        };

        ns.insert(key.to_string(), item);

        // If embeddings are configured, compute and store the embedding
        if let Some(ref embeddings) = self.embeddings {
            let text = value.as_str().unwrap_or(&value.to_string()).to_string();
            let vecs = embeddings.embed_documents(&[&text]).await?;
            if let Some(vec) = vecs.into_iter().next() {
                let vec_key = format!("{}::{}", ns_key, key);
                self.vectors.write().await.insert(vec_key, vec);
            }
        }

        Ok(())
    }

    async fn delete(&self, namespace: &[&str], key: &str) -> Result<(), SynapticError> {
        let mut data = self.data.write().await;
        let ns_key = namespace_key(namespace);
        if let Some(ns) = data.get_mut(&ns_key) {
            ns.remove(key);
        }
        // Clean up embedding vector
        let vec_key = format!("{}::{}", ns_key, key);
        self.vectors.write().await.remove(&vec_key);
        Ok(())
    }

    async fn list_namespaces(&self, prefix: &[&str]) -> Result<Vec<Vec<String>>, SynapticError> {
        let data = self.data.read().await;
        let prefix_str = if prefix.is_empty() {
            String::new()
        } else {
            namespace_key(prefix)
        };

        let namespaces: Vec<Vec<String>> = data
            .keys()
            .filter(|k| prefix.is_empty() || k.starts_with(&prefix_str))
            .map(|k| k.split("::").map(String::from).collect())
            .collect();

        Ok(namespaces)
    }
}

#[cfg(feature = "filesystem")]
mod file_store;
#[cfg(feature = "filesystem")]
pub use file_store::FileStore;

#[cfg(test)]
mod tests {
    use super::*;
    use serde_json::json;

    #[tokio::test]
    async fn put_and_get() {
        let store = InMemoryStore::new();
        store
            .put(&["users", "prefs"], "theme", json!("dark"))
            .await
            .unwrap();

        let item = store
            .get(&["users", "prefs"], "theme")
            .await
            .unwrap()
            .unwrap();
        assert_eq!(item.key, "theme");
        assert_eq!(item.value, json!("dark"));
        assert_eq!(item.namespace, vec!["users", "prefs"]);
    }

    #[tokio::test]
    async fn get_nonexistent() {
        let store = InMemoryStore::new();
        let item = store.get(&["a"], "missing").await.unwrap();
        assert!(item.is_none());
    }

    #[tokio::test]
    async fn delete_item() {
        let store = InMemoryStore::new();
        store.put(&["ns"], "k", json!(1)).await.unwrap();
        store.delete(&["ns"], "k").await.unwrap();
        assert!(store.get(&["ns"], "k").await.unwrap().is_none());
    }

    #[tokio::test]
    async fn search_items() {
        let store = InMemoryStore::new();
        store.put(&["ns"], "a", json!("apple")).await.unwrap();
        store.put(&["ns"], "b", json!("banana")).await.unwrap();
        store.put(&["ns"], "c", json!("cherry")).await.unwrap();

        let all = store.search(&["ns"], None, 10).await.unwrap();
        assert_eq!(all.len(), 3);

        let filtered = store.search(&["ns"], Some("apple"), 10).await.unwrap();
        assert_eq!(filtered.len(), 1);
    }

    #[tokio::test]
    async fn list_namespaces_with_prefix() {
        let store = InMemoryStore::new();
        store.put(&["a", "b"], "k1", json!(1)).await.unwrap();
        store.put(&["a", "c"], "k2", json!(2)).await.unwrap();
        store.put(&["x", "y"], "k3", json!(3)).await.unwrap();

        let all = store.list_namespaces(&[]).await.unwrap();
        assert_eq!(all.len(), 3);

        let filtered = store.list_namespaces(&["a"]).await.unwrap();
        assert_eq!(filtered.len(), 2);
    }

    #[tokio::test]
    async fn upsert_preserves_created_at() {
        let store = InMemoryStore::new();
        store.put(&["ns"], "k", json!(1)).await.unwrap();
        let first = store.get(&["ns"], "k").await.unwrap().unwrap();

        store.put(&["ns"], "k", json!(2)).await.unwrap();
        let second = store.get(&["ns"], "k").await.unwrap().unwrap();

        assert_eq!(first.created_at, second.created_at);
        assert_eq!(second.value, json!(2));
    }

    /// Simple deterministic embeddings for testing semantic search.
    struct TestEmbeddings;

    #[async_trait]
    impl Embeddings for TestEmbeddings {
        async fn embed_documents(&self, texts: &[&str]) -> Result<Vec<Vec<f32>>, SynapticError> {
            Ok(texts.iter().map(|t| text_to_vec(t)).collect())
        }

        async fn embed_query(&self, text: &str) -> Result<Vec<f32>, SynapticError> {
            Ok(text_to_vec(text))
        }
    }

    /// Simple deterministic vector: sum of byte values in 4 dimensions.
    fn text_to_vec(text: &str) -> Vec<f32> {
        let bytes = text.as_bytes();
        let mut v = vec![0.0f32; 4];
        for (i, b) in bytes.iter().enumerate() {
            v[i % 4] += *b as f32;
        }
        v
    }

    #[tokio::test]
    async fn semantic_search_ranked_by_similarity() {
        let store = InMemoryStore::new().with_embeddings(Arc::new(TestEmbeddings));

        store
            .put(&["docs"], "a", json!("rust programming"))
            .await
            .unwrap();
        store
            .put(&["docs"], "b", json!("python programming"))
            .await
            .unwrap();
        store
            .put(&["docs"], "c", json!("cooking recipes"))
            .await
            .unwrap();

        // Search for "rust" — should rank "rust programming" highest
        let results = store.search(&["docs"], Some("rust"), 10).await.unwrap();
        assert_eq!(results.len(), 3);

        // All should have scores populated
        for item in &results {
            assert!(item.score.is_some());
        }

        // Scores should be descending
        let scores: Vec<f64> = results.iter().map(|i| i.score.unwrap()).collect();
        for w in scores.windows(2) {
            assert!(w[0] >= w[1], "scores not sorted: {:?}", scores);
        }
    }

    #[tokio::test]
    async fn semantic_search_respects_limit() {
        let store = InMemoryStore::new().with_embeddings(Arc::new(TestEmbeddings));

        for i in 0..5 {
            store
                .put(&["ns"], &format!("k{}", i), json!(format!("item {}", i)))
                .await
                .unwrap();
        }

        let results = store.search(&["ns"], Some("item"), 2).await.unwrap();
        assert_eq!(results.len(), 2);
    }

    #[tokio::test]
    async fn delete_cleans_up_embeddings() {
        let store = InMemoryStore::new().with_embeddings(Arc::new(TestEmbeddings));

        store.put(&["ns"], "k", json!("hello")).await.unwrap();
        assert!(!store.vectors.read().await.is_empty());

        store.delete(&["ns"], "k").await.unwrap();
        assert!(store.vectors.read().await.is_empty());
    }

    #[tokio::test]
    async fn hybrid_search_combines_bm25_and_embeddings() {
        let store = InMemoryStore::new().with_hybrid_search(Arc::new(TestEmbeddings));
        store
            .put(&["docs"], "a", json!("rust programming language guide"))
            .await
            .unwrap();
        store
            .put(&["docs"], "b", json!("python web development"))
            .await
            .unwrap();
        store
            .put(&["docs"], "c", json!("rust cargo build system"))
            .await
            .unwrap();

        let results = store.search(&["docs"], Some("rust"), 10).await.unwrap();
        assert_eq!(results.len(), 3);
        for item in &results {
            assert!(item.score.is_some());
        }
        // Scores should be descending
        let scores: Vec<f64> = results.iter().map(|i| i.score.unwrap()).collect();
        for w in scores.windows(2) {
            assert!(w[0] >= w[1], "scores not sorted: {:?}", scores);
        }
    }

    #[tokio::test]
    async fn hybrid_search_respects_limit() {
        let store = InMemoryStore::new().with_hybrid_search(Arc::new(TestEmbeddings));
        for i in 0..5 {
            store
                .put(&["ns"], &format!("k{}", i), json!(format!("item {}", i)))
                .await
                .unwrap();
        }
        let results = store.search(&["ns"], Some("item"), 2).await.unwrap();
        assert_eq!(results.len(), 2);
    }

    #[test]
    fn bm25_score_basic() {
        let score = bm25_score("rust", "rust programming language", 3.0, 10);
        assert!(score > 0.0);
    }

    #[test]
    fn bm25_score_zero_for_no_match() {
        let score = bm25_score("python", "rust programming language", 3.0, 10);
        assert_eq!(score, 0.0);
    }
}