Trait Retrieve

pub trait Retrieve<S>:
    Send
    + Sync
    + DynClone
where
    S: SearchStrategy,
{
    // Required method
    fn retrieve<'life0, 'life1, 'async_trait>(
        &'life0 self,
        search_strategy: &'life1 S,
        query: Query<Pending>,
    ) -> Pin<Box<dyn Future<Output = Result<Query<Retrieved>, Error>> + Send + 'async_trait>>
       where 'life0: 'async_trait,
             'life1: 'async_trait,
             Self: 'async_trait;

    // Provided method
    fn name(&self) -> &'static str { ... }
}

Can retrieve documents given a SearchStrategy

Required Methods

fn retrieve<'life0, 'life1, 'async_trait>( &'life0 self, search_strategy: &'life1 S, query: Query<Pending>, ) -> Pin<Box<dyn Future<Output = Result<Query<Retrieved>, Error>> + Send + 'async_trait>>

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

Provided Methods

fn name(&self) -> &'static str

Trait Implementations

impl<'clone, S> Clone for Box<dyn Retrieve<S> + 'clone>

fn clone(&self) -> Box<dyn Retrieve<S> + 'clone>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'clone, S> Clone for Box<dyn Retrieve<S> + Send + 'clone>

fn clone(&self) -> Box<dyn Retrieve<S> + Send + 'clone>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'clone, S> Clone for Box<dyn Retrieve<S> + Send + Sync + 'clone>

fn clone(&self) -> Box<dyn Retrieve<S> + Send + Sync + 'clone>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'clone, S> Clone for Box<dyn Retrieve<S> + Sync + 'clone>

fn clone(&self) -> Box<dyn Retrieve<S> + Sync + 'clone>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> Retrieve<S> for Box<dyn Retrieve<S>>

where S: SearchStrategy,

fn retrieve<'life0, 'life1, 'async_trait>( &'life0 self, search_strategy: &'life1 S, query: Query<Pending>, ) -> Pin<Box<dyn Future<Output = Result<Query<Retrieved>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Box<dyn Retrieve<S>>: 'async_trait,

fn name(&self) -> &'static str

Implementations on Foreign Types

impl<S> Retrieve<S> for Box<dyn Retrieve<S>>

where S: SearchStrategy,

fn retrieve<'life0, 'life1, 'async_trait>( &'life0 self, search_strategy: &'life1 S, query: Query<Pending>, ) -> Pin<Box<dyn Future<Output = Result<Query<Retrieved>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Box<dyn Retrieve<S>>: 'async_trait,

fn name(&self) -> &'static str

impl<S> Retrieve<S> for Arc<dyn Retrieve<S>>

where S: SearchStrategy,

fn retrieve<'life0, 'life1, 'async_trait>( &'life0 self, search_strategy: &'life1 S, query: Query<Pending>, ) -> Pin<Box<dyn Future<Output = Result<Query<Retrieved>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Arc<dyn Retrieve<S>>: 'async_trait,

fn name(&self) -> &'static str

Implementors

impl Retrieve<CustomStrategy<QueryBuilder<'static, Postgres>>> for PgVector

impl Retrieve<HybridSearch> for Qdrant

Implement the Retrieve trait for HybridSearch search strategy.

Can be used in the query pipeline to retrieve documents from Qdrant.

Expects both a dense and sparse embedding to be set on the query.

impl Retrieve<SimilaritySingleEmbedding> for LanceDB

impl Retrieve<SimilaritySingleEmbedding> for PgVector

impl Retrieve<SimilaritySingleEmbedding> for Qdrant

Ensures that the SimilaritySingleEmbedding search strategy can be used when no filter is set.

impl Retrieve<SimilaritySingleEmbedding<String>> for LanceDB

Implement the Retrieve trait for SimilaritySingleEmbedding search strategy.

Can be used in the query pipeline to retrieve documents from LanceDB.

Supports filters as strings. Refer to the LanceDB documentation for the format.

impl Retrieve<SimilaritySingleEmbedding<String>> for PgVector

impl Retrieve<SimilaritySingleEmbedding<Filter>> for Qdrant

Implement the Retrieve trait for SimilaritySingleEmbedding search strategy.

Can be used in the query pipeline to retrieve documents from Qdrant.

Supports filters via the qdrant_client::qdrant::Filter type.

impl<Q> Retrieve<CustomStrategy<Q>> for LanceDB

where Q: ExecutableQuery + Send + Sync + 'static,

impl<S, F> Retrieve<S> for F

where S: SearchStrategy, F: Fn(&S, Query<Pending>) -> Result<Query<Retrieved>, Error> + Send + Sync + Clone,