Skip to main content

EmbeddingRetriever

Struct EmbeddingRetriever 

Source
pub struct EmbeddingRetriever<P: EmbeddingProvider> { /* private fields */ }
Expand description

In-memory vector retriever using cosine similarity search.

Stores document embeddings and retrieves the top-k most similar documents for a query, optionally filtered by a minimum similarity threshold.

Implementations§

Source§

impl<P: EmbeddingProvider> EmbeddingRetriever<P>

Source

pub fn new(provider: P) -> Self

Create a new retriever backed by the given EmbeddingProvider.

Source

pub fn with_similarity_threshold(self, threshold: f64) -> Self

Set the minimum cosine similarity required to include a result.

Results with similarity below this threshold are excluded.

§Example
let retriever = EmbeddingRetriever::new(Dummy).with_similarity_threshold(0.7);
Source

pub async fn add_documents(&mut self, documents: Vec<Document>) -> Result<()>

Embed and store documents in the in-memory vector store.

Calls embed() exactly once with all document texts.

§Errors

Returns an error if the embedding provider fails or returns the wrong number of embeddings.

Source

pub fn len(&self) -> usize

Number of stored documents.

Source

pub fn is_empty(&self) -> bool

Whether the vector store is empty.

Trait Implementations§

Source§

impl<P: EmbeddingProvider> Retriever for EmbeddingRetriever<P>

Source§

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

Embed query, compute cosine similarity with all stored docs, return top-k.

Auto Trait Implementations§

§

impl<P> Freeze for EmbeddingRetriever<P>
where P: Freeze,

§

impl<P> RefUnwindSafe for EmbeddingRetriever<P>
where P: RefUnwindSafe,

§

impl<P> Send for EmbeddingRetriever<P>

§

impl<P> Sync for EmbeddingRetriever<P>

§

impl<P> Unpin for EmbeddingRetriever<P>
where P: Unpin,

§

impl<P> UnsafeUnpin for EmbeddingRetriever<P>
where P: UnsafeUnpin,

§

impl<P> UnwindSafe for EmbeddingRetriever<P>
where P: UnwindSafe,

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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