oxify-vector 0.1.0

In-memory vector search and similarity operations for OxiFY (ported from OxiRS)
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
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
//! Hybrid Search: Vector + Keyword (BM25)
//!
//! Combines semantic vector search with lexical keyword search for improved results.
//!
//! ## Algorithm
//!
//! - **Vector Search:** Semantic similarity using embeddings
//! - **Keyword Search:** BM25 scoring for lexical matching
//! - **Fusion:** Reciprocal Rank Fusion (RRF) or weighted combination
//!
//! ## Example
//!
//! ```rust
//! use oxify_vector::hybrid::{HybridIndex, HybridConfig};
//! use std::collections::HashMap;
//!
//! # fn example() -> anyhow::Result<()> {
//! // Create documents with text and embeddings
//! let mut embeddings = HashMap::new();
//! embeddings.insert("doc1".to_string(), vec![0.1, 0.2, 0.3]);
//! embeddings.insert("doc2".to_string(), vec![0.2, 0.3, 0.4]);
//!
//! let mut texts = HashMap::new();
//! texts.insert("doc1".to_string(), "rust programming language".to_string());
//! texts.insert("doc2".to_string(), "python machine learning".to_string());
//!
//! // Build hybrid index
//! let config = HybridConfig::default();
//! let mut index = HybridIndex::new(config);
//! index.build(&embeddings, &texts)?;
//!
//! // Hybrid search
//! let query_vector = vec![0.15, 0.25, 0.35];
//! let query_text = "rust programming";
//! let results = index.search(&query_vector, query_text, 2)?;
//! # Ok(())
//! # }
//! ```

use crate::search::VectorSearchIndex;
use crate::types::{DistanceMetric, SearchConfig, SearchResult};
use anyhow::{anyhow, Result};
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use tracing::{debug, info};

/// BM25 parameters
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Bm25Config {
    /// Term frequency saturation parameter (default: 1.2)
    pub k1: f32,
    /// Document length normalization parameter (default: 0.75)
    pub b: f32,
}

impl Default for Bm25Config {
    fn default() -> Self {
        Self { k1: 1.2, b: 0.75 }
    }
}

/// Hybrid search configuration
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HybridConfig {
    /// Vector search weight (0.0 to 1.0)
    pub alpha: f32,
    /// Distance metric for vector search
    pub metric: DistanceMetric,
    /// BM25 parameters
    pub bm25: Bm25Config,
    /// RRF constant (typically 60)
    pub rrf_k: f32,
    /// Normalize vectors
    pub normalize: bool,
}

impl Default for HybridConfig {
    fn default() -> Self {
        Self {
            alpha: 0.5,
            metric: DistanceMetric::Cosine,
            bm25: Bm25Config::default(),
            rrf_k: 60.0,
            normalize: true,
        }
    }
}

impl HybridConfig {
    /// Create config favoring vector search
    pub fn vector_heavy() -> Self {
        Self {
            alpha: 0.7,
            ..Default::default()
        }
    }

    /// Create config favoring keyword search
    pub fn keyword_heavy() -> Self {
        Self {
            alpha: 0.3,
            ..Default::default()
        }
    }
}

/// BM25 index for keyword search
struct Bm25Index {
    config: Bm25Config,
    /// Document texts (entity_id -> text)
    documents: HashMap<String, String>,
    /// Inverted index (term -> entity_ids with term frequency)
    inverted_index: HashMap<String, HashMap<String, usize>>,
    /// Document lengths (entity_id -> word count)
    doc_lengths: HashMap<String, usize>,
    /// Average document length
    avg_doc_length: f32,
    /// Total number of documents
    num_docs: usize,
}

impl Bm25Index {
    fn new(config: Bm25Config) -> Self {
        Self {
            config,
            documents: HashMap::new(),
            inverted_index: HashMap::new(),
            doc_lengths: HashMap::new(),
            avg_doc_length: 0.0,
            num_docs: 0,
        }
    }

