vecstore 1.0.0

The perfect vector database - 100/100 score, embeddable, high-performance, production-ready with RAG toolkit
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
// Tests for Cross-Encoder Reranking
//
// Note: Integration tests with real models require downloading ONNX models.
// Run with: cargo test --features embeddings --test cross_encoder_reranking -- --ignored

#[cfg(feature = "embeddings")]
mod cross_encoder_tests {
    use std::collections::HashMap;
    use vecstore::reranking::cross_encoder::{CrossEncoderModel, CrossEncoderReranker};
    use vecstore::reranking::Reranker;
    use vecstore::store::Neighbor;
    use vecstore::Metadata;

    fn make_neighbor(id: &str, score: f32, text: &str) -> Neighbor {
        let mut metadata = Metadata {
            fields: HashMap::new(),
        };
        metadata
            .fields
            .insert("text".to_string(), serde_json::json!(text));

        Neighbor {
            id: id.to_string(),
            score,
            metadata,
        }
    }

    #[test]
    fn test_cross_encoder_model_enum() {
        let model = CrossEncoderModel::MiniLML6V2;
        assert_eq!(model.model_id(), "cross-encoder/ms-marco-MiniLM-L-6-v2");
        assert_eq!(model.model_dir(), "ms-marco-minilm-l6-v2");

        let model = CrossEncoderModel::MiniLML12V2;
        assert_eq!(model.model_id(), "cross-encoder/ms-marco-MiniLM-L-12-v2");
        assert_eq!(model.model_dir(), "ms-marco-minilm-l12-v2");
    }

    #[test]
    fn test_cache_dir_structure() {
        let cache_dir = CrossEncoderModel::cache_dir();
        let path_str = cache_dir.to_string_lossy();

        assert!(path_str.contains("vecstore"));
        assert!(path_str.contains("cross-encoders"));
    }

    #[test]
    fn test_from_dir_missing() {
        // Test loading from non-existent directory
        let result = CrossEncoderReranker::from_dir("/nonexistent/path/to/model");
        assert!(result.is_err());

        let err_msg = result.unwrap_err().to_string();
        assert!(err_msg.contains("not found") || err_msg.contains("does not exist"));
    }

    #[test]
    fn test_from_pretrained_not_downloaded() {
        // Test loading a model that hasn't been downloaded yet
        // This should fail with instructions
        let result = CrossEncoderReranker::from_pretrained(CrossEncoderModel::MiniLML6V2);

        // If the model isn't downloaded, we expect an error
        // If it IS downloaded (from previous tests), we expect success
        match result {
            Ok(_) => {
                // Model was already downloaded, which is fine
            }
            Err(e) => {
                // Model not downloaded, error should contain helpful message
                let err_msg = e.to_string();
                assert!(
                    err_msg.contains("download")
                        || err_msg.contains("not found")
                        || err_msg.contains("huggingface.co")
                );
            }
        }
    }

    // Integration tests - require actual model files

    #[test]
    #[ignore] // Run with: cargo test -- --ignored
    fn test_cross_encoder_load_model() {
        let reranker = CrossEncoderReranker::from_pretrained(CrossEncoderModel::MiniLML6V2)
            .expect("Failed to load model. Download it first or run model download script.");

        assert_eq!(reranker.name(), "Cross-Encoder (ONNX)");
    }

    #[test]
    #[ignore]
    fn test_cross_encoder_score_pair_basic() {
        let reranker = CrossEncoderReranker::from_pretrained(CrossEncoderModel::MiniLML6V2)
            .expect("Failed to load model");

        // Test basic relevance scoring
        let score = reranker
            .score_pair(
                "what is rust programming",
                "Rust is a systems programming language",
            )
            .expect("Failed to score pair");

        // Score should be a valid float
        assert!(score.is_finite());
        println!("Rust relevance score: {}", score);
    }

    #[test]
    #[ignore]
    fn test_cross_encoder_score_pair_relevance() {
        let reranker = CrossEncoderReranker::from_pretrained(CrossEncoderModel::MiniLML6V2)
            .expect("Failed to load model");

        // Relevant pair
        let score_relevant = reranker
            .score_pair("what is rust", "Rust is a programming language")
            .expect("Failed to score");

        // Less relevant pair
        let score_less_relevant = reranker
            .score_pair("what is rust", "Python is a programming language")
            .expect("Failed to score");

        // Irrelevant pair
        let score_irrelevant = reranker
            .score_pair("what is rust", "I like cooking pasta with tomato sauce")
            .expect("Failed to score");

        println!("Relevant score: {}", score_relevant);
        println!("Less relevant score: {}", score_less_relevant);
        println!("Irrelevant score: {}", score_irrelevant);

        // Relevant should score higher than irrelevant
        assert!(score_relevant > score_irrelevant);
    }

