Struct Embed

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

A transformer that can generate embeddings for an Node

This file defines the Embed struct and its implementation of the BatchableTransformer trait.

Implementations§

Source§

impl Embed

Source

pub fn new(model: impl EmbeddingModel + 'static) -> Self

Creates a new instance of the Embed transformer.

§Parameters
  • model - An embedding model that implements the EmbeddingModel trait.
§Returns

A new instance of Embed.

Source

pub fn with_concurrency(self, concurrency: usize) -> Self

Source

pub fn with_batch_size(self, batch_size: usize) -> Self

Sets the batch size for the transformer. If the batch size is not set, the transformer will use the default batch size set by the pipeline # Parameters

  • batch_size - The batch size to use for the transformer.
§Returns

A new instance of Embed.

Trait Implementations§

Source§

impl BatchableTransformer for Embed

Source§

fn batch_transform<'life0, 'async_trait>( &'life0 self, nodes: Vec<Node>, ) -> Pin<Box<dyn Future<Output = IndexingStream> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Transforms a batch of Node objects by generating embeddings for them.

§Parameters
  • nodes - A vector of Node objects to be transformed.
§Returns

An IndexingStream containing the transformed Node objects with their embeddings.

§Errors

If the embedding process fails, the function returns a stream with the error.

Source§

fn concurrency(&self) -> Option<usize>

Overrides the default concurrency of the pipeline
Source§

fn batch_size(&self) -> Option<usize>

Overrides the default batch size of the pipeline
Source§

fn name(&self) -> &'static str

Source§

impl Clone for Embed

Source§

fn clone(&self) -> Embed

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Embed

Source§

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

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

impl WithBatchIndexingDefaults for Embed

Source§

fn with_indexing_defaults(&mut self, _indexing_defaults: IndexingDefaults)

Source§

impl WithIndexingDefaults for Embed

Source§

fn with_indexing_defaults(&mut self, _indexing_defaults: IndexingDefaults)

Auto Trait Implementations§

§

impl Freeze for Embed

§

impl !RefUnwindSafe for Embed

§

impl Send for Embed

§

impl Sync for Embed

§

impl Unpin for Embed

§

impl !UnwindSafe for Embed

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

Source§

fn vzip(self) -> V

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
Source§

impl<T> ErasedDestructor for T
where T: 'static,