xz-rag 0.1.1

Multi-channel Retrieval-Augmented Generation engine
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

use moka::future::Cache;

use crate::types::retrieval::RetrieveResult;

/// In-memory cache for retrieval results using moka.
pub struct RagMemoryCache {
    cache: Cache<String, RetrieveResult>,
}

impl RagMemoryCache {
    /// Create a new in-memory cache with the given capacity and TTL.
    pub fn new(max_entries: usize, ttl_seconds: u64) -> Self {
        let cache = Cache::builder()
            .max_capacity(max_entries as u64)
            .time_to_live(std::time::Duration::from_secs(ttl_seconds))
            .build();

        Self { cache }
    }

    /// Retrieve a cached result by key.
    pub async fn get(&self, key: &str) -> Option<RetrieveResult> {
        self.cache.get(key).await
    }

    /// Store a result in the cache.
    pub async fn set(&self, key: &str, value: RetrieveResult) {
        self.cache.insert(key.to_string(), value).await;
    }

    /// Invalidate all cache entries.
    ///
    /// Note: moka does not support namespace-based invalidation natively,
    /// so this invalidates the entire cache. Entries are also auto-evicted
    /// by TTL and capacity limits.
    pub fn invalidate(&self, _namespace: &str) {
        self.cache.invalidate_all();
    }
}

#[cfg(all(test, feature = "caching"))]
mod tests {
    use super::*;

    fn make_result() -> RetrieveResult {
        RetrieveResult {
            hits: vec![],
            channel_report: std::collections::HashMap::new(),
            latency_ms: 42,
            effective_query: "test query".to_string(),
        }
    }

    #[tokio::test]
    async fn invalidate_evicts_entries() {
        let cache = RagMemoryCache::new(100, 3600);

        cache.set("key1", make_result()).await;
        assert!(cache.get("key1").await.is_some());

        cache.invalidate("test_namespace");
        assert!(cache.get("key1").await.is_none());
    }

    #[tokio::test]
    async fn invalidate_evicts_all_entries() {
        let cache = RagMemoryCache::new(100, 3600);

        cache.set("key1", make_result()).await;
        cache.set("key2", make_result()).await;
        assert!(cache.get("key1").await.is_some());
        assert!(cache.get("key2").await.is_some());

        cache.invalidate("test_namespace");
        assert!(cache.get("key1").await.is_none());
        assert!(cache.get("key2").await.is_none());
    }

    #[tokio::test]
    async fn set_after_invalidate_still_works() {
        let cache = RagMemoryCache::new(100, 3600);

        cache.set("key1", make_result()).await;
        cache.invalidate("test_namespace");

        // After invalidation, new entries should still be settable/gettable
        cache.set("key1", make_result()).await;
        assert!(cache.get("key1").await.is_some());
    }
}