helios-engine 0.5.5

A powerful and flexible Rust framework for building LLM-powered agents with tool support, both locally and online
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
688
689
690
691
692
693
694
695
//! RAG system tests

use helios_engine::{InMemoryVectorStore, RAGSystem, VectorStore};
use std::collections::HashMap;

/// Mock embedding provider for testing
struct MockEmbeddings;

#[async_trait::async_trait]
impl helios_engine::EmbeddingProvider for MockEmbeddings {
    async fn embed(&self, text: &str) -> helios_engine::Result<Vec<f32>> {
        // Simple mock: convert text to a pattern
        let mut vec = vec![0.0; 128];

        // Create a unique pattern based on text content
        for (i, c) in text.chars().enumerate() {
            if i >= vec.len() {
                break;
            }
            vec[i] = (c as u32 as f32) / 1000.0;
        }

        // Normalize
        let norm: f32 = vec.iter().map(|x| x * x).sum::<f32>().sqrt();
        if norm > 0.0 {
            for v in &mut vec {
                *v /= norm;
            }
        }

        Ok(vec)
    }

    fn dimension(&self) -> usize {
        128
    }
}

/// Mock embedding provider with configurable dimension
struct FixedDimensionEmbeddings {
    dimension: usize,
}

impl FixedDimensionEmbeddings {
    fn new(dimension: usize) -> Self {
        Self { dimension }
    }
}

#[async_trait::async_trait]
impl helios_engine::EmbeddingProvider for FixedDimensionEmbeddings {
    async fn embed(&self, text: &str) -> helios_engine::Result<Vec<f32>> {
        let mut vec = vec![0.0; self.dimension];

        for (i, c) in text.chars().enumerate() {
            if i >= vec.len() {
                break;
            }
            vec[i] = (c as u32 as f32) / 1000.0;
        }

        // Normalize
        let norm: f32 = vec.iter().map(|x| x * x).sum::<f32>().sqrt();
        if norm > 0.0 {
            for v in &mut vec {
                *v /= norm;
            }
        }

        Ok(vec)
    }

    fn dimension(&self) -> usize {
        self.dimension
    }
}

#[tokio::test]
async fn test_in_memory_vector_store_add_and_search() {
    let embeddings = MockEmbeddings;
    let vector_store = InMemoryVectorStore::new();
    let rag_system = RAGSystem::new(Box::new(embeddings), Box::new(vector_store));

    // Add documents
    let _id1 = rag_system
        .add_document("The quick brown fox jumps over the lazy dog", None)
        .await
        .unwrap();

    let _id2 = rag_system
        .add_document("A fast brown fox leaps over a sleepy dog", None)
        .await
        .unwrap();

    let _id3 = rag_system
        .add_document("Python is a programming language", None)
        .await
        .unwrap();

    // Search for similar documents
    let results = rag_system.search("quick brown fox", 2).await.unwrap();

    assert_eq!(results.len(), 2);
    // First result should be the most similar
    assert!(results[0].score > 0.5);
}

#[tokio::test]
async fn test_rag_system_count() {
    let embeddings = MockEmbeddings;
    let vector_store = InMemoryVectorStore::new();
    let rag_system = RAGSystem::new(Box::new(embeddings), Box::new(vector_store));

    // Initially empty
    let count = rag_system.count().await.unwrap();
    assert_eq!(count, 0);

    // Add documents
    rag_system.add_document("Document 1", None).await.unwrap();
    rag_system.add_document("Document 2", None).await.unwrap();
    rag_system.add_document("Document 3", None).await.unwrap();

    // Check count
    let count = rag_system.count().await.unwrap();
    assert_eq!(count, 3);
}

#[tokio::test]
async fn test_rag_system_delete() {
    let embeddings = MockEmbeddings;
    let vector_store = InMemoryVectorStore::new();
    let rag_system = RAGSystem::new(Box::new(embeddings), Box::new(vector_store));

    // Add documents
    let id1 = rag_system.add_document("Document 1", None).await.unwrap();
    let id2 = rag_system.add_document("Document 2", None).await.unwrap();

    let count = rag_system.count().await.unwrap();
    assert_eq!(count, 2);

    // Delete one document
    rag_system.delete_document(&id1).await.unwrap();

    let count = rag_system.count().await.unwrap();
    assert_eq!(count, 1);

    // Search should only return remaining document
    let results = rag_system.search("Document", 10).await.unwrap();
    assert_eq!(results.len(), 1);
    assert_eq!(results[0].id, id2);
}

