dakera-engine 0.10.1

Vector search engine for the Dakera AI memory platform
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
use std::collections::HashMap;
use std::sync::Arc;

use common::{
    DakeraError, DistanceMetric, NamespaceId, PaginationCursor, QueryRequest, QueryResponse,
    Result, SearchResult,
};
use parking_lot::RwLock;
use storage::VectorStorage;

use crate::filter::evaluate_filter;
use crate::hnsw::{HnswConfig, HnswIndex};
use crate::search::brute_force_search;

/// Default vector count threshold above which HNSW is used instead of brute force
const DEFAULT_ANN_THRESHOLD: usize = 1000;

/// Over-fetch multiplier applied to top_k when filtering post-HNSW.
/// ANN returns more candidates than needed so metadata filtering has sufficient
/// results to choose from before truncating to the caller's top_k.
const ANN_FILTER_OVERFETCH_FACTOR: usize = 4;

/// Convert HNSW distance back to similarity score (inverse of hnsw::similarity_to_distance)
#[inline]
fn distance_to_similarity(distance: f32, metric: DistanceMetric) -> f32 {
    match metric {
        DistanceMetric::Cosine => 1.0 - distance,
        DistanceMetric::Euclidean => -distance,
        DistanceMetric::DotProduct => -distance,
    }
}

/// Read ANN threshold from environment variable
fn ann_threshold_from_env() -> usize {
    std::env::var("DAKERA_ANN_THRESHOLD")
        .ok()
        .and_then(|v| v.parse().ok())
        .unwrap_or(DEFAULT_ANN_THRESHOLD)
}

/// Main search engine that coordinates storage and search operations
pub struct SearchEngine<S: VectorStorage + ?Sized> {
    storage: Arc<S>,
    /// Cached HNSW indices per namespace for ANN acceleration
    ann_indices: RwLock<HashMap<String, Arc<HnswIndex>>>,
    /// Vector count threshold above which HNSW is used
    ann_threshold: usize,
}

impl<S: VectorStorage + ?Sized> SearchEngine<S> {
    pub fn new(storage: Arc<S>) -> Self {
        Self {
            storage,
            ann_indices: RwLock::new(HashMap::new()),
            ann_threshold: ann_threshold_from_env(),
        }
    }

    /// Perform vector search in a namespace
    pub async fn search(
        &self,
        namespace: &NamespaceId,
        request: &QueryRequest,
    ) -> Result<QueryResponse> {
        // Check if namespace exists
        if !self.storage.namespace_exists(namespace).await? {
            return Err(DakeraError::NamespaceNotFound(namespace.clone()));
        }

        // Validate query dimension against namespace dimension
        if let Some(expected_dim) = self.storage.dimension(namespace).await? {
            if request.vector.len() != expected_dim {
                return Err(DakeraError::DimensionMismatch {
                    expected: expected_dim,
                    actual: request.vector.len(),
                });
            }
        }

        // Determine if we can use ANN acceleration:
        // - No cursor pagination (HNSW returns top-k directly)
        // - Namespace has enough vectors to justify index overhead
        // Note: filtered queries are supported via post-filter ANN (over-fetch from HNSW then
        // apply evaluate_filter on candidates). This restores O(log N) behaviour for the
        // filtered queries that dominate production traffic (agent_id, tags, min_importance).
        let use_ann = request.cursor.is_none() && self.ann_threshold > 0;

        if use_ann {
            let count = self.storage.count(namespace).await?;
            if count > self.ann_threshold {
                return self.ann_search(namespace, request, count).await;
            }
        }

        // Fall through to brute-force search
        self.brute_force_path(namespace, request).await
    }

