use async_trait::async_trait;
use crate::error::{RetrieverError, VectorStoreError};
use crate::schemas::{self, Document};
use super::VecStoreOptions;
#[async_trait]
pub trait VectorStore: Send + Sync {
type Options: Send + Sync;
async fn add_documents(
&self,
docs: &[Document],
opt: &Self::Options,
) -> Result<Vec<String>, VectorStoreError>;
async fn similarity_search(
&self,
query: &str,
limit: usize,
opt: &Self::Options,
) -> Result<Vec<Document>, VectorStoreError>;
async fn delete(&self, ids: &[String], _opt: &Self::Options) -> Result<(), VectorStoreError>;
}
impl<VS, F> From<VS> for Box<dyn VectorStore<Options = F>>
where
VS: 'static + VectorStore<Options = F>,
{
fn from(vector_store: VS) -> Self {
Box::new(vector_store)
}
}
#[macro_export]
macro_rules! add_documents {
($obj:expr, $docs:expr) => {
$obj.add_documents($docs, &$crate::vectorstore::VecStoreOptions::default())
};
($obj:expr, $docs:expr, $opt:expr) => {
$obj.add_documents($docs, $opt)
};
}
#[macro_export]
macro_rules! similarity_search {
($obj:expr, $query:expr, $limit:expr) => {
$obj.similarity_search(
$query,
$limit,
&$crate::vectorstore::VecStoreOptions::default(),
)
};
($obj:expr, $query:expr, $limit:expr, $opt:expr) => {
$obj.similarity_search($query, $limit, $opt)
};
}
pub struct Retriever<F> {
vstore: Box<dyn VectorStore<Options = VecStoreOptions<F>>>,
num_docs: usize,
options: VecStoreOptions<F>,
}
impl<F> Retriever<F> {
pub fn new<V: Into<Box<dyn VectorStore<Options = VecStoreOptions<F>>>>>(
vstore: V,
num_docs: usize,
) -> Self {
Retriever {
vstore: vstore.into(),
num_docs,
options: VecStoreOptions::<F>::new(),
}
}
pub fn with_options(mut self, options: VecStoreOptions<F>) -> Self {
self.options = options;
self
}
}
#[async_trait]
impl<O: Sync + Send> schemas::Retriever for Retriever<O> {
async fn get_relevant_documents(&self, query: &str) -> Result<Vec<Document>, RetrieverError> {
self.vstore
.similarity_search(query, self.num_docs, &self.options)
.await
.map_err(|e| e.into())
}
}