minimemory 3.0.0

Embedded vector database library for Rust - like SQLite for vectors
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
//! Motor de búsqueda híbrida.
//!
//! Combina búsqueda vectorial, BM25 y filtros de metadata.

use crate::distance::Distance;
use crate::error::{Error, Result};
use crate::index::{BM25Index, Index};
use crate::query::{compare_metadata_values, Filter, FilterEvaluator, OrderBy, SortDirection};
use crate::storage::Storage;
use crate::types::HybridSearchResult;

use super::rrf::{weighted_reciprocal_rank_fusion, RankedResult, DEFAULT_RRF_K};

/// Modo de búsqueda.
#[derive(Debug, Clone, Default)]
pub enum SearchMode {
    /// Solo búsqueda vectorial (similitud)
    #[default]
    Vector,
    /// Solo búsqueda keyword (BM25)
    Keyword,
    /// Híbrida: vector + keyword con RRF
    Hybrid {
        /// Peso para resultados vectoriales (0.0-1.0)
        vector_weight: f32,
        /// Peso para resultados keyword (0.0-1.0)
        keyword_weight: f32,
    },
    /// Solo filtro de metadata (sin ranking por similitud)
    FilterOnly,
}

/// Parámetros de búsqueda híbrida.
#[derive(Debug, Clone)]
pub struct HybridSearchParams {
    /// Vector de consulta (requerido para Vector/Hybrid)
    pub vector: Option<Vec<f32>>,
    /// Query de texto (requerido para Keyword/Hybrid)
    pub text_query: Option<String>,
    /// Filtro de metadata (opcional)
    pub filter: Option<Filter>,
    /// Modo de búsqueda
    pub mode: SearchMode,
    /// Número de resultados
    pub k: usize,
    /// Number of results to skip (for pagination)
    pub offset: usize,
    /// Sort results by a metadata field (overrides default score-based ordering)
    pub order_by: Option<OrderBy>,
}

impl HybridSearchParams {
    /// Crea parámetros para búsqueda vectorial.
    pub fn vector(query: Vec<f32>, k: usize) -> Self {
        Self {
            vector: Some(query),
            text_query: None,
            filter: None,
            mode: SearchMode::Vector,
            k,
            offset: 0,
            order_by: None,
        }
    }

    /// Crea parámetros para búsqueda por keyword.
    pub fn keyword(query: impl Into<String>, k: usize) -> Self {
        Self {
            vector: None,
            text_query: Some(query.into()),
            filter: None,
            mode: SearchMode::Keyword,
            k,
            offset: 0,
            order_by: None,
        }
    }

    /// Crea parámetros para búsqueda híbrida.
    pub fn hybrid(vector: Vec<f32>, text: impl Into<String>, k: usize) -> Self {
        Self {
            vector: Some(vector),
            text_query: Some(text.into()),
            filter: None,
            mode: SearchMode::Hybrid {
                vector_weight: 0.5,
                keyword_weight: 0.5,
            },
            k,
            offset: 0,
            order_by: None,
        }
    }

    /// Crea parámetros para búsqueda solo por filtro.
    pub fn filter_only(filter: Filter, limit: usize) -> Self {
        Self {
            vector: None,
            text_query: None,
            filter: Some(filter),
            mode: SearchMode::FilterOnly,
            k: limit,
            offset: 0,
            order_by: None,
        }
    }

    /// Añade un filtro de metadata.
    pub fn with_filter(mut self, filter: Filter) -> Self {
        self.filter = Some(filter);
        self
    }

    /// Sets the offset for pagination (skip N results).
    pub fn with_offset(mut self, offset: usize) -> Self {
        self.offset = offset;
        self
    }

    /// Sets the ordering by a metadata field (overrides default score ordering).
    pub fn with_order_by(mut self, order: OrderBy) -> Self {
        self.order_by = Some(order);
        self
    }

    /// Configura los pesos para búsqueda híbrida.
    pub fn with_weights(mut self, vector_weight: f32, keyword_weight: f32) -> Self {
        self.mode = SearchMode::Hybrid {
            vector_weight,
            keyword_weight,
        };
        self
    }
}

/// Motor de búsqueda híbrida.
pub struct HybridSearch;

