vecstore 1.0.0

The perfect vector database - 100/100 score, embeddable, high-performance, production-ready with RAG toolkit
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
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
// Python bindings for vecstore using PyO3
//
// This module provides Python-friendly wrappers around the Rust API.

use crate::collection::{Collection, VecDatabase};
use crate::store::{parse_filter, FilterExpr, HybridQuery, Metadata, Query, VecStore};
use crate::text_splitter::{RecursiveCharacterTextSplitter, TextSplitter};
use pyo3::exceptions::PyValueError;
use pyo3::prelude::*;
use pyo3::types::{PyDict, PyList};
use std::collections::HashMap;
use std::path::PathBuf;

/// Python wrapper for VecStore
#[pyclass(name = "VecStore")]
pub struct PyVecStore {
    inner: VecStore,
}

/// Python wrapper for Query
#[pyclass(name = "Query")]
#[derive(Clone)]
pub struct PyQuery {
    #[pyo3(get, set)]
    pub vector: Vec<f32>,
    #[pyo3(get, set)]
    pub k: usize,
    #[pyo3(get, set)]
    pub filter: Option<String>,
}

#[pymethods]
impl PyQuery {
    #[new]
    #[pyo3(signature = (vector, k, filter=None))]
    fn new(vector: Vec<f32>, k: usize, filter: Option<String>) -> Self {
        Self { vector, k, filter }
    }
}

/// Python wrapper for HybridQuery
#[pyclass(name = "HybridQuery")]
#[derive(Clone)]
pub struct PyHybridQuery {
    #[pyo3(get, set)]
    pub vector: Vec<f32>,
    #[pyo3(get, set)]
    pub keywords: String,
    #[pyo3(get, set)]
    pub k: usize,
    #[pyo3(get, set)]
    pub filter: Option<String>,
    #[pyo3(get, set)]
    pub alpha: f32,
}

#[pymethods]
impl PyHybridQuery {
    #[new]
    #[pyo3(signature = (vector, keywords, k, alpha, filter=None))]
    fn new(
        vector: Vec<f32>,
        keywords: String,
        k: usize,
        alpha: f32,
        filter: Option<String>,
    ) -> Self {
        Self {
            vector,
            keywords,
            k,
            filter,
            alpha,
        }
    }
}

/// Python wrapper for search results
#[pyclass(name = "SearchResult")]
pub struct PySearchResult {
    #[pyo3(get)]
    pub id: String,
    #[pyo3(get)]
    pub score: f32,
    metadata_dict: Py<PyDict>,
}

#[pymethods]
impl PySearchResult {
    #[getter]
    fn metadata(&self, py: Python) -> PyResult<PyObject> {
        Ok(self.metadata_dict.clone_ref(py).into())
    }

    fn __repr__(&self) -> String {
        format!("SearchResult(id='{}', score={:.3})", self.id, self.score)
    }
}

// Helper function to convert Rust Metadata to Python dict
fn metadata_to_pydict(py: Python, metadata: &Metadata) -> PyResult<Py<PyDict>> {
    let dict = PyDict::new_bound(py);
    for (key, value) in &metadata.fields {
        match value {
            serde_json::Value::String(s) => {
                dict.set_item(key, s.as_str())?;
            }
            serde_json::Value::Number(n) => {
                if let Some(i) = n.as_i64() {
                    dict.set_item(key, i)?;
                } else if let Some(f) = n.as_f64() {
                    dict.set_item(key, f)?;
                }
            }
            serde_json::Value::Bool(b) => {
                dict.set_item(key, b)?;
            }
            serde_json::Value::Null => {
                dict.set_item(key, py.None())?;
            }
            _ => {} // Skip complex types
        }
    }
    Ok(dict.unbind())
}

// Helper function to convert Python dict to Rust Metadata
fn pydict_to_metadata(dict: &Bound<PyDict>) -> PyResult<Metadata> {
    let mut fields = HashMap::new();

    for (key, value) in dict.iter() {
        let key_str: String = key.extract()?;

        let json_value = if let Ok(s) = value.extract::<String>() {
            serde_json::Value::String(s)
        } else if let Ok(i) = value.extract::<i64>() {
            serde_json::Value::Number(i.into())
        } else if let Ok(f) = value.extract::<f64>() {
            serde_json::json!(f)
        } else if let Ok(b) = value.extract::<bool>() {
            serde_json::Value::Bool(b)
        } else if value.is_none() {
            serde_json::Value::Null
        } else {
            // Try to convert to string as fallback
            serde_json::Value::String(value.str()?.to_string())
        };

        fields.insert(key_str, json_value);
    }

    Ok(Metadata { fields })
}

