oxirs-vec 0.2.4

Vector index abstractions for semantic similarity and AI-augmented querying
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
//! Cross-encoder model wrapper for query-document relevance scoring
//!
//! Cross-encoders jointly encode query and document pairs to produce
//! accurate relevance scores. Unlike bi-encoders, they see both inputs
//! together, enabling fine-grained relevance modeling at higher computational cost.

use crate::reranking::types::{RerankingError, RerankingResult};
use scirs2_core::random::Random;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use std::sync::{Arc, RwLock};

/// Backend for cross-encoder inference
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub enum CrossEncoderBackend {
    /// Local model inference (PyTorch/ONNX)
    Local,
    /// API-based inference (OpenAI, Cohere, etc.)
    Api,
    /// Remote inference server
    Remote,
    /// Mock backend for testing
    Mock,
}

/// Trait for cross-encoder backends
pub trait CrossEncoderBackendTrait: Send + Sync {
    /// Score a single query-document pair
    fn score(&self, query: &str, document: &str) -> RerankingResult<f32>;

    /// Score multiple query-document pairs in batch
    fn batch_score(&self, pairs: &[(String, String)]) -> RerankingResult<Vec<f32>> {
        // Default implementation: score one by one
        pairs.iter().map(|(q, d)| self.score(q, d)).collect()
    }
}

/// Local model backend using sentence transformers
#[derive(Debug, Clone)]
pub struct LocalBackend {
    model_name: String,
    max_length: usize,
    device: String,
    model_loaded: Arc<RwLock<bool>>,
}

impl LocalBackend {
    pub fn new(model_name: String, max_length: usize, device: String) -> Self {
        Self {
            model_name,
            max_length,
            device,
            model_loaded: Arc::new(RwLock::new(false)),
        }
    }

    fn ensure_loaded(&self) -> RerankingResult<()> {
        let mut loaded = self
            .model_loaded
            .write()
            .map_err(|e| RerankingError::BackendError {
                message: format!("Lock poisoned: {}", e),
            })?;

        if !*loaded {
            tracing::info!("Loading cross-encoder model: {}", self.model_name);
            // In real implementation: load model using tokenizers + PyTorch/ONNX
            // For now, mark as loaded
            *loaded = true;
        }
        Ok(())
    }

    fn compute_similarity(&self, query: &str, document: &str) -> f32 {
        // Simplified similarity computation
        // Real implementation would use transformer model inference

        // Normalize texts
        let q = query.to_lowercase();
        let d = document.to_lowercase();

        // Exact match bonus
        if d.contains(&q) {
            return 0.95;
        }

        // Word overlap score
        let q_words: Vec<&str> = q.split_whitespace().collect();
        let d_words: Vec<&str> = d.split_whitespace().collect();

        if q_words.is_empty() {
            return 0.5;
        }

        let overlap_count = q_words
            .iter()
            .filter(|qw| d_words.iter().any(|dw| dw.contains(*qw) || qw.contains(dw)))
            .count();

        let overlap_ratio = overlap_count as f32 / q_words.len() as f32;

        // Length penalty for very short or very long documents
        let doc_len = d_words.len();
        let length_factor = if doc_len < 10 {
            0.8
        } else if doc_len > 500 {
            0.85
        } else {
            1.0
        };

        // Combine scores
        let base_score = 0.4 + overlap_ratio * 0.5;
        (base_score * length_factor).min(0.99)
    }
}

impl CrossEncoderBackendTrait for LocalBackend {
    fn score(&self, query: &str, document: &str) -> RerankingResult<f32> {
        self.ensure_loaded()?;

        if query.is_empty() || document.is_empty() {
            return Ok(0.0);
        }

        let score = self.compute_similarity(query, document);
        Ok(score)
    }

    fn batch_score(&self, pairs: &[(String, String)]) -> RerankingResult<Vec<f32>> {
        self.ensure_loaded()?;

        // Real implementation would batch through model inference
        // For now, process individually
        Ok(pairs
            .iter()
            .map(|(q, d)| self.compute_similarity(q, d))
            .collect())
    }
}

