Skip to main content

PrecomputedEmbedder

Struct PrecomputedEmbedder 

Source
pub struct PrecomputedEmbedder;
Expand description

An embedder that does not support text or image embedding, used for pre-computed vectors.

This embedder is used when documents already contain pre-computed vectors and no embedding is needed. It implements the Null Object Pattern, providing a concrete implementation that explicitly does nothing.

§Example

use std::sync::Arc;
use laurus::embedding::precomputed::PrecomputedEmbedder;
use laurus::embedding::embedder::Embedder;

let embedder: Arc<dyn Embedder> = Arc::new(PrecomputedEmbedder::new());
assert!(!embedder.supports_text());
assert!(!embedder.supports_image());

§When to Use

  • Pre-computed vectors: When vectors are computed externally before indexing
  • Testing: When embedding functionality is not needed in tests
  • Default placeholder: As a default value when embedder is required but not used

Implementations§

Source§

impl PrecomputedEmbedder

Source

pub fn new() -> Self

Creates a new PrecomputedEmbedder.

§Example
use laurus::embedding::precomputed::PrecomputedEmbedder;

let embedder = PrecomputedEmbedder::new();

Trait Implementations§

Source§

impl Clone for PrecomputedEmbedder

Source§

fn clone(&self) -> PrecomputedEmbedder

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

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PrecomputedEmbedder

Source§

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

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

impl Default for PrecomputedEmbedder

Source§

fn default() -> PrecomputedEmbedder

Returns the “default value” for a type. Read more
Source§

impl Embedder for PrecomputedEmbedder

Source§

fn embed<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _input: &'life1 EmbedInput<'life2>, ) -> Pin<Box<dyn Future<Output = Result<Vector>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Returns an error for any input, as this embedder does not support embedding.

Source§

fn supported_input_types(&self) -> Vec<EmbedInputType>

Returns an empty list as this embedder does not support any input types.

Source§

fn supports_text(&self) -> bool

Returns false as this embedder does not support text input.

Source§

fn supports_image(&self) -> bool

Returns false as this embedder does not support image input.

Source§

fn as_any(&self) -> &dyn Any

Returns a reference to self as &dyn Any for downcasting.

Source§

fn name(&self) -> &str

Get the name/identifier of this embedder. Read more
Source§

fn embed_batch<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, inputs: &'life1 [EmbedInput<'life2>], ) -> Pin<Box<dyn Future<Output = Result<Vec<Vector>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Generate embeddings for multiple inputs in batch. Read more
Source§

fn supports(&self, input_type: EmbedInputType) -> bool

Check if this embedder supports the given input type. Read more
Source§

fn is_multimodal(&self) -> bool

Check if this embedder is multimodal (supports both text and image).

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

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
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> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
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.