#[tokio::test]
async fn test_rag_system_clear() {
    let embeddings = MockEmbeddings;
    let vector_store = InMemoryVectorStore::new();
    let rag_system = RAGSystem::new(Box::new(embeddings), Box::new(vector_store));

    // Add documents
    rag_system.add_document("Document 1", None).await.unwrap();
    rag_system.add_document("Document 2", None).await.unwrap();
    rag_system.add_document("Document 3", None).await.unwrap();

    let count = rag_system.count().await.unwrap();
    assert_eq!(count, 3);

    // Clear all
    rag_system.clear().await.unwrap();

    let count = rag_system.count().await.unwrap();
    assert_eq!(count, 0);

    // Search should return empty
    let results = rag_system.search("Document", 10).await.unwrap();
    assert_eq!(results.len(), 0);
}

#[tokio::test]
async fn test_rag_system_with_metadata() {
    let embeddings = MockEmbeddings;
    let vector_store = InMemoryVectorStore::new();
    let rag_system = RAGSystem::new(Box::new(embeddings), Box::new(vector_store));

    // Add document with metadata
    let mut metadata = HashMap::new();
    metadata.insert("category".to_string(), serde_json::json!("programming"));
    metadata.insert("language".to_string(), serde_json::json!("rust"));

    let _id = rag_system
        .add_document("Rust is a systems programming language", Some(metadata))
        .await
        .unwrap();

    // Search and verify metadata
    let results = rag_system.search("Rust programming", 1).await.unwrap();
    assert_eq!(results.len(), 1);

    let result = &results[0];
    assert!(result.metadata.is_some());

    let meta = result.metadata.as_ref().unwrap();
    assert_eq!(
        meta.get("category").and_then(|v| v.as_str()),
        Some("programming")
    );
    assert_eq!(meta.get("language").and_then(|v| v.as_str()), Some("rust"));
}

#[tokio::test]
async fn test_cosine_similarity() {
    let embeddings = MockEmbeddings;
    let vector_store = InMemoryVectorStore::new();
    let rag_system = RAGSystem::new(Box::new(embeddings), Box::new(vector_store));

    // Add similar documents
    rag_system
        .add_document("The cat sat on the mat", None)
        .await
        .unwrap();

    rag_system
        .add_document("The cat sat on the rug", None)
        .await
        .unwrap();

    rag_system
        .add_document("Python programming language", None)
        .await
        .unwrap();

    // Search for similar document
    let results = rag_system
        .search("The cat sat on the mat", 3)
        .await
        .unwrap();

    // First result should be exact match (or very close)
    assert!(results[0].score > 0.8);

    // Second should be similar
    assert!(results[1].score > 0.5);

    // Third should be less similar
    assert!(results[2].score < results[1].score);
}

#[tokio::test]
async fn test_in_memory_store_add_and_get() {
    let embeddings = MockEmbeddings;
    let vector_store = InMemoryVectorStore::new();
    let rag_system = RAGSystem::new(Box::new(embeddings), Box::new(vector_store));

    // Add document
    let _id = rag_system
        .add_document("Original text", None)
        .await
        .unwrap();

    // Count should be 1
    let count = rag_system.count().await.unwrap();
    assert_eq!(count, 1);

    // Search to verify
    let results = rag_system.search("Original", 1).await.unwrap();
    assert_eq!(results.len(), 1);
    assert_eq!(results[0].text, "Original text");
}

#[tokio::test]
async fn test_empty_search() {
    let embeddings = MockEmbeddings;
    let vector_store = InMemoryVectorStore::new();
    let rag_system = RAGSystem::new(Box::new(embeddings), Box::new(vector_store));

    // Search in empty store
    let results = rag_system.search("anything", 10).await.unwrap();
    assert_eq!(results.len(), 0);
}

