Skip to main content

MultimodalRetriever

Struct MultimodalRetriever 

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

Retriever over a shared image/text vector space.

Implementations§

Source§

impl MultimodalRetriever

Source

pub fn new( store: Arc<dyn VectorStore>, vision: Arc<dyn VisionEmbeddings>, ) -> Self

Creates a multimodal retriever over store, embedding both modalities with the shared-space vision model.

Source

pub async fn retrieve_modality( &self, query: &str, k: usize, modality: ModalityFilter, ) -> Result<Vec<Document>, RetrieverError>

Retrieves with a text query restricted to modality.

Source

pub async fn retrieve_with_scores_modality( &self, query: &str, k: usize, modality: ModalityFilter, ) -> Result<Vec<SearchResult>, RetrieverError>

Retrieves with a text query, returning scores and modality metadata.

Source

pub async fn retrieve_by_image( &self, image: &ImageInput, k: usize, modality: ModalityFilter, ) -> Result<Vec<Document>, RetrieverError>

Retrieves with an image query (image→image / image→text search).

Trait Implementations§

Source§

impl Debug for MultimodalRetriever

Source§

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

Formats the value using the given formatter. Read more
Source§

impl RetrieverTrait for MultimodalRetriever

Source§

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

Retrieves relevant documents Read more
Source§

fn retrieve_with_scores<'life0, 'life1, 'async_trait>( &'life0 self, query: &'life1 str, k: usize, ) -> Pin<Box<dyn Future<Output = Result<Vec<SearchResult>, RetrieverError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Retrieves relevant documents (with scores)
Source§

fn add_documents<'life0, 'async_trait>( &'life0 self, documents: Vec<Document>, ) -> Pin<Box<dyn Future<Output = Result<(), RetrieverError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Adds documents

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