#[pymethods]
impl PyVecStore {
    /// Create or open a vector store at the given path
    #[new]
    fn new(path: String) -> PyResult<Self> {
        let store = VecStore::open(PathBuf::from(path))
            .map_err(|e| PyValueError::new_err(format!("Failed to open store: {}", e)))?;
        Ok(Self { inner: store })
    }

    /// Insert or update a vector with metadata
    ///
    /// Args:
    ///     id: Unique identifier for the vector
    ///     vector: List of floats representing the embedding
    ///     metadata: Dictionary of metadata (supports str, int, float, bool, None)
    ///
    /// Example:
    ///     >>> store.upsert("doc1", [0.1, 0.2, 0.3], {"title": "Document 1"})
    fn upsert(&mut self, id: String, vector: Vec<f32>, metadata: &Bound<PyDict>) -> PyResult<()> {
        let meta = pydict_to_metadata(metadata)?;
        self.inner
            .upsert(id, vector, meta)
            .map_err(|e| PyValueError::new_err(format!("Upsert failed: {}", e)))
    }

    /// Remove a vector by ID
    fn remove(&mut self, id: String) -> PyResult<()> {
        self.inner
            .remove(&id)
            .map_err(|e| PyValueError::new_err(format!("Remove failed: {}", e)))
    }

    /// Search for similar vectors
    ///
    /// Args:
    ///     vector: Query vector (list of floats)
    ///     k: Number of results to return
    ///     filter: Optional SQL-like filter string (e.g., "category = 'tech'")
    ///
    /// Returns:
    ///     List of SearchResult objects
    ///
    /// Example:
    ///     >>> results = store.query([0.1, 0.2, 0.3], k=10, filter="category = 'tech'")
    ///     >>> for result in results:
    ///     ...     print(f"{result.id}: {result.score}")
    #[pyo3(signature = (vector, k, filter=None))]
    fn query(
        &self,
        py: Python,
        vector: Vec<f32>,
        k: usize,
        filter: Option<String>,
    ) -> PyResult<Vec<PySearchResult>> {
        let filter_expr: Option<FilterExpr> = if let Some(filter_str) = filter {
            Some(
                parse_filter(&filter_str)
                    .map_err(|e| PyValueError::new_err(format!("Filter parse error: {}", e)))?,
            )
        } else {
            None
        };

        let query = Query {
            vector,
            k,
            filter: filter_expr,
        };

        let results = self
            .inner
            .query(query)
            .map_err(|e| PyValueError::new_err(format!("Query failed: {}", e)))?;

        results
            .into_iter()
            .map(|neighbor| {
                Ok(PySearchResult {
                    id: neighbor.id,
                    score: neighbor.score,
                    metadata_dict: metadata_to_pydict(py, &neighbor.metadata)?,
                })
            })
            .collect()
    }

    /// Hybrid search combining vector similarity and keyword search
    ///
    /// Args:
    ///     vector: Query vector (list of floats)
    ///     keywords: Search keywords (string)
    ///     k: Number of results to return
    ///     alpha: Weight for vector vs keyword (0.0 = pure keyword, 1.0 = pure vector)
    ///     filter: Optional SQL-like filter string
    ///
    /// Returns:
    ///     List of SearchResult objects
    ///
    /// Example:
    ///     >>> results = store.hybrid_query(
    ///     ...     vector=[0.1, 0.2, 0.3],
    ///     ...     keywords="machine learning",
    ///     ...     k=10,
    ///     ...     alpha=0.7
    ///     ... )
    #[pyo3(signature = (vector, keywords, k, alpha, filter=None))]
    fn hybrid_query(
        &self,
        py: Python,
        vector: Vec<f32>,
        keywords: String,
        k: usize,
        alpha: f32,
        filter: Option<String>,
    ) -> PyResult<Vec<PySearchResult>> {
        let filter_expr: Option<FilterExpr> = if let Some(filter_str) = filter {
            Some(
                parse_filter(&filter_str)
                    .map_err(|e| PyValueError::new_err(format!("Filter parse error: {}", e)))?,
            )
        } else {
            None
        };

        let query = HybridQuery {
            vector,
            keywords,
            k,
            filter: filter_expr,
            alpha,
        };

        let results = self
            .inner
            .hybrid_query(query)
            .map_err(|e| PyValueError::new_err(format!("Hybrid query failed: {}", e)))?;

        results
            .into_iter()
            .map(|neighbor| {
                Ok(PySearchResult {
                    id: neighbor.id,
                    score: neighbor.score,
                    metadata_dict: metadata_to_pydict(py, &neighbor.metadata)?,
                })
            })
            .collect()
    }

