Skip to main content

EmbeddingsBuilder

Struct EmbeddingsBuilder 

Source
pub struct EmbeddingsBuilder<T> { /* private fields */ }
Expand description

Accumulates documents and embeds their extracted texts in provider-sized batches. Text extraction occurs when documents are added; requests start when built.

Implementations§

Source§

impl<T: Embed> EmbeddingsBuilder<T>

Source

pub fn new(model: impl Into<DynModel<EmbeddingOp>>) -> Self

Create a new embedding builder with the given embedding model

Source

pub fn document(self, document: T) -> Result<Self, EmbedError>

Add a document to be embedded to the builder. document must implement the Embed trait.

Source

pub fn documents( self, documents: impl IntoIterator<Item = T>, ) -> Result<Self, EmbedError>

Add multiple documents to be embedded to the builder. documents must be iterable with items that implement the Embed trait.

Source§

impl<T> EmbeddingsBuilder<T>
where T: Embed + WasmCompatSend,

Source

pub async fn build(self) -> Result<Vec<(T, Vec<Embedding>)>, ProviderError>

Generate embeddings for all documents in the builder.

Returns (document, embeddings) pairs. A document may produce one or many embeddings depending on how its Embed implementation uses TextEmbedder.

Preserves document insertion order and each document’s text order, regardless of batch completion order. Providers must return embeddings in input order within each batch; this is not checked.

Propagates provider and transport errors. Returns an error identifying the document if it produces no text or a batch returns too few embeddings. Empty embedded collections produce no text. Surplus embeddings are ignored.

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for EmbeddingsBuilder<T>

§

impl<T> !UnwindSafe for EmbeddingsBuilder<T>

§

impl<T> Freeze for EmbeddingsBuilder<T>
where Vec<(T, Vec<String>)>: Freeze,

§

impl<T> Send for EmbeddingsBuilder<T>
where Vec<(T, Vec<String>)>: Send,

§

impl<T> Sync for EmbeddingsBuilder<T>
where Vec<(T, Vec<String>)>: Sync,

§

impl<T> Unpin for EmbeddingsBuilder<T>
where Vec<(T, Vec<String>)>: Unpin,

§

impl<T> UnsafeUnpin for EmbeddingsBuilder<T>
where Vec<(T, Vec<String>)>: UnsafeUnpin,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WasmCompatSend for T
where T: Send,

Source§

impl<T> WasmCompatSync for T
where T: Sync,

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