    fn build(&mut self, texts: &HashMap<String, String>) {
        self.documents = texts.clone();
        self.num_docs = texts.len();

        // Tokenize and build inverted index
        let mut total_length = 0;

        for (entity_id, text) in texts {
            let tokens = self.tokenize(text);
            let doc_len = tokens.len();
            self.doc_lengths.insert(entity_id.clone(), doc_len);
            total_length += doc_len;

            // Count term frequencies
            let mut term_counts: HashMap<String, usize> = HashMap::new();
            for token in tokens {
                *term_counts.entry(token).or_insert(0) += 1;
            }

            // Update inverted index
            for (term, count) in term_counts {
                self.inverted_index
                    .entry(term)
                    .or_default()
                    .insert(entity_id.clone(), count);
            }
        }

        self.avg_doc_length = if self.num_docs > 0 {
            total_length as f32 / self.num_docs as f32
        } else {
            0.0
        };
    }

    fn tokenize(&self, text: &str) -> Vec<String> {
        text.to_lowercase()
            .split(|c: char| !c.is_alphanumeric())
            .filter(|s| !s.is_empty() && s.len() > 1)
            .map(|s| s.to_string())
            .collect()
    }

    fn search(&self, query: &str, k: usize) -> Vec<(String, f32)> {
        let query_tokens = self.tokenize(query);
        let mut scores: HashMap<String, f32> = HashMap::new();

        for token in &query_tokens {
            if let Some(postings) = self.inverted_index.get(token) {
                // Calculate IDF
                let df = postings.len() as f32;
                let idf = ((self.num_docs as f32 - df + 0.5) / (df + 0.5) + 1.0).ln();

                for (entity_id, &tf) in postings {
                    let doc_len = *self.doc_lengths.get(entity_id).unwrap_or(&1) as f32;
                    let tf_f = tf as f32;

                    // BM25 formula
                    let numerator = tf_f * (self.config.k1 + 1.0);
                    let denominator = tf_f
                        + self.config.k1
                            * (1.0 - self.config.b
                                + self.config.b * (doc_len / self.avg_doc_length));

                    let score = idf * (numerator / denominator);
                    *scores.entry(entity_id.clone()).or_insert(0.0) += score;
                }
            }
        }

        // Sort by score descending
        let mut results: Vec<(String, f32)> = scores.into_iter().collect();
        results.sort_by(|a, b| b.1.partial_cmp(&a.1).unwrap_or(std::cmp::Ordering::Equal));
        results.truncate(k);
        results
    }
}

/// Hybrid search index combining vector and keyword search
pub struct HybridIndex {
    config: HybridConfig,
    vector_index: VectorSearchIndex,
    bm25_index: Bm25Index,
    entity_ids: Vec<String>,
    is_built: bool,
}

impl HybridIndex {
    /// Create a new hybrid search index
    pub fn new(config: HybridConfig) -> Self {
        info!(
            "Initialized hybrid index: alpha={}, metric={:?}",
            config.alpha, config.metric
        );

        let vector_config = SearchConfig {
            metric: config.metric,
            parallel: true,
            normalize: config.normalize,
        };

        Self {
            vector_index: VectorSearchIndex::new(vector_config),
            bm25_index: Bm25Index::new(config.bm25.clone()),
            config,
            entity_ids: Vec::new(),
            is_built: false,
        }
    }

    /// Build hybrid index from embeddings and texts
    pub fn build(
        &mut self,
        embeddings: &HashMap<String, Vec<f32>>,
        texts: &HashMap<String, String>,
    ) -> Result<()> {
        if embeddings.is_empty() {
            return Err(anyhow!("Cannot build index from empty embeddings"));
        }

        // Verify all embeddings have corresponding texts
        for entity_id in embeddings.keys() {
            if !texts.contains_key(entity_id) {
                return Err(anyhow!(
                    "Missing text for entity '{}'. All embeddings must have corresponding texts.",
                    entity_id
                ));
            }
        }

        info!("Building hybrid index for {} entities", embeddings.len());

        self.entity_ids = embeddings.keys().cloned().collect();

        // Build vector index
        self.vector_index.build(embeddings)?;

        // Build BM25 index
        self.bm25_index.build(texts);

        self.is_built = true;
        info!("Hybrid index built successfully");
        Ok(())
    }