    #[test]
    #[ignore]
    fn test_cross_encoder_rerank_empty() {
        let reranker = CrossEncoderReranker::from_pretrained(CrossEncoderModel::MiniLML6V2)
            .expect("Failed to load model");

        let results = vec![];
        let reranked = reranker.rerank("test query", results, 10).unwrap();

        assert_eq!(reranked.len(), 0);
    }

    #[test]
    #[ignore]
    fn test_cross_encoder_rerank_basic() {
        let reranker = CrossEncoderReranker::from_pretrained(CrossEncoderModel::MiniLML6V2)
            .expect("Failed to load model");

        let results = vec![
            make_neighbor("doc1", 0.5, "Rust is a systems programming language"),
            make_neighbor("doc2", 0.9, "Python is great for data science"),
            make_neighbor("doc3", 0.7, "JavaScript runs in the browser"),
        ];

        let reranked = reranker
            .rerank("rust programming language", results, 3)
            .expect("Failed to rerank");

        assert_eq!(reranked.len(), 3);

        // doc1 should be ranked first (most relevant to "rust programming language")
        println!("Reranked order:");
        for (i, neighbor) in reranked.iter().enumerate() {
            println!("  {}. {} (score: {})", i + 1, neighbor.id, neighbor.score);
        }

        assert_eq!(reranked[0].id, "doc1");
    }

    #[test]
    #[ignore]
    fn test_cross_encoder_rerank_top_k() {
        let reranker = CrossEncoderReranker::from_pretrained(CrossEncoderModel::MiniLML6V2)
            .expect("Failed to load model");

        let results = vec![
            make_neighbor("doc1", 0.1, "Rust systems programming"),
            make_neighbor("doc2", 0.2, "Python data science"),
            make_neighbor("doc3", 0.3, "Rust async await"),
            make_neighbor("doc4", 0.4, "JavaScript web development"),
            make_neighbor("doc5", 0.5, "Rust memory safety"),
        ];

        // Rerank but only keep top 2
        let reranked = reranker
            .rerank("rust programming", results, 2)
            .expect("Failed to rerank");

        assert_eq!(reranked.len(), 2);

        // Top 2 should be Rust-related
        assert!(reranked.iter().all(|n| {
            let text = n.metadata.fields.get("text").unwrap().as_str().unwrap();
            text.to_lowercase().contains("rust")
        }));
    }

    #[test]
    #[ignore]
    fn test_cross_encoder_vs_original_scores() {
        let reranker = CrossEncoderReranker::from_pretrained(CrossEncoderModel::MiniLML6V2)
            .expect("Failed to load model");

        // Create results where original scores are misleading
        // (e.g., embedding similarity doesn't match semantic relevance)
        let results = vec![
            // High embedding score but not very relevant
            make_neighbor(
                "doc1",
                0.95,
                "Rust is a color that forms on iron when it oxidizes",
            ),
            // Lower embedding score but very relevant
            make_neighbor("doc2", 0.60, "Rust is a systems programming language"),
            // Medium embedding score, somewhat relevant
            make_neighbor(
                "doc3",
                0.75,
                "Programming languages like Rust focus on safety",
            ),
        ];

        let query = "rust programming language";
        let reranked = reranker
            .rerank(query, results, 3)
            .expect("Failed to rerank");

        println!("Original vs Reranked:");
        for neighbor in &reranked {
            println!("  {} - score: {}", neighbor.id, neighbor.score);
        }

        // doc2 should be ranked first (most relevant to programming)
        // even though it had lower original embedding score
        assert_eq!(reranked[0].id, "doc2");
    }

    #[test]
    #[ignore]
    fn test_cross_encoder_with_missing_text() {
        let reranker = CrossEncoderReranker::from_pretrained(CrossEncoderModel::MiniLML6V2)
            .expect("Failed to load model");

        // Create a neighbor without text in metadata
        let mut metadata = Metadata {
            fields: HashMap::new(),
        };
        metadata
            .fields
            .insert("other_field".to_string(), serde_json::json!("value"));

        let results = vec![Neighbor {
            id: "doc1".to_string(),
            score: 0.5,
            metadata,
        }];

        // Should not panic, should handle gracefully
        let reranked = reranker.rerank("test query", results, 1).unwrap();

        assert_eq!(reranked.len(), 1);
        // Original score should be preserved
        assert_eq!(reranked[0].score, 0.5);
    }

