Skip to main content

EmbeddingRetriever

Struct EmbeddingRetriever 

Source
pub struct EmbeddingRetriever<E, V> { /* private fields */ }
Expand description

Adapter that combines an Embedder and a VectorStore (scoped to one Namespace) into a Retriever.

Cloning is cheap — both the embedder and the store sit behind Arc, so multiple retrievers can share one connection pool / embedding client.

Implementations§

Source§

impl<E, V> EmbeddingRetriever<E, V>
where E: Embedder, V: VectorStore,

Source

pub const fn new(embedder: Arc<E>, store: Arc<V>, namespace: Namespace) -> Self

Build a retriever that runs every query against store scoped to namespace, using embedder to turn query text into the search vector.

Source

pub const fn embedder(&self) -> &Arc<E>

Borrow the wired embedder.

Source

pub const fn store(&self) -> &Arc<V>

Borrow the wired vector store.

Source

pub const fn namespace(&self) -> &Namespace

Borrow the configured namespace.

Trait Implementations§

Source§

impl<E, V> Clone for EmbeddingRetriever<E, V>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<E, V> Debug for EmbeddingRetriever<E, V>

Source§

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

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

impl<E, V> Retriever for EmbeddingRetriever<E, V>
where E: Embedder + 'static, V: VectorStore + 'static,

Source§

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

Look up matches for query.

Auto Trait Implementations§

§

impl<E, V> Freeze for EmbeddingRetriever<E, V>

§

impl<E, V> RefUnwindSafe for EmbeddingRetriever<E, V>

§

impl<E, V> Send for EmbeddingRetriever<E, V>
where E: Sync + Send, V: Sync + Send,

§

impl<E, V> Sync for EmbeddingRetriever<E, V>
where E: Sync + Send, V: Sync + Send,

§

impl<E, V> Unpin for EmbeddingRetriever<E, V>

§

impl<E, V> UnsafeUnpin for EmbeddingRetriever<E, V>

§

impl<E, V> UnwindSafe for EmbeddingRetriever<E, V>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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: 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: 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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