impl HybridSearch {
    /// Ejecuta búsqueda híbrida.
    ///
    /// # Arguments
    /// * `params` - Parámetros de búsqueda
    /// * `vector_index` - Índice vectorial
    /// * `bm25_index` - Índice BM25 (opcional)
    /// * `storage` - Storage de documentos
    /// * `distance` - Métrica de distancia
    pub fn search(
        params: &HybridSearchParams,
        vector_index: &dyn Index,
        bm25_index: Option<&BM25Index>,
        storage: &dyn Storage,
        distance: Distance,
    ) -> Result<Vec<HybridSearchResult>> {
        let mut results = match &params.mode {
            SearchMode::Vector => Self::vector_search(params, vector_index, storage, distance)?,
            SearchMode::Keyword => Self::keyword_search(params, bm25_index, storage)?,
            SearchMode::Hybrid {
                vector_weight,
                keyword_weight,
            } => Self::hybrid_search(
                params,
                vector_index,
                bm25_index,
                storage,
                distance,
                *vector_weight,
                *keyword_weight,
            )?,
            SearchMode::FilterOnly => Self::filter_only_search(params, storage)?,
        };

        // Filter out soft-deleted documents (metadata "deleted" = true)
        results.retain(|r| {
            !matches!(
                r.metadata.as_ref().and_then(|m| m.get("deleted")),
                Some(crate::types::MetadataValue::Bool(true))
            )
        });

        // Apply ORDER BY if specified (overrides default score ordering)
        if let Some(ref order) = params.order_by {
            let field = &order.field;
            results.sort_by(|a, b| {
                let val_a = a.metadata.as_ref().and_then(|m| m.get(field));
                let val_b = b.metadata.as_ref().and_then(|m| m.get(field));
                let cmp = compare_metadata_values(val_a, val_b);
                match order.direction {
                    SortDirection::Asc => cmp,
                    SortDirection::Desc => cmp.reverse(),
                }
            });
        }

        // Apply OFFSET (pagination)
        if params.offset > 0 {
            if params.offset >= results.len() {
                return Ok(vec![]);
            }
            results = results.into_iter().skip(params.offset).collect();
        }

        // Apply LIMIT (k) — sub-methods already apply k, but after re-sorting
        // the order may differ, so re-apply
        if let Some(ref _order) = params.order_by {
            results.truncate(params.k);
        }

        Ok(results)
    }

    fn vector_search(
        params: &HybridSearchParams,
        index: &dyn Index,
        storage: &dyn Storage,
        distance: Distance,
    ) -> Result<Vec<HybridSearchResult>> {
        let query = params.vector.as_ref().ok_or_else(|| {
            Error::InvalidConfig("Vector query required for vector search".into())
        })?;

        // Buscar más resultados si hay filtro (pre-filter approach)
        let search_k = if params.filter.is_some() {
            params.k * 10 // Buscar 10x más para compensar filtrado
        } else {
            params.k
        };

        let results = index.search(query, search_k, storage, distance)?;

        // Aplicar filtro
        let filtered: Vec<_> = results
            .into_iter()
            .filter(|r| {
                if let Some(filter) = &params.filter {
                    FilterEvaluator::evaluate(filter, r.metadata.as_ref())
                } else {
                    true
                }
            })
            .take(params.k)
            .enumerate()
            .map(|(rank, r)| HybridSearchResult {
                id: r.id,
                score: r.distance, // Menor = mejor
                vector_distance: Some(r.distance),
                bm25_score: None,
                vector_rank: Some(rank),
                keyword_rank: None,
                metadata: r.metadata,
            })
            .collect();

        Ok(filtered)
    }

    fn keyword_search(
        params: &HybridSearchParams,
        bm25_index: Option<&BM25Index>,
        storage: &dyn Storage,
    ) -> Result<Vec<HybridSearchResult>> {
        let query = params
            .text_query
            .as_ref()
            .ok_or_else(|| Error::InvalidConfig("Text query required for keyword search".into()))?;

        let index = bm25_index
            .ok_or_else(|| Error::InvalidConfig("BM25 index required for keyword search".into()))?;

        let search_k = if params.filter.is_some() {
            params.k * 10
        } else {
            params.k
        };

        let results = index.search(query, search_k);

        let mut hybrid_results = Vec::new();
        for (rank, result) in results.into_iter().enumerate() {
            if let Ok(Some(doc)) = storage.get(&result.id) {
                // Aplicar filtro
                if let Some(filter) = &params.filter {
                    if !FilterEvaluator::evaluate(filter, doc.metadata.as_ref()) {
                        continue;
                    }
                }

                hybrid_results.push(HybridSearchResult {
                    id: result.id,
                    score: -result.score, // Negativo para que menor = mejor (consistente con distance)
                    vector_distance: None,
                    bm25_score: Some(result.score),
                    vector_rank: None,
                    keyword_rank: Some(rank),
                    metadata: doc.metadata,
                });

                if hybrid_results.len() >= params.k {
                    break;
                }
            }
        }

        Ok(hybrid_results)
    }