/// API-based backend (e.g., Cohere Rerank API)
#[derive(Debug, Clone)]
pub struct ApiBackend {
    api_key: String,
    endpoint: String,
    model: String,
    timeout_ms: u64,
}

impl ApiBackend {
    pub fn new(api_key: String, endpoint: String, model: String, timeout_ms: u64) -> Self {
        Self {
            api_key,
            endpoint,
            model,
            timeout_ms,
        }
    }
}

impl CrossEncoderBackendTrait for ApiBackend {
    fn score(&self, query: &str, document: &str) -> RerankingResult<f32> {
        // In real implementation: make API call to reranking service
        // For now, return mock score
        tracing::debug!(
            "API reranking: {} chars query, {} chars doc",
            query.len(),
            document.len()
        );

        // Simulate API delay with random jitter
        let mut rng = Random::seed(42);
        let base_score = rng.gen_range(0.4..0.9);
        Ok(base_score)
    }

    fn batch_score(&self, pairs: &[(String, String)]) -> RerankingResult<Vec<f32>> {
        // Real implementation would batch API call
        tracing::debug!("Batch API reranking: {} pairs", pairs.len());

        let mut rng = Random::seed(42);
        Ok(pairs.iter().map(|_| rng.gen_range(0.4..0.9)).collect())
    }
}

/// Mock backend for testing
#[derive(Debug, Clone)]
pub struct MockBackend {
    scores: Arc<RwLock<HashMap<String, f32>>>,
}

impl MockBackend {
    pub fn new() -> Self {
        Self {
            scores: Arc::new(RwLock::new(HashMap::new())),
        }
    }

    pub fn set_score(&self, query: &str, document: &str, score: f32) {
        let key = format!("{}||{}", query, document);
        if let Ok(mut scores) = self.scores.write() {
            scores.insert(key, score);
        }
    }
}

impl Default for MockBackend {
    fn default() -> Self {
        Self::new()
    }
}

impl CrossEncoderBackendTrait for MockBackend {
    fn score(&self, query: &str, document: &str) -> RerankingResult<f32> {
        let key = format!("{}||{}", query, document);

        if let Ok(scores) = self.scores.read() {
            if let Some(&score) = scores.get(&key) {
                return Ok(score);
            }
        }

        // Default mock score based on text overlap
        let overlap = query
            .split_whitespace()
            .filter(|w| document.contains(w))
            .count();

        let query_words = query.split_whitespace().count().max(1);
        let score = 0.5 + (overlap as f32 / query_words as f32) * 0.4;

        Ok(score.min(0.95))
    }
}

/// Cross-encoder model for relevance scoring
#[derive(Clone)]
pub struct CrossEncoder {
    model_name: String,
    backend: Arc<dyn CrossEncoderBackendTrait>,
    batch_size: usize,
}

impl CrossEncoder {
    /// Create new cross-encoder with specified backend
    pub fn new(model_name: &str, backend_type: &str) -> RerankingResult<Self> {
        let backend: Arc<dyn CrossEncoderBackendTrait> = match backend_type {
            "local" => Arc::new(LocalBackend::new(
                model_name.to_string(),
                512,
                "cpu".to_string(),
            )),
            "api" => {
                // Read API key from environment
                let api_key =
                    std::env::var("RERANK_API_KEY").unwrap_or_else(|_| "mock_api_key".to_string());

                Arc::new(ApiBackend::new(
                    api_key,
                    "https://api.cohere.ai/v1/rerank".to_string(),
                    model_name.to_string(),
                    5000,
                ))
            }
            "mock" => Arc::new(MockBackend::new()),
            _ => {
                return Err(RerankingError::InvalidConfiguration {
                    message: format!("Unknown backend type: {}", backend_type),
                });
            }
        };

        Ok(Self {
            model_name: model_name.to_string(),
            backend,
            batch_size: 32,
        })
    }

