Skip to main content

EmbedModel

Struct EmbedModel 

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

A local embedding model backed by fastembed (ONNX Runtime).

Constructed via FastEmbedModel::from_options. The underlying fastembed::TextEmbedding is synchronous, so all calls to FastEmbedModel::embed are dispatched onto Tokio’s blocking thread pool via tokio::task::spawn_blocking.

Implementations§

Source§

impl FastEmbedModel

Source

pub fn from_options( opts: FastEmbedOptions, ) -> Result<FastEmbedModel, FastEmbedError>

Construct a new FastEmbedModel from the given options.

This is a blocking operation that may download model weights from HuggingFace on first use. Call from a context where blocking is acceptable (e.g. application startup), or wrap in tokio::task::spawn_blocking.

§Errors

Returns FastEmbedError if the fastembed model fails to initialise (e.g. unknown model name, network error during download).

Source

pub fn model_id(&self) -> &str

The model identifier (e.g. "Xenova/bge-small-en-v1.5").

Source

pub fn dimensions(&self) -> usize

Embedding vector dimensionality for this model.

Source

pub async fn embed( &self, texts: &[String], ) -> Result<FastEmbedResponse, FastEmbedError>

Embed one or more texts, returning one vector per input text.

The fastembed crate’s embed method is synchronous – this function dispatches the work onto Tokio’s blocking thread pool via tokio::task::spawn_blocking to avoid starving the async runtime.

§Errors

Returns FastEmbedError if the underlying fastembed call fails or the blocking task panics.

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> 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, 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, 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