    /// Index text for keyword search (required for hybrid search)
    ///
    /// Args:
    ///     id: Vector ID
    ///     text: Text content to index
    fn index_text(&mut self, id: String, text: String) -> PyResult<()> {
        self.inner
            .index_text(&id, text)
            .map_err(|e| PyValueError::new_err(format!("Text indexing failed: {}", e)))
    }

    /// Save the store to disk
    fn save(&self) -> PyResult<()> {
        self.inner
            .save()
            .map_err(|e| PyValueError::new_err(format!("Save failed: {}", e)))
    }

    /// Get the number of vectors in the store
    fn len(&self) -> usize {
        self.inner.len()
    }

    /// Check if the store is empty
    fn is_empty(&self) -> bool {
        self.inner.is_empty()
    }

    /// Create a named snapshot
    fn create_snapshot(&self, name: String) -> PyResult<()> {
        self.inner
            .create_snapshot(&name)
            .map_err(|e| PyValueError::new_err(format!("Snapshot creation failed: {}", e)))
    }

    /// Restore from a named snapshot
    fn restore_snapshot(&mut self, name: String) -> PyResult<()> {
        self.inner
            .restore_snapshot(&name)
            .map_err(|e| PyValueError::new_err(format!("Snapshot restore failed: {}", e)))
    }

    /// List all available snapshots
    fn list_snapshots(&self, py: Python) -> PyResult<Py<PyList>> {
        let snapshots = self
            .inner
            .list_snapshots()
            .map_err(|e| PyValueError::new_err(format!("Failed to list snapshots: {}", e)))?;

        let py_list = PyList::new_bound(py, &snapshots);
        Ok(py_list.unbind())
    }

    /// Optimize the index by removing ghost entries from deletions
    fn optimize(&mut self) -> PyResult<usize> {
        self.inner
            .optimize()
            .map_err(|e| PyValueError::new_err(format!("Optimization failed: {}", e)))
    }

    fn __repr__(&self) -> String {
        format!("VecStore(vectors={})", self.inner.len())
    }

    fn __len__(&self) -> usize {
        self.len()
    }
}

/// Python wrapper for VecDatabase (multi-collection database)
#[pyclass(name = "VecDatabase")]
pub struct PyVecDatabase {
    inner: VecDatabase,
}

#[pymethods]
impl PyVecDatabase {
    /// Create or open a database at the specified path
    ///
    /// Example:
    ///     >>> db = VecDatabase("./my_db")
    ///     >>> collections = db.list_collections()
    #[new]
    fn new(path: String) -> PyResult<Self> {
        let db = VecDatabase::open(PathBuf::from(path))
            .map_err(|e| PyValueError::new_err(format!("Failed to open database: {}", e)))?;
        Ok(Self { inner: db })
    }

    /// Create a new collection
    ///
    /// Args:
    ///     name: Collection name (must be unique)
    ///
    /// Returns:
    ///     Collection object
    ///
    /// Example:
    ///     >>> db = VecDatabase("./my_db")
    ///     >>> collection = db.create_collection("documents")
    fn create_collection(&mut self, name: String) -> PyResult<PyCollection> {
        let collection = self
            .inner
            .create_collection(&name)
            .map_err(|e| PyValueError::new_err(format!("Failed to create collection: {}", e)))?;

        Ok(PyCollection { inner: collection })
    }