    /// Hybrid search combining vector and keyword results
    ///
    /// Uses Reciprocal Rank Fusion (RRF) to combine results.
    pub fn search(
        &self,
        query_vector: &[f32],
        query_text: &str,
        k: usize,
    ) -> Result<Vec<HybridSearchResult>> {
        if !self.is_built {
            return Err(anyhow!("Index not built. Call build() first"));
        }

        debug!(
            "Hybrid search: k={}, alpha={}, query_text='{}'",
            k, self.config.alpha, query_text
        );

        // Get more candidates for fusion
        let expanded_k = (k * 3).min(self.entity_ids.len());

        // Vector search
        let vector_results = self.vector_index.search(query_vector, expanded_k)?;

        // BM25 search
        let bm25_results = self.bm25_index.search(query_text, expanded_k);

        // Combine using RRF
        let results = self.reciprocal_rank_fusion(&vector_results, &bm25_results, k);

        debug!("Hybrid search returned {} results", results.len());
        Ok(results)
    }

    /// Combine results using Reciprocal Rank Fusion
    fn reciprocal_rank_fusion(
        &self,
        vector_results: &[SearchResult],
        bm25_results: &[(String, f32)],
        k: usize,
    ) -> Vec<HybridSearchResult> {
        let mut rrf_scores: HashMap<String, f32> = HashMap::new();
        let mut vector_scores: HashMap<String, f32> = HashMap::new();
        let mut bm25_scores: HashMap<String, f32> = HashMap::new();

        // Calculate RRF scores from vector results
        for (rank, result) in vector_results.iter().enumerate() {
            let rrf_score = 1.0 / (self.config.rrf_k + rank as f32 + 1.0);
            *rrf_scores.entry(result.entity_id.clone()).or_insert(0.0) +=
                self.config.alpha * rrf_score;
            vector_scores.insert(result.entity_id.clone(), result.score);
        }

        // Calculate RRF scores from BM25 results
        for (rank, (entity_id, score)) in bm25_results.iter().enumerate() {
            let rrf_score = 1.0 / (self.config.rrf_k + rank as f32 + 1.0);
            *rrf_scores.entry(entity_id.clone()).or_insert(0.0) +=
                (1.0 - self.config.alpha) * rrf_score;
            bm25_scores.insert(entity_id.clone(), *score);
        }

        // Sort by combined RRF score
        let mut results: Vec<(String, f32)> = rrf_scores.into_iter().collect();
        results.sort_by(|a, b| b.1.partial_cmp(&a.1).unwrap_or(std::cmp::Ordering::Equal));

        // Convert to HybridSearchResult
        results
            .into_iter()
            .take(k)
            .enumerate()
            .map(|(rank, (entity_id, combined_score))| HybridSearchResult {
                entity_id: entity_id.clone(),
                combined_score,
                vector_score: vector_scores.get(&entity_id).copied(),
                bm25_score: bm25_scores.get(&entity_id).copied(),
                rank: rank + 1,
            })
            .collect()
    }

    /// Search using weighted linear combination instead of RRF
    pub fn weighted_search(
        &self,
        query_vector: &[f32],
        query_text: &str,
        k: usize,
    ) -> Result<Vec<HybridSearchResult>> {
        if !self.is_built {
            return Err(anyhow!("Index not built. Call build() first"));
        }

        let expanded_k = (k * 3).min(self.entity_ids.len());

        // Vector search
        let vector_results = self.vector_index.search(query_vector, expanded_k)?;

        // BM25 search
        let bm25_results = self.bm25_index.search(query_text, expanded_k);

        // Normalize and combine scores
        let mut combined_scores: HashMap<String, (Option<f32>, Option<f32>)> = HashMap::new();

        // Normalize vector scores (already in 0-1 for cosine)
        let max_vector_score = vector_results.first().map(|r| r.score).unwrap_or(1.0);
        for result in &vector_results {
            let norm_score = if max_vector_score > 0.0 {
                result.score / max_vector_score
            } else {
                0.0
            };
            combined_scores.insert(result.entity_id.clone(), (Some(norm_score), None));
        }

        // Normalize BM25 scores
        let max_bm25_score = bm25_results.first().map(|(_, s)| *s).unwrap_or(1.0);
        for (entity_id, score) in &bm25_results {
            let norm_score = if max_bm25_score > 0.0 {
                score / max_bm25_score
            } else {
                0.0
            };
            combined_scores
                .entry(entity_id.clone())
                .and_modify(|(_, b)| *b = Some(norm_score))
                .or_insert((None, Some(norm_score)));
        }

        // Calculate weighted combination
        let mut results: Vec<HybridSearchResult> = combined_scores
            .into_iter()
            .map(|(entity_id, (v_score, b_score))| {
                let v = v_score.unwrap_or(0.0);
                let b = b_score.unwrap_or(0.0);
                let combined = self.config.alpha * v + (1.0 - self.config.alpha) * b;

                HybridSearchResult {
                    entity_id,
                    combined_score: combined,
                    vector_score: v_score,
                    bm25_score: b_score,
                    rank: 0, // Will be set below
                }
            })
            .collect();

        // Sort by combined score
        results.sort_by(|a, b| {
            b.combined_score
                .partial_cmp(&a.combined_score)
                .unwrap_or(std::cmp::Ordering::Equal)
        });

        // Set ranks
        for (i, result) in results.iter_mut().enumerate() {
            result.rank = i + 1;
        }

        results.truncate(k);
        Ok(results)
    }