#[tokio::test]
async fn test_search_limit() {
    let embeddings = MockEmbeddings;
    let vector_store = InMemoryVectorStore::new();
    let rag_system = RAGSystem::new(Box::new(embeddings), Box::new(vector_store));

    // Add 10 documents
    for i in 0..10 {
        rag_system
            .add_document(&format!("Document number {}", i), None)
            .await
            .unwrap();
    }

    // Search with limit 5
    let results = rag_system.search("Document", 5).await.unwrap();
    assert_eq!(results.len(), 5);

    // Search with limit 3
    let results = rag_system.search("Document", 3).await.unwrap();
    assert_eq!(results.len(), 3);

    // Search with limit larger than document count
    let results = rag_system.search("Document", 20).await.unwrap();
    assert_eq!(results.len(), 10);
}

// ============================================================================
// Advanced RAG System Tests
// ============================================================================

#[tokio::test]
async fn test_multiple_identical_documents() {
    let embeddings = MockEmbeddings;
    let vector_store = InMemoryVectorStore::new();
    let rag_system = RAGSystem::new(Box::new(embeddings), Box::new(vector_store));

    // Add identical documents
    let _id1 = rag_system.add_document("Same text", None).await.unwrap();
    let _id2 = rag_system.add_document("Same text", None).await.unwrap();
    let _id3 = rag_system.add_document("Same text", None).await.unwrap();

    let count = rag_system.count().await.unwrap();
    assert_eq!(count, 3);

    // Search should return all with similar scores
    let results = rag_system.search("Same text", 3).await.unwrap();
    assert_eq!(results.len(), 3);
    assert!(results[0].score > 0.8);
    assert!(results[1].score > 0.8);
    assert!(results[2].score > 0.8);
}

#[tokio::test]
async fn test_unicode_documents() {
    let embeddings = MockEmbeddings;
    let vector_store = InMemoryVectorStore::new();
    let rag_system = RAGSystem::new(Box::new(embeddings), Box::new(vector_store));

    // Add documents with various Unicode characters
    rag_system.add_document("Hello 世界", None).await.unwrap();
    rag_system.add_document("Привет мир", None).await.unwrap();
    rag_system.add_document("مرحبا العالم", None).await.unwrap();
    rag_system
        .add_document("🚀 Emoji test 🎉", None)
        .await
        .unwrap();

    let count = rag_system.count().await.unwrap();
    assert_eq!(count, 4);

    // Search should work with Unicode
    let results = rag_system.search("世界", 2).await.unwrap();
    assert!(!results.is_empty());
}

#[tokio::test]
async fn test_very_long_document() {
    let embeddings = MockEmbeddings;
    let vector_store = InMemoryVectorStore::new();
    let rag_system = RAGSystem::new(Box::new(embeddings), Box::new(vector_store));

    // Create a very long document
    let long_text = "Lorem ipsum dolor sit amet. ".repeat(1000);

    let _id = rag_system.add_document(&long_text, None).await.unwrap();

    let count = rag_system.count().await.unwrap();
    assert_eq!(count, 1);

    let results = rag_system.search("Lorem ipsum", 1).await.unwrap();
    assert_eq!(results.len(), 1);
    assert_eq!(results[0].text.len(), long_text.len());
}

#[tokio::test]
async fn test_empty_document() {
    let embeddings = MockEmbeddings;
    let vector_store = InMemoryVectorStore::new();
    let rag_system = RAGSystem::new(Box::new(embeddings), Box::new(vector_store));

    // Add empty document
    let _id = rag_system.add_document("", None).await.unwrap();

    let count = rag_system.count().await.unwrap();
    assert_eq!(count, 1);

    let results = rag_system.search("anything", 1).await.unwrap();
    assert_eq!(results.len(), 1);
}

#[tokio::test]
async fn test_special_characters_in_document() {
    let embeddings = MockEmbeddings;
    let vector_store = InMemoryVectorStore::new();
    let rag_system = RAGSystem::new(Box::new(embeddings), Box::new(vector_store));

    // Add documents with special characters
    rag_system
        .add_document("Test with\nnewlines\nand\ttabs", None)
        .await
        .unwrap();
    rag_system
        .add_document("Test with \"quotes\" and 'apostrophes'", None)
        .await
        .unwrap();
    rag_system
        .add_document("Test with symbols: @#$%^&*()", None)
        .await
        .unwrap();

    let count = rag_system.count().await.unwrap();
    assert_eq!(count, 3);

    let results = rag_system.search("Test", 3).await.unwrap();
    assert_eq!(results.len(), 3);
}