    fn hybrid_search(
        params: &HybridSearchParams,
        vector_index: &dyn Index,
        bm25_index: Option<&BM25Index>,
        storage: &dyn Storage,
        distance: Distance,
        vector_weight: f32,
        keyword_weight: f32,
    ) -> Result<Vec<HybridSearchResult>> {
        // Obtener resultados de ambas búsquedas
        let fetch_k = params.k * 3; // Fetch más para RRF

        // Vector search
        let vector_results = if let Some(query) = &params.vector {
            let results = vector_index.search(query, fetch_k, storage, distance)?;
            results
                .into_iter()
                .enumerate()
                .map(|(rank, r)| RankedResult {
                    id: r.id,
                    rank,
                    original_score: r.distance,
                })
                .collect()
        } else {
            Vec::new()
        };

        // Keyword search
        let keyword_results = if let (Some(query), Some(index)) = (&params.text_query, bm25_index) {
            index
                .search(query, fetch_k)
                .into_iter()
                .enumerate()
                .map(|(rank, result)| RankedResult {
                    id: result.id,
                    rank,
                    original_score: result.score,
                })
                .collect()
        } else {
            Vec::new()
        };

        // Guardar info original para lookups
        let vector_info: std::collections::HashMap<_, _> = vector_results
            .iter()
            .map(|r| (r.id.clone(), (r.rank, r.original_score)))
            .collect();

        let keyword_info: std::collections::HashMap<_, _> = keyword_results
            .iter()
            .map(|r| (r.id.clone(), (r.rank, r.original_score)))
            .collect();

        // Aplicar RRF con pesos
        let rrf_results = weighted_reciprocal_rank_fusion(
            vec![
                (vector_results, vector_weight),
                (keyword_results, keyword_weight),
            ],
            DEFAULT_RRF_K,
        );

        // Construir resultados finales
        let mut final_results = Vec::new();
        for (id, rrf_score) in rrf_results {
            if let Ok(Some(doc)) = storage.get(&id) {
                // Aplicar filtro
                if let Some(filter) = &params.filter {
                    if !FilterEvaluator::evaluate(filter, doc.metadata.as_ref()) {
                        continue;
                    }
                }

                let (vec_rank, vec_dist) = vector_info
                    .get(&id)
                    .map(|(r, d)| (Some(*r), Some(*d)))
                    .unwrap_or((None, None));

                let (kw_rank, kw_score) = keyword_info
                    .get(&id)
                    .map(|(r, s)| (Some(*r), Some(*s)))
                    .unwrap_or((None, None));

                final_results.push(HybridSearchResult {
                    id,
                    score: -rrf_score, // Negativo para que menor = mejor
                    vector_distance: vec_dist,
                    bm25_score: kw_score,
                    vector_rank: vec_rank,
                    keyword_rank: kw_rank,
                    metadata: doc.metadata,
                });

                if final_results.len() >= params.k {
                    break;
                }
            }
        }

        Ok(final_results)
    }