    #[test]
    #[ignore]
    fn test_cross_encoder_long_documents() {
        let reranker = CrossEncoderReranker::from_pretrained(CrossEncoderModel::MiniLML6V2)
            .expect("Failed to load model");

        // Test with a long document (will be truncated to 512 tokens)
        let long_doc = "Rust programming language. ".repeat(100); // ~400 words

        let results = vec![
            make_neighbor("doc1", 0.5, &long_doc),
            make_neighbor("doc2", 0.6, "Short doc about Python"),
        ];

        // Should handle truncation gracefully
        let reranked = reranker
            .rerank("rust programming", results, 2)
            .expect("Failed to handle long documents");

        assert_eq!(reranked.len(), 2);
        assert_eq!(reranked[0].id, "doc1"); // Rust doc should rank first
    }

    #[test]
    #[ignore]
    fn test_cross_encoder_special_characters() {
        let reranker = CrossEncoderReranker::from_pretrained(CrossEncoderModel::MiniLML6V2)
            .expect("Failed to load model");

        let results = vec![
            make_neighbor("doc1", 0.5, "Rust: A systems programming language!"),
            make_neighbor("doc2", 0.6, "Python & data science (ML/AI)"),
            make_neighbor("doc3", 0.7, "C++ programming... very fast?"),
        ];

        // Should handle special characters correctly
        let reranked = reranker
            .rerank("rust programming!", results, 3)
            .expect("Failed to handle special characters");

        assert_eq!(reranked.len(), 3);
        assert_eq!(reranked[0].id, "doc1");
    }

    #[test]
    #[ignore]
    fn test_cross_encoder_multiple_queries() {
        let reranker = CrossEncoderReranker::from_pretrained(CrossEncoderModel::MiniLML6V2)
            .expect("Failed to load model");

        let results = vec![
            make_neighbor("doc1", 0.5, "Rust is a systems programming language"),
            make_neighbor("doc2", 0.6, "Python is great for data science"),
            make_neighbor("doc3", 0.7, "JavaScript for web development"),
        ];

        // Query 1: Rust
        let reranked1 = reranker
            .rerank("rust programming", results.clone(), 1)
            .expect("Failed to rerank");
        assert_eq!(reranked1[0].id, "doc1");

        // Query 2: Python
        let reranked2 = reranker
            .rerank("python data science", results.clone(), 1)
            .expect("Failed to rerank");
        assert_eq!(reranked2[0].id, "doc2");

        // Query 3: JavaScript
        let reranked3 = reranker
            .rerank("javascript web", results, 1)
            .expect("Failed to rerank");
        assert_eq!(reranked3[0].id, "doc3");
    }

    #[test]
    #[ignore]
    fn test_cross_encoder_score_consistency() {
        let reranker = CrossEncoderReranker::from_pretrained(CrossEncoderModel::MiniLML6V2)
            .expect("Failed to load model");

        let query = "rust programming language";
        let document = "Rust is a systems programming language";

        // Score the same pair multiple times
        let score1 = reranker.score_pair(query, document).unwrap();
        let score2 = reranker.score_pair(query, document).unwrap();
        let score3 = reranker.score_pair(query, document).unwrap();

        // Scores should be consistent (deterministic)
        assert!((score1 - score2).abs() < 0.0001);
        assert!((score2 - score3).abs() < 0.0001);
    }

    #[test]
    #[ignore]
    fn test_cross_encoder_batch_rerank() {
        let reranker = CrossEncoderReranker::from_pretrained(CrossEncoderModel::MiniLML6V2)
            .expect("Failed to load model");

        // Test with a larger batch
        let results: Vec<Neighbor> = (0..20)
            .map(|i| {
                let text = if i % 3 == 0 {
                    format!("Rust programming document {}", i)
                } else if i % 3 == 1 {
                    format!("Python programming document {}", i)
                } else {
                    format!("JavaScript programming document {}", i)
                };
                make_neighbor(&format!("doc{}", i), 0.5, &text)
            })
            .collect();

        let reranked = reranker
            .rerank("rust programming", results, 5)
            .expect("Failed to rerank batch");

        assert_eq!(reranked.len(), 5);

        // Top results should mostly be Rust-related
        let rust_count = reranked
            .iter()
            .filter(|n| {
                let text = n.metadata.fields.get("text").unwrap().as_str().unwrap();
                text.contains("Rust")
            })
            .count();

        println!("Rust documents in top 5: {}", rust_count);
        assert!(rust_count >= 3); // At least 3 of top 5 should be Rust-related
    }
}