Struct SimpleRetriever 

pub struct SimpleRetriever {
    pub docs: Vec<Document>,
    pub k: usize,
    /* private fields */
}

A simple retriever that returns documents from a static list.

This is useful for testing or for simple use cases where documents are known ahead of time.

Fields

docs: Vec<Document>

The list of documents to return.

k: usize

The maximum number of documents to return.

Implementations

impl SimpleRetriever

pub fn new(docs: Vec<Document>) -> Self

Create a new SimpleRetriever with the given documents.

pub fn with_k(self, k: usize) -> Self

Set the maximum number of documents to return.

pub fn with_tags(self, tags: Vec<String>) -> Self

Set the tags for this retriever.

pub fn with_metadata(self, metadata: HashMap<String, Value>) -> Self

Set the metadata for this retriever.

Trait Implementations

impl BaseRetriever for SimpleRetriever

fn tags(&self) -> Option<&[String]>

Optional list of tags associated with the retriever.

fn metadata(&self) -> Option<&HashMap<String, Value>>

Optional metadata associated with the retriever.

fn get_relevant_documents( &self, _query: &str, _run_manager: Option<&CallbackManagerForRetrieverRun>, ) -> Result<Vec<Document>>

Get documents relevant to a query.

fn get_name(&self) -> String

Get the name of this retriever.

fn get_ls_params(&self) -> LangSmithRetrieverParams

Get standard params for tracing.

fn aget_relevant_documents<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, query: &'life1 str, run_manager: Option<&'life2 AsyncCallbackManagerForRetrieverRun>, ) -> Pin<Box<dyn Future<Output = Result<Vec<Document>>> + Send + 'async_trait>>

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

Asynchronously get documents relevant to a query.

fn invoke( &self, input: &str, config: Option<RunnableConfig>, ) -> Result<Vec<Document>>

Invoke the retriever to get relevant documents.

fn ainvoke<'life0, 'life1, 'async_trait>( &'life0 self, input: &'life1 str, config: Option<RunnableConfig>, ) -> Pin<Box<dyn Future<Output = Result<Vec<Document>>> + Send + 'async_trait>>

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

Asynchronously invoke the retriever to get relevant documents.

fn batch( &self, inputs: Vec<&str>, config: Option<RunnableConfig>, ) -> Vec<Result<Vec<Document>>>

Transform multiple inputs into outputs in parallel.

fn abatch<'life0, 'life1, 'async_trait>( &'life0 self, inputs: Vec<&'life1 str>, config: Option<RunnableConfig>, ) -> Pin<Box<dyn Future<Output = Vec<Result<Vec<Document>>>> + Send + 'async_trait>>

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

Asynchronously transform multiple inputs into outputs.

impl Clone for SimpleRetriever

fn clone(&self) -> SimpleRetriever

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SimpleRetriever

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.