Skip to main content

MultiQueryRetriever

Struct MultiQueryRetriever 

Source
pub struct MultiQueryRetriever { /* private fields */ }
Expand description

MultiQueryRetriever

Uses an LLM to generate multiple query variants, retrieves with the base retriever for each one, then merges and dedups the results before returning.

Implementations§

Source§

impl MultiQueryRetriever

Source

pub fn new<L>(llm: L, base_retriever: Arc<dyn RetrieverTrait>) -> Self
where L: BaseChatModel + Send + Sync + 'static, L::Error: Into<ProviderError>,

Creates a MultiQueryRetriever (accepting any LLM implementing BaseChatModel)

Source

pub fn new_arc( llm: Arc<dyn BaseChatModel<Error = ProviderError> + Send + Sync>, base_retriever: Arc<dyn RetrieverTrait>, ) -> Self

P0-3: Builds from an already-wrapped Arc<dyn BaseChatModel<Error = ProviderError>>

Source

pub fn with_config(self, config: MultiQueryConfig) -> Self

Sets the MultiQuery configuration

Source

pub fn with_num_queries(self, n: usize) -> Self

Sets the number of generated queries

Source

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

Sets the number of documents returned per query

Source

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

Sets the number of documents returned in the final result

Source

pub async fn retrieve_multi( &self, query: &str, ) -> Result<Vec<Document>, MultiQueryError>

Generates multiple query variants, retrieves each one, and returns the merged deduped documents

Source

pub async fn retrieve_multi_with_scores( &self, query: &str, ) -> Result<Vec<SearchResult>, MultiQueryError>

Generates multiple query variants, retrieves each one, and returns the merged deduped results with scores

Source

pub async fn get_generated_queries( &self, query: &str, ) -> Result<Vec<String>, MultiQueryError>

Returns the LLM-generated query variants (without retrieving)

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more