    /// Brute-force search path (original behavior)
    async fn brute_force_path(
        &self,
        namespace: &NamespaceId,
        request: &QueryRequest,
    ) -> Result<QueryResponse> {
        let vectors = self.storage.get_all(namespace).await?;

        let filtered_vectors: Vec<_> = if let Some(ref filter) = request.filter {
            vectors
                .into_iter()
                .filter(|v| evaluate_filter(filter, v.metadata.as_ref()))
                .collect()
        } else {
            vectors
        };

        let cursor = request
            .cursor
            .as_ref()
            .and_then(|c| PaginationCursor::decode(c));

        tracing::debug!(
            namespace = %namespace,
            vector_count = filtered_vectors.len(),
            top_k = request.top_k,
            metric = ?request.distance_metric,
            has_filter = request.filter.is_some(),
            has_cursor = cursor.is_some(),
            "Performing brute-force search"
        );

        let response = brute_force_search(
            &request.vector,
            &filtered_vectors,
            request.top_k,
            request.distance_metric,
            request.include_metadata,
            request.include_vectors,
            cursor.as_ref(),
        );

        Ok(response)
    }

    /// ANN search path using cached HNSW index
    async fn ann_search(
        &self,
        namespace: &NamespaceId,
        request: &QueryRequest,
        vector_count: usize,
    ) -> Result<QueryResponse> {
        // Get or build the HNSW index for this namespace
        let index = self
            .get_or_build_index(namespace, request.distance_metric)
            .await?;

        let has_filter = request.filter.is_some();

        // Over-fetch when a filter is present: HNSW may return candidates that fail the
        // filter, so we ask for more than top_k and truncate after filtering.
        let hnsw_top_k = if has_filter {
            request.top_k.saturating_mul(ANN_FILTER_OVERFETCH_FACTOR)
        } else {
            request.top_k
        };

        tracing::debug!(
            namespace = %namespace,
            vector_count = vector_count,
            top_k = request.top_k,
            hnsw_top_k,
            has_filter,
            metric = ?request.distance_metric,
            "Performing ANN search (HNSW)"
        );

        // Search the HNSW index — returns (VectorId, distance) sorted by score
        let hnsw_results = index.search(&request.vector, hnsw_top_k);

        // Fetch metadata when caller wants it or when we need to evaluate the filter
        let need_fetch = request.include_metadata || request.include_vectors || has_filter;
        let fetched = if need_fetch && !hnsw_results.is_empty() {
            let ids: Vec<String> = hnsw_results.iter().map(|(id, _)| id.clone()).collect();
            let vectors = self.storage.get(namespace, &ids).await?;
            let map: HashMap<String, _> = vectors.into_iter().map(|v| (v.id.clone(), v)).collect();
            Some(map)
        } else {
            None
        };

        // Convert HNSW results to SearchResults, applying post-filter when present
        let mut results: Vec<SearchResult> = hnsw_results
            .into_iter()
            .filter_map(|(id, distance)| {
                let score = distance_to_similarity(distance, request.distance_metric);
                let entry = fetched.as_ref().and_then(|map| map.get(&id));

                // Post-filter: drop candidates that do not match the filter expression
                if let Some(ref filter) = request.filter {
                    let metadata = entry.and_then(|v| v.metadata.as_ref());
                    if !evaluate_filter(filter, metadata) {
                        return None;
                    }
                }

                let (metadata, vector) = if let Some(v) = entry {
                    (
                        if request.include_metadata {
                            v.metadata.clone()
                        } else {
                            None
                        },
                        if request.include_vectors {
                            Some(v.values.clone())
                        } else {
                            None
                        },
                    )
                } else {
                    (None, None)
                };
                Some(SearchResult {
                    id,
                    score,
                    metadata,
                    vector,
                })
            })
            .collect();

        // Truncate to the caller's requested top_k (over-fetch may have returned more)
        results.truncate(request.top_k);

        Ok(QueryResponse {
            results,
            next_cursor: None,
            has_more: Some(false),
            search_time_ms: 0, // caller typically overwrites this
        })
    }

