Struct VectorStoreRetriever

pub struct VectorStoreRetriever { /* private fields */ }

A retriever that wraps a vector store

Implementations

impl VectorStoreRetriever

pub fn new(vector_store: Box<dyn VectorStore>) -> Self

Create a new vector store retriever

pub fn new_with_kwargs( vector_store: Box<dyn VectorStore>, search_kwargs: HashMap<String, Value>, ) -> Self

Create a new vector store retriever with search parameters

pub fn add_search_kwarg(&mut self, key: impl Into<String>, value: Value)

Add a search parameter

Trait Implementations

impl BaseRetriever for VectorStoreRetriever

fn get_relevant_documents<'life0, 'life1, 'async_trait>( &'life0 self, query: &'life1 str, _config: Option<RunnableConfig>, ) -> Pin<Box<dyn Future<Output = Result<RetrieverResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Retrieve documents based on a query

fn get_relevant_documents_batch<'life0, 'async_trait>( &'life0 self, queries: Vec<String>, config: Option<RunnableConfig>, ) -> Pin<Box<dyn Future<Output = Result<Vec<RetrieverResult>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Retrieve documents for multiple queries

fn input_schema(&self) -> Option<Value>

Get the input schema for this retriever

fn output_schema(&self) -> Option<Value>

Get the output schema for this retriever