    fn filter_only_search(
        params: &HybridSearchParams,
        storage: &dyn Storage,
    ) -> Result<Vec<HybridSearchResult>> {
        let filter = params
            .filter
            .as_ref()
            .ok_or_else(|| Error::InvalidConfig("Filter required for filter-only search".into()))?;

        // When ORDER BY or OFFSET is used, collect all matching results
        // so sorting and pagination can be applied in the central search() method.
        // When ORDER BY or OFFSET is used, collect all matching results
        // so sorting and pagination can be applied in the central search() method.
        // Cap at 100_000 to prevent OOM on huge datasets.
        let need_all = params.order_by.is_some() || params.offset > 0;
        let take_limit = if need_all {
            100_000
        } else {
            params.k
        };

        let results: Vec<_> = storage
            .iter()
            .filter(|doc| FilterEvaluator::evaluate(filter, doc.metadata.as_ref()))
            .take(take_limit)
            .map(|doc| HybridSearchResult {
                id: doc.id,
                score: 0.0, // Sin ranking
                vector_distance: None,
                bm25_score: None,
                vector_rank: None,
                keyword_rank: None,
                metadata: doc.metadata,
            })
            .collect();

        Ok(results)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::index::FlatIndex;
    use crate::storage::MemoryStorage;
    use crate::types::Metadata;
    use std::sync::Arc;

    fn setup_test_data() -> (Arc<MemoryStorage>, Arc<FlatIndex>, Arc<BM25Index>) {
        let storage = Arc::new(MemoryStorage::new());
        let vector_index = Arc::new(FlatIndex::new());
        let bm25_index = Arc::new(BM25Index::new(vec!["title".into(), "content".into()]));

        // Doc 1: About Rust
        let mut meta1 = Metadata::new();
        meta1.insert("title", "Rust Programming");
        meta1.insert("content", "Learn Rust systems programming");
        meta1.insert("category", "tech");
        storage
            .insert(
                "doc-1".into(),
                Some(vec![1.0, 0.0, 0.0]),
                Some(meta1.clone()),
            )
            .unwrap();
        vector_index
            .add("doc-1", &[1.0, 0.0, 0.0], &*storage, Distance::Cosine)
            .unwrap();
        bm25_index.add("doc-1", Some(&meta1)).unwrap();

        // Doc 2: About Python
        let mut meta2 = Metadata::new();
        meta2.insert("title", "Python Guide");
        meta2.insert("content", "Python for beginners programming");
        meta2.insert("category", "tech");
        storage
            .insert(
                "doc-2".into(),
                Some(vec![0.0, 1.0, 0.0]),
                Some(meta2.clone()),
            )
            .unwrap();
        vector_index
            .add("doc-2", &[0.0, 1.0, 0.0], &*storage, Distance::Cosine)
            .unwrap();
        bm25_index.add("doc-2", Some(&meta2)).unwrap();

        // Doc 3: About Cooking (different category)
        let mut meta3 = Metadata::new();
        meta3.insert("title", "Cooking Recipes");
        meta3.insert("content", "Delicious food recipes");
        meta3.insert("category", "food");
        storage
            .insert(
                "doc-3".into(),
                Some(vec![0.0, 0.0, 1.0]),
                Some(meta3.clone()),
            )
            .unwrap();
        vector_index
            .add("doc-3", &[0.0, 0.0, 1.0], &*storage, Distance::Cosine)
            .unwrap();
        bm25_index.add("doc-3", Some(&meta3)).unwrap();

        (storage, vector_index, bm25_index)
    }

    #[test]
    fn test_vector_search() {
        let (storage, vector_index, _) = setup_test_data();

        let params = HybridSearchParams::vector(vec![1.0, 0.0, 0.0], 2);
        let results = HybridSearch::search(
            &params,
            vector_index.as_ref(),
            None,
            storage.as_ref(),
            Distance::Euclidean,
        )
        .unwrap();

        assert_eq!(results.len(), 2);
        assert_eq!(results[0].id, "doc-1"); // Closest to query
    }

    #[test]
    fn test_keyword_search() {
        let (storage, _, bm25_index) = setup_test_data();
        let vector_index = FlatIndex::new();

        let params = HybridSearchParams::keyword("rust programming", 2);
        let results = HybridSearch::search(
            &params,
            &vector_index,
            Some(bm25_index.as_ref()),
            storage.as_ref(),
            Distance::Euclidean,
        )
        .unwrap();

        assert!(!results.is_empty());
        assert_eq!(results[0].id, "doc-1"); // Has "rust" and "programming"
    }

    #[test]
    fn test_hybrid_search() {
        let (storage, vector_index, bm25_index) = setup_test_data();

        let params = HybridSearchParams::hybrid(
            vec![0.0, 1.0, 0.0], // Closest to doc-2
            "rust",              // Matches doc-1
            3,
        );

        let results = HybridSearch::search(
            &params,
            vector_index.as_ref(),
            Some(bm25_index.as_ref()),
            storage.as_ref(),
            Distance::Euclidean,
        )
        .unwrap();

        assert!(!results.is_empty());
        // Both doc-1 (rust keyword) and doc-2 (vector) should be in results
    }

    #[test]
    fn test_filter_search() {
        let (storage, vector_index, _) = setup_test_data();

        let filter = Filter::eq("category", "tech");
        let params = HybridSearchParams::vector(vec![0.5, 0.5, 0.0], 10).with_filter(filter);

        let results = HybridSearch::search(
            &params,
            vector_index.as_ref(),
            None,
            storage.as_ref(),
            Distance::Euclidean,
        )
        .unwrap();

        // Should only return tech category (doc-1 and doc-2)
        assert_eq!(results.len(), 2);
        for r in &results {
            assert!(r.id == "doc-1" || r.id == "doc-2");
        }
    }

    #[test]
    fn test_filter_only_search() {
        let (storage, vector_index, _) = setup_test_data();

        let filter = Filter::eq("category", "food");
        let params = HybridSearchParams::filter_only(filter, 10);

        let results = HybridSearch::search(
            &params,
            vector_index.as_ref(),
            None,
            storage.as_ref(),
            Distance::Euclidean,
        )
        .unwrap();

        assert_eq!(results.len(), 1);
        assert_eq!(results[0].id, "doc-3");
    }
}