    /// Vector-only search (alpha = 1.0)
    pub fn vector_search(&self, query: &[f32], k: usize) -> Result<Vec<SearchResult>> {
        self.vector_index.search(query, k)
    }

    /// Keyword-only search (alpha = 0.0)
    pub fn keyword_search(&self, query: &str, k: usize) -> Result<Vec<HybridSearchResult>> {
        if !self.is_built {
            return Err(anyhow!("Index not built. Call build() first"));
        }

        let results = self.bm25_index.search(query, k);

        Ok(results
            .into_iter()
            .enumerate()
            .map(|(rank, (entity_id, score))| HybridSearchResult {
                entity_id,
                combined_score: score,
                vector_score: None,
                bm25_score: Some(score),
                rank: rank + 1,
            })
            .collect())
    }

    /// Get index statistics
    pub fn get_stats(&self) -> HybridStats {
        HybridStats {
            num_documents: self.entity_ids.len(),
            vocabulary_size: self.bm25_index.inverted_index.len(),
            avg_doc_length: self.bm25_index.avg_doc_length,
            alpha: self.config.alpha,
            is_built: self.is_built,
        }
    }

    /// Set alpha parameter (vector vs keyword weight)
    pub fn set_alpha(&mut self, alpha: f32) {
        self.config.alpha = alpha.clamp(0.0, 1.0);
    }
}

/// Hybrid search result
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HybridSearchResult {
    /// Entity ID
    pub entity_id: String,
    /// Combined score from RRF or weighted combination
    pub combined_score: f32,
    /// Vector similarity score (if available)
    pub vector_score: Option<f32>,
    /// BM25 score (if available)
    pub bm25_score: Option<f32>,
    /// Rank in results (1-indexed)
    pub rank: usize,
}