#[tokio::test]
async fn test_metadata_with_complex_types() {
    let embeddings = MockEmbeddings;
    let vector_store = InMemoryVectorStore::new();
    let rag_system = RAGSystem::new(Box::new(embeddings), Box::new(vector_store));

    // Add document with complex metadata
    let mut metadata = HashMap::new();
    metadata.insert("string".to_string(), serde_json::json!("value"));
    metadata.insert("number".to_string(), serde_json::json!(42));
    metadata.insert("float".to_string(), serde_json::json!(3.15));
    metadata.insert("boolean".to_string(), serde_json::json!(true));
    metadata.insert("array".to_string(), serde_json::json!([1, 2, 3]));
    metadata.insert("object".to_string(), serde_json::json!({"key": "value"}));

    let _id = rag_system
        .add_document("Document with complex metadata", Some(metadata))
        .await
        .unwrap();

    let results = rag_system.search("metadata", 1).await.unwrap();
    assert_eq!(results.len(), 1);

    let meta = results[0].metadata.as_ref().unwrap();
    assert_eq!(meta.get("string").and_then(|v| v.as_str()), Some("value"));
    assert_eq!(meta.get("number").and_then(|v| v.as_i64()), Some(42));
    assert_eq!(meta.get("boolean").and_then(|v| v.as_bool()), Some(true));
}

#[tokio::test]
async fn test_concurrent_operations() {
    use tokio::task;

    let embeddings = MockEmbeddings;
    let vector_store = InMemoryVectorStore::new();
    let rag_system =
        std::sync::Arc::new(RAGSystem::new(Box::new(embeddings), Box::new(vector_store)));

    // Spawn multiple tasks adding documents concurrently
    let mut handles = vec![];
    for i in 0..10 {
        let rag = rag_system.clone();
        let handle = task::spawn(async move {
            rag.add_document(&format!("Concurrent document {}", i), None)
                .await
                .unwrap();
        });
        handles.push(handle);
    }

    // Wait for all tasks to complete
    for handle in handles {
        handle.await.unwrap();
    }

    let count = rag_system.count().await.unwrap();
    assert_eq!(count, 10);
}

#[tokio::test]
async fn test_search_score_ordering() {
    let embeddings = MockEmbeddings;
    let vector_store = InMemoryVectorStore::new();
    let rag_system = RAGSystem::new(Box::new(embeddings), Box::new(vector_store));

    // Add documents with varying similarity
    rag_system
        .add_document("apple banana cherry", None)
        .await
        .unwrap();
    rag_system.add_document("apple banana", None).await.unwrap();
    rag_system.add_document("apple", None).await.unwrap();
    rag_system
        .add_document("completely different text", None)
        .await
        .unwrap();

    let results = rag_system.search("apple banana", 4).await.unwrap();

    // Results should be ordered by score (descending)
    for i in 0..results.len() - 1 {
        assert!(
            results[i].score >= results[i + 1].score,
            "Results not properly ordered by score"
        );
    }
}

#[tokio::test]
async fn test_delete_nonexistent_document() {
    let embeddings = MockEmbeddings;
    let vector_store = InMemoryVectorStore::new();
    let rag_system = RAGSystem::new(Box::new(embeddings), Box::new(vector_store));

    // Delete non-existent document (should not error)
    let result = rag_system.delete_document("nonexistent-id").await;
    assert!(result.is_ok());

    let count = rag_system.count().await.unwrap();
    assert_eq!(count, 0);
}

#[tokio::test]
async fn test_multiple_deletes_same_document() {
    let embeddings = MockEmbeddings;
    let vector_store = InMemoryVectorStore::new();
    let rag_system = RAGSystem::new(Box::new(embeddings), Box::new(vector_store));

    let id = rag_system
        .add_document("Test document", None)
        .await
        .unwrap();

    // Delete once
    rag_system.delete_document(&id).await.unwrap();
    let count = rag_system.count().await.unwrap();
    assert_eq!(count, 0);

    // Delete again (should not error)
    let result = rag_system.delete_document(&id).await;
    assert!(result.is_ok());
}

#[tokio::test]
async fn test_clear_empty_store() {
    let embeddings = MockEmbeddings;
    let vector_store = InMemoryVectorStore::new();
    let rag_system = RAGSystem::new(Box::new(embeddings), Box::new(vector_store));

    // Clear empty store (should not error)
    let result = rag_system.clear().await;
    assert!(result.is_ok());

    let count = rag_system.count().await.unwrap();
    assert_eq!(count, 0);
}