    /// Get cached HNSW index or build one from storage
    async fn get_or_build_index(
        &self,
        namespace: &NamespaceId,
        metric: DistanceMetric,
    ) -> Result<Arc<HnswIndex>> {
        // Fast path: check read lock
        {
            let indices = self.ann_indices.read();
            if let Some(index) = indices.get(namespace.as_str()) {
                return Ok(Arc::clone(index));
            }
        }

        // Slow path: build index from storage
        tracing::info!(namespace = %namespace, "Building HNSW index for ANN acceleration");
        let vectors = self.storage.get_all(namespace).await?;

        let config = HnswConfig::default().with_distance_metric(metric);
        let index = HnswIndex::with_config(config);

        for v in &vectors {
            index.insert(v.id.clone(), v.values.clone());
        }

        let index = Arc::new(index);

        // Cache it
        {
            let mut indices = self.ann_indices.write();
            indices.insert(namespace.clone(), Arc::clone(&index));
        }

        tracing::info!(
            namespace = %namespace,
            vectors = vectors.len(),
            "HNSW index built and cached"
        );

        Ok(index)
    }

    /// Invalidate the cached HNSW index for a namespace (call after upsert/delete)
    pub fn invalidate_ann_index(&self, namespace: &NamespaceId) {
        let mut indices = self.ann_indices.write();
        if indices.remove(namespace.as_str()).is_some() {
            tracing::debug!(namespace = %namespace, "HNSW index invalidated");
        }
    }

    /// Get reference to storage
    pub fn storage(&self) -> &Arc<S> {
        &self.storage
    }