    /// Get an existing collection
    ///
    /// Args:
    ///     name: Collection name
    ///
    /// Returns:
    ///     Collection object or None if not found
    ///
    /// Example:
    ///     >>> db = VecDatabase("./my_db")
    ///     >>> if collection := db.get_collection("documents"):
    ///     ...     print(f"Found collection: {collection.name()}")
    fn get_collection(&self, name: String) -> PyResult<Option<PyCollection>> {
        match self
            .inner
            .get_collection(&name)
            .map_err(|e| PyValueError::new_err(format!("Failed to get collection: {}", e)))?
        {
            Some(collection) => Ok(Some(PyCollection { inner: collection })),
            None => Ok(None),
        }
    }

    /// List all collections in the database
    ///
    /// Returns:
    ///     List of collection names
    ///
    /// Example:
    ///     >>> db = VecDatabase("./my_db")
    ///     >>> for name in db.list_collections():
    ///     ...     print(f"Collection: {name}")
    fn list_collections(&self, py: Python) -> PyResult<Py<PyList>> {
        let collections = self
            .inner
            .list_collections()
            .map_err(|e| PyValueError::new_err(format!("Failed to list collections: {}", e)))?;

        let py_list = PyList::new_bound(py, &collections);
        Ok(py_list.unbind())
    }

    /// Delete a collection and all its data
    ///
    /// Args:
    ///     name: Collection name to delete
    ///
    /// Example:
    ///     >>> db = VecDatabase("./my_db")
    ///     >>> db.delete_collection("old_documents")
    fn delete_collection(&mut self, name: String) -> PyResult<()> {
        self.inner
            .delete_collection(&name)
            .map_err(|e| PyValueError::new_err(format!("Failed to delete collection: {}", e)))
    }

    fn __repr__(&self) -> PyResult<String> {
        let collections = self
            .inner
            .list_collections()
            .map_err(|e| PyValueError::new_err(format!("Failed to list collections: {}", e)))?;
        Ok(format!("VecDatabase(collections={})", collections.len()))
    }
}

/// Python wrapper for Collection
#[pyclass(name = "Collection")]
pub struct PyCollection {
    inner: Collection,
}

#[pymethods]
impl PyCollection {
    /// Get the collection name
    fn name(&self) -> String {
        self.inner.name().to_string()
    }

    /// Insert or update a vector with metadata
    ///
    /// Args:
    ///     id: Unique identifier for the vector
    ///     vector: List of floats representing the embedding
    ///     metadata: Dictionary of metadata
    ///
    /// Example:
    ///     >>> collection.upsert("doc1", [0.1, 0.2, 0.3], {"title": "Document 1"})
    fn upsert(&mut self, id: String, vector: Vec<f32>, metadata: &Bound<PyDict>) -> PyResult<()> {
        let meta = pydict_to_metadata(metadata)?;
        self.inner
            .upsert(id, vector, meta)
            .map_err(|e| PyValueError::new_err(format!("Upsert failed: {}", e)))
    }

    /// Search for similar vectors
    ///
    /// Args:
    ///     vector: Query vector (list of floats)
    ///     k: Number of results to return
    ///     filter: Optional SQL-like filter string
    ///
    /// Returns:
    ///     List of SearchResult objects
    ///
    /// Example:
    ///     >>> results = collection.query([0.1, 0.2, 0.3], k=10)
    ///     >>> for result in results:
    ///     ...     print(f"{result.id}: {result.score}")
    #[pyo3(signature = (vector, k, filter=None))]
    fn query(
        &self,
        py: Python,
        vector: Vec<f32>,
        k: usize,
        filter: Option<String>,
    ) -> PyResult<Vec<PySearchResult>> {
        let filter_expr: Option<FilterExpr> = if let Some(filter_str) = filter {
            Some(
                parse_filter(&filter_str)
                    .map_err(|e| PyValueError::new_err(format!("Filter parse error: {}", e)))?,
            )
        } else {
            None
        };

        let query = Query {
            vector,
            k,
            filter: filter_expr,
        };

        let results = self
            .inner
            .query(query)
            .map_err(|e| PyValueError::new_err(format!("Query failed: {}", e)))?;

        results
            .into_iter()
            .map(|neighbor| {
                Ok(PySearchResult {
                    id: neighbor.id,
                    score: neighbor.score,
                    metadata_dict: metadata_to_pydict(py, &neighbor.metadata)?,
                })
            })
            .collect()
    }