/// Hybrid index statistics
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HybridStats {
    /// Number of documents in the index
    pub num_documents: usize,
    /// Number of unique terms in vocabulary
    pub vocabulary_size: usize,
    /// Average document length (in tokens)
    pub avg_doc_length: f32,
    /// Current alpha setting
    pub alpha: f32,
    /// Whether index is built
    pub is_built: bool,
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::collections::HashSet;

    fn create_test_data() -> (HashMap<String, Vec<f32>>, HashMap<String, String>) {
        let mut embeddings = HashMap::new();
        let mut texts = HashMap::new();

        // Tech document - similar vectors
        embeddings.insert("doc1".to_string(), vec![0.9, 0.1, 0.0]);
        texts.insert(
            "doc1".to_string(),
            "rust programming language systems programming".to_string(),
        );

        embeddings.insert("doc2".to_string(), vec![0.8, 0.2, 0.0]);
        texts.insert(
            "doc2".to_string(),
            "rust cargo package manager dependencies".to_string(),
        );

        // ML document
        embeddings.insert("doc3".to_string(), vec![0.1, 0.9, 0.0]);
        texts.insert(
            "doc3".to_string(),
            "python machine learning deep learning neural networks".to_string(),
        );

        embeddings.insert("doc4".to_string(), vec![0.0, 0.8, 0.2]);
        texts.insert(
            "doc4".to_string(),
            "python data science pandas numpy analysis".to_string(),
        );

        // Mixed
        embeddings.insert("doc5".to_string(), vec![0.5, 0.5, 0.0]);
        texts.insert(
            "doc5".to_string(),
            "rust machine learning inference performance".to_string(),
        );

        (embeddings, texts)
    }

    #[test]
    fn test_hybrid_config_default() {
        let config = HybridConfig::default();
        assert_eq!(config.alpha, 0.5);
        assert_eq!(config.rrf_k, 60.0);
    }

    #[test]
    fn test_hybrid_build() {
        let (embeddings, texts) = create_test_data();
        let mut index = HybridIndex::new(HybridConfig::default());

        assert!(index.build(&embeddings, &texts).is_ok());
        assert!(index.is_built);

        let stats = index.get_stats();
        assert_eq!(stats.num_documents, 5);
        assert!(stats.vocabulary_size > 0);
    }

    #[test]
    fn test_hybrid_search() {
        let (embeddings, texts) = create_test_data();
        let mut index = HybridIndex::new(HybridConfig::default());
        index.build(&embeddings, &texts).unwrap();

        // Search for rust programming
        let query_vector = vec![0.85, 0.15, 0.0];
        let query_text = "rust programming";
        let results = index.search(&query_vector, query_text, 3).unwrap();

        assert_eq!(results.len(), 3);
        // doc1 or doc2 should be top results (both vector and keyword match)
        assert!(results[0].entity_id == "doc1" || results[0].entity_id == "doc2");
    }

    #[test]
    fn test_weighted_search() {
        let (embeddings, texts) = create_test_data();
        let mut index = HybridIndex::new(HybridConfig::default());
        index.build(&embeddings, &texts).unwrap();

        let query_vector = vec![0.85, 0.15, 0.0];
        let query_text = "rust programming";
        let results = index.weighted_search(&query_vector, query_text, 3).unwrap();

        assert_eq!(results.len(), 3);
        // Results should have both vector and BM25 scores
        assert!(results[0].vector_score.is_some() || results[0].bm25_score.is_some());
    }

    #[test]
    fn test_vector_only_search() {
        let (embeddings, texts) = create_test_data();
        let mut index = HybridIndex::new(HybridConfig::default());
        index.build(&embeddings, &texts).unwrap();

        let query_vector = vec![0.85, 0.15, 0.0];
        let results = index.vector_search(&query_vector, 3).unwrap();

        assert_eq!(results.len(), 3);
    }

    #[test]
    fn test_keyword_only_search() {
        let (embeddings, texts) = create_test_data();
        let mut index = HybridIndex::new(HybridConfig::default());
        index.build(&embeddings, &texts).unwrap();

        let results = index.keyword_search("python machine learning", 3).unwrap();

        assert_eq!(results.len(), 3);
        // doc3 should be top (best keyword match)
        assert!(results[0].entity_id == "doc3" || results[0].entity_id == "doc5");
    }

    #[test]
    fn test_alpha_adjustment() {
        let (embeddings, texts) = create_test_data();
        let mut index = HybridIndex::new(HybridConfig::default());
        index.build(&embeddings, &texts).unwrap();

        index.set_alpha(0.8);
        let stats = index.get_stats();
        assert_eq!(stats.alpha, 0.8);

        // Clamp to valid range
        index.set_alpha(1.5);
        let stats = index.get_stats();
        assert_eq!(stats.alpha, 1.0);
    }

    #[test]
    fn test_bm25_scoring() {
        let (embeddings, texts) = create_test_data();
        let mut index = HybridIndex::new(HybridConfig::default());
        index.build(&embeddings, &texts).unwrap();

        // Search for specific term
        let results = index.keyword_search("rust", 5).unwrap();

        // doc1, doc2, doc5 contain "rust"
        let rust_docs: HashSet<&str> = results.iter().map(|r| r.entity_id.as_str()).collect();
        assert!(rust_docs.contains("doc1"));
        assert!(rust_docs.contains("doc2"));
        assert!(rust_docs.contains("doc5"));
    }

    #[test]
    fn test_empty_query() {
        let (embeddings, texts) = create_test_data();
        let mut index = HybridIndex::new(HybridConfig::default());
        index.build(&embeddings, &texts).unwrap();

        // Empty keyword query
        let results = index.keyword_search("", 3).unwrap();
        assert_eq!(results.len(), 0);
    }

    #[test]
    fn test_missing_text_error() {
        let mut embeddings = HashMap::new();
        embeddings.insert("doc1".to_string(), vec![0.9, 0.1, 0.0]);

        let texts: HashMap<String, String> = HashMap::new(); // Empty

        let mut index = HybridIndex::new(HybridConfig::default());
        assert!(index.build(&embeddings, &texts).is_err());
    }
}