    /// Create engine with an explicit ANN threshold (for tests only)
    #[cfg(test)]
    pub fn new_with_threshold(storage: Arc<S>, ann_threshold: usize) -> Self {
        Self {
            storage,
            ann_indices: RwLock::new(HashMap::new()),
            ann_threshold,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use common::{DistanceMetric, FilterCondition, FilterExpression, FilterValue, Vector};
    use std::collections::HashMap;
    use storage::InMemoryStorage;

    async fn setup_engine() -> (SearchEngine<InMemoryStorage>, String) {
        let storage = Arc::new(InMemoryStorage::new());
        let engine = SearchEngine::new(storage.clone());
        let namespace = "test".to_string();

        storage.ensure_namespace(&namespace).await.unwrap();
        storage
            .upsert(
                &namespace,
                vec![
                    Vector {
                        id: "v1".to_string(),
                        values: vec![1.0, 0.0, 0.0],
                        metadata: None,
                        ttl_seconds: None,
                        expires_at: None,
                    },
                    Vector {
                        id: "v2".to_string(),
                        values: vec![0.0, 1.0, 0.0],
                        metadata: None,
                        ttl_seconds: None,
                        expires_at: None,
                    },
                    Vector {
                        id: "v3".to_string(),
                        values: vec![0.707, 0.707, 0.0],
                        metadata: None,
                        ttl_seconds: None,
                        expires_at: None,
                    },
                ],
            )
            .await
            .unwrap();

        (engine, namespace)
    }

    #[tokio::test]
    async fn test_search_basic() {
        let (engine, namespace) = setup_engine().await;

        let request = QueryRequest {
            vector: vec![1.0, 0.0, 0.0],
            top_k: 2,
            distance_metric: DistanceMetric::Cosine,
            include_metadata: true,
            include_vectors: false,
            filter: None,
            cursor: None,
            consistency: Default::default(),
            staleness_config: None,
        };

        let response = engine.search(&namespace, &request).await.unwrap();

        assert_eq!(response.results.len(), 2);
        assert_eq!(response.results[0].id, "v1"); // Perfect match
    }

    #[tokio::test]
    async fn test_search_namespace_not_found() {
        let storage = Arc::new(InMemoryStorage::new());
        let engine = SearchEngine::new(storage);

        let request = QueryRequest {
            vector: vec![1.0, 0.0, 0.0],
            top_k: 5,
            distance_metric: DistanceMetric::Cosine,
            include_metadata: true,
            include_vectors: false,
            filter: None,
            cursor: None,
            consistency: Default::default(),
            staleness_config: None,
        };

        let result = engine.search(&"nonexistent".to_string(), &request).await;

        assert!(matches!(result, Err(DakeraError::NamespaceNotFound(_))));
    }

    #[tokio::test]
    async fn test_search_dimension_mismatch() {
        let (engine, namespace) = setup_engine().await;

        let request = QueryRequest {
            vector: vec![1.0, 0.0], // Wrong dimension (2 instead of 3)
            top_k: 5,
            distance_metric: DistanceMetric::Cosine,
            include_metadata: true,
            include_vectors: false,
            filter: None,
            cursor: None,
            consistency: Default::default(),
            staleness_config: None,
        };

        let result = engine.search(&namespace, &request).await;

        assert!(matches!(
            result,
            Err(DakeraError::DimensionMismatch {
                expected: 3,
                actual: 2
            })
        ));
    }

    #[tokio::test]
    async fn test_search_empty_namespace() {
        let storage = Arc::new(InMemoryStorage::new());
        let engine = SearchEngine::new(storage.clone());
        let namespace = "empty".to_string();

        storage.ensure_namespace(&namespace).await.unwrap();

        let request = QueryRequest {
            vector: vec![1.0, 0.0, 0.0],
            top_k: 5,
            distance_metric: DistanceMetric::Cosine,
            include_metadata: true,
            include_vectors: false,
            filter: None,
            cursor: None,
            consistency: Default::default(),
            staleness_config: None,
        };

        let response = engine.search(&namespace, &request).await.unwrap();

        assert!(response.results.is_empty());
    }

    #[tokio::test]
    async fn test_search_with_filter() {
        let storage = Arc::new(InMemoryStorage::new());
        let engine = SearchEngine::new(storage.clone());
        let namespace = "test".to_string();

        storage.ensure_namespace(&namespace).await.unwrap();
        storage
            .upsert(
                &namespace,
                vec![
                    Vector {
                        id: "v1".to_string(),
                        values: vec![1.0, 0.0, 0.0],
                        metadata: Some(
                            serde_json::json!({"category": "electronics", "price": 100}),
                        ),
                        ttl_seconds: None,
                        expires_at: None,
                    },
                    Vector {
                        id: "v2".to_string(),
                        values: vec![0.9, 0.1, 0.0],
                        metadata: Some(serde_json::json!({"category": "books", "price": 20})),
                        ttl_seconds: None,
                        expires_at: None,
                    },
                    Vector {
                        id: "v3".to_string(),
                        values: vec![0.8, 0.2, 0.0],
                        metadata: Some(serde_json::json!({"category": "electronics", "price": 50})),
                        ttl_seconds: None,
                        expires_at: None,
                    },
                ],
            )
            .await
            .unwrap();

        // Filter for electronics only
        let mut field = HashMap::new();
        field.insert(
            "category".to_string(),
            FilterCondition::Eq(FilterValue::String("electronics".to_string())),
        );

        let request = QueryRequest {
            vector: vec![1.0, 0.0, 0.0],
            top_k: 10,
            distance_metric: DistanceMetric::Cosine,
            include_metadata: true,
            include_vectors: false,
            filter: Some(FilterExpression::Field { field }),
            cursor: None,
            consistency: Default::default(),
            staleness_config: None,
        };

        let response = engine.search(&namespace, &request).await.unwrap();

        // Should only return v1 and v3 (electronics)
        assert_eq!(response.results.len(), 2);
        assert!(response
            .results
            .iter()
            .all(|r| r.id == "v1" || r.id == "v3"));
    }

    #[tokio::test]
    async fn test_search_with_numeric_filter() {
        let storage = Arc::new(InMemoryStorage::new());
        let engine = SearchEngine::new(storage.clone());
        let namespace = "test".to_string();

        storage.ensure_namespace(&namespace).await.unwrap();
        storage
            .upsert(
                &namespace,
                vec![
                    Vector {
                        id: "v1".to_string(),
                        values: vec![1.0, 0.0, 0.0],
                        metadata: Some(serde_json::json!({"price": 100})),
                        ttl_seconds: None,
                        expires_at: None,
                    },
                    Vector {
                        id: "v2".to_string(),
                        values: vec![0.9, 0.1, 0.0],
                        metadata: Some(serde_json::json!({"price": 20})),
                        ttl_seconds: None,
                        expires_at: None,
                    },
                    Vector {
                        id: "v3".to_string(),
                        values: vec![0.8, 0.2, 0.0],
                        metadata: Some(serde_json::json!({"price": 50})),
                        ttl_seconds: None,
                        expires_at: None,
                    },
                ],
            )
            .await
            .unwrap();

        // Filter for price < 60
        let mut field = HashMap::new();
        field.insert(
            "price".to_string(),
            FilterCondition::Lt(FilterValue::Number(60.0)),
        );

        let request = QueryRequest {
            vector: vec![1.0, 0.0, 0.0],
            top_k: 10,
            distance_metric: DistanceMetric::Cosine,
            include_metadata: true,
            include_vectors: false,
            filter: Some(FilterExpression::Field { field }),
            cursor: None,
            consistency: Default::default(),
            staleness_config: None,
        };

        let response = engine.search(&namespace, &request).await.unwrap();

        // Should only return v2 (20) and v3 (50)
        assert_eq!(response.results.len(), 2);
        assert!(response
            .results
            .iter()
            .all(|r| r.id == "v2" || r.id == "v3"));
    }

    /// Verify that HNSW (ANN) path correctly applies post-filter when the namespace
    /// exceeds the threshold.  Uses a low threshold (2) so a 3-vector namespace
    /// exercises the ANN code path.
    #[tokio::test]
    async fn test_ann_search_with_filter() {
        let storage = Arc::new(InMemoryStorage::new());
        // Threshold of 2 forces HNSW for a 3-vector namespace
        let engine = SearchEngine::new_with_threshold(storage.clone(), 2);
        let namespace = "test_ann_filter".to_string();

        storage.ensure_namespace(&namespace).await.unwrap();
        storage
            .upsert(
                &namespace,
                vec![
                    Vector {
                        id: "v1".to_string(),
                        values: vec![1.0, 0.0, 0.0],
                        metadata: Some(serde_json::json!({"category": "electronics"})),
                        ttl_seconds: None,
                        expires_at: None,
                    },
                    Vector {
                        id: "v2".to_string(),
                        values: vec![0.9, 0.1, 0.0],
                        metadata: Some(serde_json::json!({"category": "books"})),
                        ttl_seconds: None,
                        expires_at: None,
                    },
                    Vector {
                        id: "v3".to_string(),
                        values: vec![0.8, 0.2, 0.0],
                        metadata: Some(serde_json::json!({"category": "electronics"})),
                        ttl_seconds: None,
                        expires_at: None,
                    },
                ],
            )
            .await
            .unwrap();

        let mut field = HashMap::new();
        field.insert(
            "category".to_string(),
            FilterCondition::Eq(FilterValue::String("electronics".to_string())),
        );

        let request = QueryRequest {
            vector: vec![1.0, 0.0, 0.0],
            top_k: 10,
            distance_metric: DistanceMetric::Cosine,
            include_metadata: true,
            include_vectors: false,
            filter: Some(FilterExpression::Field { field }),
            cursor: None,
            consistency: Default::default(),
            staleness_config: None,
        };

        let response = engine.search(&namespace, &request).await.unwrap();

        // ANN + post-filter: only electronics results (v1, v3)
        assert_eq!(response.results.len(), 2);
        assert!(response
            .results
            .iter()
            .all(|r| r.id == "v1" || r.id == "v3"));
        // Best match (v1 = [1,0,0]) should come first
        assert_eq!(response.results[0].id, "v1");
    }
}