rig_core/vector_store/
mod.rs

1//! Vector store abstractions for semantic search and retrieval.
2//!
3//! # Core Traits
4//!
5//! - [`VectorStoreIndex`]: Query a vector store for similar documents.
6//! - [`InsertDocuments`]: Insert documents and their embeddings.
7//! - [`VectorStoreIndexDyn`]: Type-erased vector queries for runtime-defined retrieval policies.
8//!
9//! Use [`VectorSearchRequest`] to build queries. See [`request`] for filtering.
10//!
11//! Types implementing [`VectorStoreIndex`] automatically implement [`PortableTool`].
12
13pub use request::VectorSearchRequest;
14use reqwest::StatusCode;
15use serde::{Deserialize, Serialize};
16use serde_json::{Value, json};
17
18use crate::{
19    Embed, OneOrMany,
20    embeddings::{Embedding, EmbeddingError},
21    tool::PortableTool,
22    vector_store::request::{Filter, FilterError, SearchFilter},
23    wasm_compat::{WasmBoxedFuture, WasmCompatSend, WasmCompatSync},
24};
25
26pub mod builder;
27pub mod in_memory_store;
28pub mod lsh;
29pub mod request;
30
31/// Errors from vector store operations.
32#[derive(Debug, thiserror::Error)]
33#[non_exhaustive]
34pub enum VectorStoreError {
35    /// Embedding generation failed while preparing a vector query or insert.
36    #[error("Embedding error: {0}")]
37    EmbeddingError(#[from] EmbeddingError),
38
39    /// JSON serialization or deserialization failed.
40    #[error("Json error: {0}")]
41    JsonError(#[from] serde_json::Error),
42
43    #[cfg(not(target_family = "wasm"))]
44    /// Backend-specific datastore error.
45    #[error("Datastore error: {0}")]
46    DatastoreError(#[from] Box<dyn std::error::Error + Send + Sync + 'static>),
47
48    /// Filter construction or translation failed.
49    #[error("Filter error: {0}")]
50    FilterError(#[from] FilterError),
51
52    #[cfg(target_family = "wasm")]
53    /// Backend-specific datastore error.
54    #[error("Datastore error: {0}")]
55    DatastoreError(#[from] Box<dyn std::error::Error + 'static>),
56
57    /// A document was missing an ID required by the backend.
58    #[error("Missing Id: {0}")]
59    MissingIdError(String),
60
61    /// HTTP request failed for an external vector store service.
62    #[error("HTTP request error: {0}")]
63    ReqwestError(#[from] reqwest::Error),
64
65    /// External vector store service returned an error response.
66    #[error("External call to API returned an error. Error code: {0} Message: {1}")]
67    ExternalAPIError(StatusCode, String),
68
69    /// A vector search request builder received invalid input.
70    #[error("Error while building VectorSearchRequest: {0}")]
71    BuilderError(String),
72}
73
74/// Trait for inserting documents and embeddings into a vector store.
75pub trait InsertDocuments: WasmCompatSend + WasmCompatSync {
76    /// Insert precomputed embeddings for each document.
77    fn insert_documents<Doc: Serialize + Embed + WasmCompatSend>(
78        &self,
79        documents: Vec<(Doc, OneOrMany<Embedding>)>,
80    ) -> impl std::future::Future<Output = Result<(), VectorStoreError>> + WasmCompatSend;
81}
82
83/// Trait for querying a vector store by similarity.
84pub trait VectorStoreIndex: WasmCompatSend + WasmCompatSync {
85    /// The filter type for this backend.
86    type Filter: SearchFilter + WasmCompatSend + WasmCompatSync;
87
88    /// Returns the top N most similar documents as `(score, id, document)` tuples.
89    fn top_n<T: for<'a> Deserialize<'a> + WasmCompatSend>(
90        &self,
91        req: VectorSearchRequest<Self::Filter>,
92    ) -> impl std::future::Future<Output = Result<Vec<(f64, String, T)>, VectorStoreError>>
93    + WasmCompatSend;
94
95    /// Returns the top N most similar document IDs as `(score, id)` tuples.
96    fn top_n_ids(
97        &self,
98        req: VectorSearchRequest<Self::Filter>,
99    ) -> impl std::future::Future<Output = Result<Vec<(f64, String)>, VectorStoreError>> + WasmCompatSend;
100}
101
102/// Type-erased `top_n` result: `(score, id, document)` tuples as JSON values.
103pub type TopNResults = Result<Vec<(f64, String, Value)>, VectorStoreError>;
104
105/// Type-erased [`VectorStoreIndex`] for dynamic dispatch.
106pub trait VectorStoreIndexDyn: WasmCompatSend + WasmCompatSync {
107    /// Returns the top N documents for a JSON-serializable request.
108    fn top_n<'a>(
109        &'a self,
110        req: VectorSearchRequest<Filter<serde_json::Value>>,
111    ) -> WasmBoxedFuture<'a, TopNResults>;
112
113    /// Returns only the top N document IDs for a JSON-serializable request.
114    fn top_n_ids<'a>(
115        &'a self,
116        req: VectorSearchRequest<Filter<serde_json::Value>>,
117    ) -> WasmBoxedFuture<'a, Result<Vec<(f64, String)>, VectorStoreError>>;
118}
119
120impl<I: VectorStoreIndex<Filter = F>, F> VectorStoreIndexDyn for I
121where
122    F: std::fmt::Debug
123        + Clone
124        + SearchFilter<Value = serde_json::Value>
125        + WasmCompatSend
126        + WasmCompatSync
127        + Serialize
128        + for<'de> Deserialize<'de>
129        + 'static,
130{
131    fn top_n<'a>(
132        &'a self,
133        req: VectorSearchRequest<Filter<serde_json::Value>>,
134    ) -> WasmBoxedFuture<'a, TopNResults> {
135        let req = req.map_filter(Filter::interpret);
136
137        Box::pin(async move {
138            Ok(self
139                .top_n::<serde_json::Value>(req)
140                .await?
141                .into_iter()
142                .map(|(score, id, doc)| (score, id, prune_document(doc).unwrap_or_default()))
143                .collect::<Vec<_>>())
144        })
145    }
146
147    fn top_n_ids<'a>(
148        &'a self,
149        req: VectorSearchRequest<Filter<serde_json::Value>>,
150    ) -> WasmBoxedFuture<'a, Result<Vec<(f64, String)>, VectorStoreError>> {
151        let req = req.map_filter(Filter::interpret);
152
153        Box::pin(self.top_n_ids(req))
154    }
155}
156
157fn prune_document(document: serde_json::Value) -> Option<serde_json::Value> {
158    match document {
159        Value::Object(mut map) => {
160            let new_map = map
161                .iter_mut()
162                .filter_map(|(key, value)| {
163                    prune_document(value.take()).map(|value| (key.clone(), value))
164                })
165                .collect::<serde_json::Map<_, _>>();
166
167            Some(Value::Object(new_map))
168        }
169        Value::Array(vec) if vec.len() > 400 => None,
170        Value::Array(vec) => Some(Value::Array(
171            vec.into_iter().filter_map(prune_document).collect(),
172        )),
173        Value::Number(num) => Some(Value::Number(num)),
174        Value::String(s) => Some(Value::String(s)),
175        Value::Bool(b) => Some(Value::Bool(b)),
176        Value::Null => Some(Value::Null),
177    }
178}
179
180/// The output of vector store queries invoked via [`PortableTool`]
181#[derive(Serialize, Deserialize, Debug)]
182pub struct VectorStoreOutput {
183    /// Similarity score returned by the vector store.
184    pub score: f64,
185    /// Document ID returned by the vector store.
186    pub id: String,
187    /// Serialized document payload.
188    pub document: Value,
189}
190
191impl<T, F> PortableTool for T
192where
193    F: SearchFilter<Value = serde_json::Value>
194        + WasmCompatSend
195        + WasmCompatSync
196        + for<'de> Deserialize<'de>,
197    T: VectorStoreIndex<Filter = F>,
198{
199    const NAME: &'static str = "search_vector_store";
200    type Error = VectorStoreError;
201    type Args = VectorSearchRequest<F>;
202    type Output = Vec<VectorStoreOutput>;
203
204    fn description(&self) -> String {
205        "Retrieves the most relevant documents from a vector store based on a query.".to_string()
206    }
207
208    fn parameters(&self) -> serde_json::Value {
209        json!({
210            "type": "object",
211            "properties": {
212                "query": {
213                    "type": "string",
214                    "description": "The query string to search for relevant documents in the vector store."
215                },
216                "samples": {
217                    "type": "integer",
218                    "description": "The maximum number of samples / documents to retrieve.",
219                    "default": 5,
220                    "minimum": 1
221                },
222                "threshold": {
223                    "type": "number",
224                    "description": "Similarity search threshold. If present, any result with a distance less than this may be omitted from the final result."
225                }
226            },
227            "required": ["query", "samples"]
228        })
229    }
230
231    async fn call(&self, args: Self::Args) -> Result<Self::Output, Self::Error> {
232        let results = self.top_n(args).await?;
233        Ok(results
234            .into_iter()
235            .map(|(score, id, document)| VectorStoreOutput {
236                score,
237                id,
238                document,
239            })
240            .collect())
241    }
242}
243
244/// Index strategy for the super::InMemoryVectorStore
245#[derive(Clone, Debug, Default)]
246pub enum IndexStrategy {
247    /// Checks all documents in the vector store to find the most relevant documents.
248    #[default]
249    BruteForce,
250
251    /// Uses LSH to find candidates then computes exact distances.
252    LSH {
253        /// Number of tables to use for LSH.
254        num_tables: usize,
255        /// Number of hyperplanes to use for LSH.
256        num_hyperplanes: usize,
257    },
258}
259
260#[cfg(test)]
261mod tests {
262    use std::sync::{Arc, Mutex};
263
264    use super::*;
265    use crate::vector_store::request::Filter;
266
267    struct TestIndex {
268        queries: Arc<Mutex<Vec<String>>>,
269    }
270
271    impl VectorStoreIndex for TestIndex {
272        type Filter = Filter<serde_json::Value>;
273
274        async fn top_n<T: for<'a> Deserialize<'a> + WasmCompatSend>(
275            &self,
276            req: VectorSearchRequest,
277        ) -> Result<Vec<(f64, String, T)>, VectorStoreError> {
278            self.queries
279                .lock()
280                .expect("query recorder lock")
281                .push(req.query().to_string());
282            let document = serde_json::from_value(json!({ "answer": 42 }))?;
283            Ok(vec![(0.9, "doc-1".to_string(), document)])
284        }
285
286        async fn top_n_ids(
287            &self,
288            _req: VectorSearchRequest,
289        ) -> Result<Vec<(f64, String)>, VectorStoreError> {
290            Ok(vec![(0.9, "doc-1".to_string())])
291        }
292    }
293
294    #[tokio::test]
295    async fn vector_store_index_remains_a_tool() {
296        let queries = Arc::new(Mutex::new(Vec::new()));
297        let index = TestIndex {
298            queries: queries.clone(),
299        };
300        let request = VectorSearchRequest::builder()
301            .query("answer")
302            .samples(1)
303            .build();
304        let output = <TestIndex as PortableTool>::call(&index, request)
305            .await
306            .expect("vector tool call should succeed");
307
308        assert_eq!(<TestIndex as PortableTool>::NAME, "search_vector_store");
309        assert_eq!(
310            *queries.lock().expect("query recorder lock"),
311            vec!["answer"]
312        );
313        assert_eq!(output.len(), 1);
314        let result = output.first().expect("one vector result");
315        assert_eq!(result.score, 0.9);
316        assert_eq!(result.id, "doc-1");
317        assert_eq!(result.document, json!({ "answer": 42 }));
318    }
319}
rig_core/vector_store/mod.rs

rig_core/vector_store/
mod.rs
