oxirs-chat 0.2.4

RAG chat API with LLM integration and natural language to SPARQL translation
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
//! Response Cache for LLM Requests
//!
//! Provides LRU caching for LLM responses to reduce API costs and improve latency.

use anyhow::Result;
use std::{
    collections::HashMap,
    sync::Arc,
    time::{Duration, SystemTime},
};
use tokio::sync::RwLock;

use super::types::{LLMRequest, LLMResponse};

/// Hash key for request caching
type RequestHash = u64;

/// Cached response with metadata
#[derive(Debug, Clone)]
pub struct CachedResponse {
    pub response: LLMResponse,
    pub provider_id: String,
    pub timestamp: SystemTime,
    pub ttl: Duration,
    pub access_count: u32,
}

impl CachedResponse {
    pub fn is_expired(&self) -> bool {
        SystemTime::now()
            .duration_since(self.timestamp)
            .map(|elapsed| elapsed > self.ttl)
            .unwrap_or(true)
    }
}

/// Cache configuration
#[derive(Debug, Clone)]
pub struct CacheConfig {
    pub max_size: usize,
    pub ttl_seconds: u64,
    pub enable_metrics: bool,
}

impl Default for CacheConfig {
    fn default() -> Self {
        Self {
            max_size: 1000,
            ttl_seconds: 3600, // 1 hour
            enable_metrics: true,
        }
    }
}

/// Cache metrics for monitoring
#[derive(Debug, Clone, Default)]
pub struct CacheMetrics {
    pub hits: u64,
    pub misses: u64,
    pub evictions: u64,
    pub total_requests: u64,
}

impl CacheMetrics {
    pub fn hit_rate(&self) -> f64 {
        if self.total_requests == 0 {
            0.0
        } else {
            self.hits as f64 / self.total_requests as f64
        }
    }
}

/// LRU Cache entry for ordering
#[derive(Debug, Clone)]
struct LruEntry {
    cached_response: CachedResponse,
    last_accessed: SystemTime,
}

/// Response cache with LRU eviction
pub struct ResponseCache {
    cache: Arc<RwLock<HashMap<RequestHash, LruEntry>>>,
    config: CacheConfig,
    metrics: Arc<RwLock<CacheMetrics>>,
}

impl ResponseCache {
    pub fn new(config: CacheConfig) -> Self {
        Self {
            cache: Arc::new(RwLock::new(HashMap::new())),
            config,
            metrics: Arc::new(RwLock::new(CacheMetrics::default())),
        }
    }

    /// Generate hash for request
    fn hash_request(request: &LLMRequest) -> RequestHash {
        use std::collections::hash_map::DefaultHasher;
        use std::hash::{Hash, Hasher};

        let mut hasher = DefaultHasher::new();

        // Hash messages
        for msg in &request.messages {
            msg.role.hash(&mut hasher);
            msg.content.hash(&mut hasher);
        }

        // Hash system prompt
        if let Some(ref prompt) = request.system_prompt {
            prompt.hash(&mut hasher);
        }

        // Hash temperature (convert to bits for consistent hashing)
        ((request.temperature * 1000.0) as u64).hash(&mut hasher);

        // Hash max_tokens
        request.max_tokens.hash(&mut hasher);

        hasher.finish()
    }

    /// Get cached response if available
    pub async fn get(&self, request: &LLMRequest) -> Option<LLMResponse> {
        let hash = Self::hash_request(request);
        let mut cache = self.cache.write().await;

        if let Some(entry) = cache.get_mut(&hash) {
            // Check if expired
            if entry.cached_response.is_expired() {
                cache.remove(&hash);
                self.record_miss().await;
                return None;
            }

            // Update access time and count
            entry.last_accessed = SystemTime::now();
            entry.cached_response.access_count += 1;

            self.record_hit().await;
            Some(entry.cached_response.response.clone())
        } else {
            self.record_miss().await;
            None
        }
    }

    /// Store response in cache
    pub async fn put(&self, request: &LLMRequest, response: LLMResponse, provider_id: String) {
        let hash = Self::hash_request(request);
        let mut cache = self.cache.write().await;

        // Check if we need to evict
        if cache.len() >= self.config.max_size && !cache.contains_key(&hash) {
            self.evict_lru(&mut cache).await;
        }

        let cached_response = CachedResponse {
            response,
            provider_id,
            timestamp: SystemTime::now(),
            ttl: Duration::from_secs(self.config.ttl_seconds),
            access_count: 1,
        };

        let entry = LruEntry {
            cached_response,
            last_accessed: SystemTime::now(),
        };

        cache.insert(hash, entry);
    }

    /// Evict least recently used entry
    async fn evict_lru(&self, cache: &mut HashMap<RequestHash, LruEntry>) {
        if cache.is_empty() {
            return;
        }

        // Find LRU entry
        let lru_key = cache
            .iter()
            .min_by_key(|(_, entry)| entry.last_accessed)
            .map(|(k, _)| *k);

        if let Some(key) = lru_key {
            cache.remove(&key);

            // Record eviction
            if self.config.enable_metrics {
                let mut metrics = self.metrics.write().await;
                metrics.evictions += 1;
            }
        }
    }

    /// Remove expired entries
    pub async fn invalidate_expired(&self) -> Result<usize> {
        let mut cache = self.cache.write().await;
        let now = SystemTime::now();

        let expired_keys: Vec<RequestHash> = cache
            .iter()
            .filter(|(_, entry)| {
                now.duration_since(entry.cached_response.timestamp)
                    .map(|elapsed| elapsed > entry.cached_response.ttl)
                    .unwrap_or(true)
            })
            .map(|(k, _)| *k)
            .collect();

        let count = expired_keys.len();
        for key in expired_keys {
            cache.remove(&key);
        }

        Ok(count)
    }