    /// Create with mock backend for testing
    pub fn with_mock_backend() -> Self {
        Self {
            model_name: "mock".to_string(),
            backend: Arc::new(MockBackend::new()),
            batch_size: 32,
        }
    }

    /// Score a single query-document pair
    pub fn score(&self, query: &str, document: &str) -> RerankingResult<f32> {
        self.backend.score(query, document)
    }

    /// Score multiple query-document pairs in batch
    pub fn batch_score(&self, pairs: &[(String, String)]) -> RerankingResult<Vec<f32>> {
        if pairs.is_empty() {
            return Ok(Vec::new());
        }

        // Process in batches
        let mut all_scores = Vec::with_capacity(pairs.len());

        for chunk in pairs.chunks(self.batch_size) {
            let scores = self.backend.batch_score(chunk)?;
            all_scores.extend(scores);
        }

        Ok(all_scores)
    }

    /// Get model name
    pub fn model_name(&self) -> &str {
        &self.model_name
    }

    /// Set batch size
    pub fn set_batch_size(&mut self, batch_size: usize) {
        self.batch_size = batch_size;
    }
}

#[cfg(test)]
mod tests {
    type Result<T> = std::result::Result<T, Box<dyn std::error::Error>>;
    use super::*;

    #[test]
    fn test_local_backend_basic() -> Result<()> {
        let backend = LocalBackend::new(
            "cross-encoder/ms-marco-MiniLM-L-6-v2".to_string(),
            512,
            "cpu".to_string(),
        );

        let score = backend.score("machine learning", "deep learning tutorial")?;
        assert!((0.0..=1.0).contains(&score));
        Ok(())
    }

    #[test]
    fn test_local_backend_exact_match() -> Result<()> {
        let backend = LocalBackend::new("test-model".to_string(), 512, "cpu".to_string());

        let score = backend.score("rust programming", "This is about rust programming")?;
        assert!(score > 0.9);
        Ok(())
    }

    #[test]
    fn test_local_backend_no_match() -> Result<()> {
        let backend = LocalBackend::new("test-model".to_string(), 512, "cpu".to_string());

        let score = backend.score("python", "javascript tutorial")?;
        assert!(score < 0.6);
        Ok(())
    }

    #[test]
    fn test_mock_backend() -> Result<()> {
        let backend = MockBackend::new();
        backend.set_score("test", "document", 0.85);

        let score = backend.score("test", "document")?;
        assert!((score - 0.85).abs() < 0.01);
        Ok(())
    }

    #[test]
    fn test_cross_encoder_creation() -> Result<()> {
        let encoder = CrossEncoder::new("ms-marco-MiniLM", "local")?;
        assert_eq!(encoder.model_name(), "ms-marco-MiniLM");
        Ok(())
    }

    #[test]
    fn test_cross_encoder_scoring() -> Result<()> {
        let encoder = CrossEncoder::with_mock_backend();
        let score = encoder.score("query", "relevant document")?;
        assert!((0.0..=1.0).contains(&score));
        Ok(())
    }

    #[test]
    fn test_batch_scoring() -> Result<()> {
        let encoder = CrossEncoder::with_mock_backend();
        let pairs = vec![
            ("query1".to_string(), "doc1".to_string()),
            ("query2".to_string(), "doc2".to_string()),
            ("query3".to_string(), "doc3".to_string()),
        ];

        let scores = encoder.batch_score(&pairs)?;
        assert_eq!(scores.len(), 3);

        for score in scores {
            assert!((0.0..=1.0).contains(&score));
        }
        Ok(())
    }

    #[test]
    fn test_empty_input() -> Result<()> {
        let backend = LocalBackend::new("test-model".to_string(), 512, "cpu".to_string());

        let score = backend.score("", "document")?;
        assert_eq!(score, 0.0);

        let score = backend.score("query", "")?;
        assert_eq!(score, 0.0);
        Ok(())
    }

    #[test]
    fn test_invalid_backend() {
        let result = CrossEncoder::new("model", "invalid_backend");
        assert!(result.is_err());
    }
}