#[tokio::test]
async fn test_multiple_clears() {
    let embeddings = MockEmbeddings;
    let vector_store = InMemoryVectorStore::new();
    let rag_system = RAGSystem::new(Box::new(embeddings), Box::new(vector_store));

    // Add documents
    rag_system.add_document("Doc 1", None).await.unwrap();
    rag_system.add_document("Doc 2", None).await.unwrap();

    // Clear multiple times
    rag_system.clear().await.unwrap();
    let count = rag_system.count().await.unwrap();
    assert_eq!(count, 0);

    rag_system.clear().await.unwrap();
    let count = rag_system.count().await.unwrap();
    assert_eq!(count, 0);
}

#[tokio::test]
async fn test_search_with_zero_limit() {
    let embeddings = MockEmbeddings;
    let vector_store = InMemoryVectorStore::new();
    let rag_system = RAGSystem::new(Box::new(embeddings), Box::new(vector_store));

    rag_system
        .add_document("Test document", None)
        .await
        .unwrap();

    // Search with limit 0
    let results = rag_system.search("Test", 0).await.unwrap();
    assert_eq!(results.len(), 0);
}

#[tokio::test]
async fn test_dimension_consistency() {
    let embeddings = FixedDimensionEmbeddings::new(256);
    let vector_store = InMemoryVectorStore::new();
    let rag_system = RAGSystem::new(Box::new(embeddings), Box::new(vector_store));

    // Add multiple documents
    for i in 0..5 {
        rag_system
            .add_document(&format!("Document {}", i), None)
            .await
            .unwrap();
    }

    // Search should work correctly
    let results = rag_system.search("Document", 5).await.unwrap();
    assert_eq!(results.len(), 5);
}

#[tokio::test]
async fn test_large_batch_operations() {
    let embeddings = MockEmbeddings;
    let vector_store = InMemoryVectorStore::new();
    let rag_system = RAGSystem::new(Box::new(embeddings), Box::new(vector_store));

    // Add 100 documents
    let mut ids = Vec::new();
    for i in 0..100 {
        let id = rag_system
            .add_document(&format!("Document number {}", i), None)
            .await
            .unwrap();
        ids.push(id);
    }

    let count = rag_system.count().await.unwrap();
    assert_eq!(count, 100);

    // Search should return results efficiently
    let results = rag_system.search("Document", 20).await.unwrap();
    assert_eq!(results.len(), 20);

    // Delete half the documents
    for id in ids.iter().take(50) {
        rag_system.delete_document(id).await.unwrap();
    }

    let count = rag_system.count().await.unwrap();
    assert_eq!(count, 50);
}

#[tokio::test]
async fn test_timestamp_metadata() {
    let embeddings = MockEmbeddings;
    let vector_store = InMemoryVectorStore::new();
    let rag_system = RAGSystem::new(Box::new(embeddings), Box::new(vector_store));

    // Add document (timestamp should be added automatically)
    let _id = rag_system.add_document("Test", None).await.unwrap();

    let results = rag_system.search("Test", 1).await.unwrap();
    assert_eq!(results.len(), 1);

    // Check that timestamp exists in metadata
    let meta = results[0].metadata.as_ref().unwrap();
    assert!(meta.contains_key("timestamp"));
}

#[tokio::test]
async fn test_replicate_same_id_behavior() {
    let _embeddings = MockEmbeddings;
    let vector_store = InMemoryVectorStore::new();

    // Directly test vector store behavior
    vector_store.initialize(128).await.unwrap();

    let embedding = vec![0.1; 128];
    let metadata = HashMap::new();

    // Add document with specific ID
    vector_store
        .add("test-id", embedding.clone(), "First text", metadata.clone())
        .await
        .unwrap();
    let count = vector_store.count().await.unwrap();
    assert_eq!(count, 1);

    // Add another document with same ID (should replace)
    vector_store
        .add(
            "test-id",
            embedding.clone(),
            "Second text",
            metadata.clone(),
        )
        .await
        .unwrap();
    let count = vector_store.count().await.unwrap();
    assert_eq!(count, 1);

    // Search should return the second text
    let results = vector_store.search(embedding, 1).await.unwrap();
    assert_eq!(results.len(), 1);
    assert_eq!(results[0].text, "Second text");
}