    /// Clear all cached entries
    pub async fn clear(&self) -> Result<()> {
        let mut cache = self.cache.write().await;
        cache.clear();
        Ok(())
    }

    /// Get current cache size
    pub async fn size(&self) -> usize {
        let cache = self.cache.read().await;
        cache.len()
    }

    /// Get cache metrics
    pub async fn get_metrics(&self) -> CacheMetrics {
        let metrics = self.metrics.read().await;
        metrics.clone()
    }

    /// Calculate hit rate
    pub async fn hit_rate(&self) -> f64 {
        let metrics = self.metrics.read().await;
        metrics.hit_rate()
    }

    async fn record_hit(&self) {
        if self.config.enable_metrics {
            let mut metrics = self.metrics.write().await;
            metrics.hits += 1;
            metrics.total_requests += 1;
        }
    }

    async fn record_miss(&self) {
        if self.config.enable_metrics {
            let mut metrics = self.metrics.write().await;
            metrics.misses += 1;
            metrics.total_requests += 1;
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::llm::types::{ChatMessage, ChatRole, Priority, Usage, UseCase};

    fn create_test_request(content: &str) -> LLMRequest {
        LLMRequest {
            messages: vec![ChatMessage {
                role: ChatRole::User,
                content: content.to_string(),
                metadata: None,
            }],
            system_prompt: Some("Test prompt".to_string()),
            temperature: 0.7,
            max_tokens: Some(100),
            use_case: UseCase::Conversation,
            priority: Priority::Normal,
            timeout: None,
        }
    }

    fn create_test_response(content: &str) -> LLMResponse {
        LLMResponse {
            content: content.to_string(),
            model_used: "test-model".to_string(),
            provider_used: "test-provider".to_string(),
            usage: Usage {
                prompt_tokens: 10,
                completion_tokens: 20,
                total_tokens: 30,
                cost: 0.001,
            },
            latency: Duration::from_millis(100),
            quality_score: Some(0.9),
            metadata: std::collections::HashMap::new(),
        }
    }

    #[tokio::test]
    async fn test_cache_hit() {
        let cache = ResponseCache::new(CacheConfig::default());
        let request = create_test_request("test query");
        let response = create_test_response("test response");

        // Store response
        cache
            .put(&request, response.clone(), "test-provider".to_string())
            .await;

        // Retrieve response
        let cached = cache.get(&request).await;
        assert!(cached.is_some());
        assert_eq!(
            cached.as_ref().expect("should succeed").content,
            response.content
        );

        // Check metrics
        let metrics = cache.get_metrics().await;
        assert_eq!(metrics.hits, 1);
        assert_eq!(metrics.misses, 0);
    }

    #[tokio::test]
    async fn test_cache_miss() {
        let cache = ResponseCache::new(CacheConfig::default());
        let request = create_test_request("test query");

        // Try to retrieve non-existent response
        let cached = cache.get(&request).await;
        assert!(cached.is_none());

        // Check metrics
        let metrics = cache.get_metrics().await;
        assert_eq!(metrics.hits, 0);
        assert_eq!(metrics.misses, 1);
    }

    #[tokio::test]
    async fn test_cache_expiration() {
        let config = CacheConfig {
            ttl_seconds: 1, // 1 second TTL
            ..Default::default()
        };

        let cache = ResponseCache::new(config);
        let request = create_test_request("test query");
        let response = create_test_response("test response");

        // Store response
        cache
            .put(&request, response.clone(), "test-provider".to_string())
            .await;

        // Wait for expiration
        tokio::time::sleep(Duration::from_secs(2)).await;

        // Try to retrieve expired response
        let cached = cache.get(&request).await;
        assert!(cached.is_none());
    }

    #[tokio::test]
    async fn test_lru_eviction() {
        let config = CacheConfig {
            max_size: 2,
            ..Default::default()
        };

        let cache = ResponseCache::new(config);

        // Fill cache
        let req1 = create_test_request("query 1");
        let req2 = create_test_request("query 2");
        let req3 = create_test_request("query 3");

        cache
            .put(
                &req1,
                create_test_response("response 1"),
                "provider1".to_string(),
            )
            .await;
        cache
            .put(
                &req2,
                create_test_response("response 2"),
                "provider2".to_string(),
            )
            .await;

        // Access req1 to make it more recent
        let _ = cache.get(&req1).await;

        // Add req3, should evict req2 (least recently used)
        cache
            .put(
                &req3,
                create_test_response("response 3"),
                "provider3".to_string(),
            )
            .await;

        // req1 and req3 should exist, req2 should be evicted
        assert!(cache.get(&req1).await.is_some());
        assert!(cache.get(&req2).await.is_none());
        assert!(cache.get(&req3).await.is_some());
    }

    #[tokio::test]
    async fn test_hit_rate_calculation() {
        let cache = ResponseCache::new(CacheConfig::default());
        let request = create_test_request("test query");
        let response = create_test_response("test response");

        // Store response
        cache
            .put(&request, response.clone(), "test-provider".to_string())
            .await;

        // 3 hits, 2 misses = 60% hit rate
        let _ = cache.get(&request).await; // hit
        let _ = cache.get(&request).await; // hit
        let _ = cache.get(&request).await; // hit
        let _ = cache.get(&create_test_request("other query")).await; // miss
        let _ = cache.get(&create_test_request("another query")).await; // miss

        let hit_rate = cache.hit_rate().await;
        assert!((hit_rate - 0.6).abs() < 0.01); // 3/5 = 0.6
    }
}