Trait Retriever 

pub trait Retriever: Send + Sync {
    // Required method
    fn retrieve<'life0, 'life1, 'async_trait>(
        &'life0 self,
        query: &'life1 str,
        top_k: usize,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<Document>, SynapseError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
}

Trait for retrieving relevant documents given a query string.

Required Methods

fn retrieve<'life0, 'life1, 'async_trait>( &'life0 self, query: &'life1 str, top_k: usize, ) -> Pin<Box<dyn Future<Output = Result<Vec<Document>, SynapseError>> + Send + 'async_trait>>

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

Implementors

impl Retriever for BM25Retriever

impl Retriever for ContextualCompressionRetriever

impl Retriever for EnsembleRetriever

impl Retriever for InMemoryRetriever

impl Retriever for MultiQueryRetriever

impl Retriever for ParentDocumentRetriever

impl Retriever for SelfQueryRetriever