    /// Delete a vector by ID
    ///
    /// Args:
    ///     id: Vector ID to delete
    ///
    /// Example:
    ///     >>> collection.delete("doc1")
    fn delete(&mut self, id: String) -> PyResult<()> {
        self.inner
            .delete(&id)
            .map_err(|e| PyValueError::new_err(format!("Delete failed: {}", e)))
    }

    /// Get the number of vectors in the collection
    fn count(&self) -> PyResult<usize> {
        self.inner
            .count()
            .map_err(|e| PyValueError::new_err(format!("Count failed: {}", e)))
    }

    /// Get collection statistics
    ///
    /// Returns:
    ///     Dictionary with statistics (vector_count, active_count, deleted_count, etc.)
    fn stats(&self, py: Python) -> PyResult<PyObject> {
        let stats = self
            .inner
            .stats()
            .map_err(|e| PyValueError::new_err(format!("Stats failed: {}", e)))?;

        let dict = PyDict::new_bound(py);
        dict.set_item("vector_count", stats.vector_count)?;
        dict.set_item("active_count", stats.active_count)?;
        dict.set_item("deleted_count", stats.deleted_count)?;
        dict.set_item("dimension", stats.dimension)?;
        dict.set_item("quota_utilization", stats.quota_utilization)?;

        Ok(dict.into())
    }

    fn __repr__(&self) -> PyResult<String> {
        let count = self
            .inner
            .count()
            .map_err(|e| PyValueError::new_err(format!("Count failed: {}", e)))?;
        Ok(format!(
            "Collection(name='{}', vectors={})",
            self.inner.name(),
            count
        ))
    }
}

/// Python wrapper for RecursiveCharacterTextSplitter
#[pyclass(name = "RecursiveCharacterTextSplitter")]
pub struct PyRecursiveCharacterTextSplitter {
    inner: RecursiveCharacterTextSplitter,
}

#[pymethods]
impl PyRecursiveCharacterTextSplitter {
    /// Create a new recursive character text splitter
    ///
    /// Args:
    ///     chunk_size: Maximum characters per chunk
    ///     chunk_overlap: Characters to overlap between chunks
    ///
    /// Example:
    ///     >>> splitter = RecursiveCharacterTextSplitter(500, 50)
    ///     >>> chunks = splitter.split_text("Long document text...")
    #[new]
    fn new(chunk_size: usize, chunk_overlap: usize) -> Self {
        Self {
            inner: RecursiveCharacterTextSplitter::new(chunk_size, chunk_overlap),
        }
    }

    /// Split text into chunks
    ///
    /// Args:
    ///     text: Text to split
    ///
    /// Returns:
    ///     List of text chunks
    ///
    /// Example:
    ///     >>> splitter = RecursiveCharacterTextSplitter(500, 50)
    ///     >>> chunks = splitter.split_text("Very long document...")
    ///     >>> for i, chunk in enumerate(chunks):
    ///     ...     print(f"Chunk {i}: {len(chunk)} chars")
    fn split_text(&self, py: Python, text: String) -> PyResult<Py<PyList>> {
        let chunks = self
            .inner
            .split_text(&text)
            .map_err(|e| PyValueError::new_err(format!("Split failed: {}", e)))?;

        let py_list = PyList::new_bound(py, &chunks);
        Ok(py_list.unbind())
    }

    fn __repr__(&self) -> String {
        "RecursiveCharacterTextSplitter()".to_string()
    }
}

/// vecstore - Lightweight vector database for RAG applications
///
/// This module provides Python bindings for the vecstore library,
/// offering fast vector similarity search with HNSW indexing,
/// hybrid search (vector + keyword), and metadata filtering.
#[pymodule]
fn vecstore(m: &Bound<'_, PyModule>) -> PyResult<()> {
    m.add_class::<PyVecStore>()?;
    m.add_class::<PyQuery>()?;
    m.add_class::<PyHybridQuery>()?;
    m.add_class::<PySearchResult>()?;
    m.add_class::<PyVecDatabase>()?;
    m.add_class::<PyCollection>()?;
    m.add_class::<PyRecursiveCharacterTextSplitter>()?;
    Ok(())
}