FastEmbedModel

Enum FastEmbedModel 

Source
pub enum FastEmbedModel {
    BGESmallENV15,
    BGEBaseENV15,
    BGELargeENV15,
    AllMiniLML6V2,
    AllMiniLML12V2,
    MultilingualE5Small,
    MultilingualE5Base,
    MultilingualE5Large,
    Custom {
        name: String,
        dimensions: usize,
        max_sequence_length: Option<usize>,
    },
}
Expand description

Available FastEmbed models with their configurations

Variants§

§

BGESmallENV15

BGE Small English v1.5 (384 dimensions) Best for: General purpose, fast inference

§

BGEBaseENV15

BGE Base English v1.5 (768 dimensions) Best for: Balanced performance and quality

§

BGELargeENV15

BGE Large English v1.5 (1024 dimensions) Best for: High quality embeddings, slower inference

§

AllMiniLML6V2

All MiniLM L6 v2 (384 dimensions) Best for: Fast inference, good for semantic search

§

AllMiniLML12V2

All MiniLM L12 v2 (384 dimensions) Best for: Better quality than L6, still fast

§

MultilingualE5Small

Multilingual E5 Small (384 dimensions) Best for: Multilingual applications, 100+ languages

§

MultilingualE5Base

Multilingual E5 Base (768 dimensions) Best for: High-quality multilingual embeddings

§

MultilingualE5Large

Multilingual E5 Large (1024 dimensions) Best for: Best multilingual quality, slower inference

§

Custom

Custom model with name and dimensions

Fields

§name: String
§dimensions: usize
§max_sequence_length: Option<usize>

Implementations§

Source§

impl FastEmbedModel

Source

pub fn model_name(&self) -> &str

Get the model name string used by FastEmbed

Source

pub fn dimensions(&self) -> usize

Get the embedding dimensions

Source

pub fn max_sequence_length(&self) -> usize

Get the maximum sequence length supported by the model

Source

pub fn description(&self) -> &str

Get a description of the model

Source

pub fn language_support(&self) -> Vec<&str>

Get the languages supported by the model

Source

pub fn supports_language(&self, language: &str) -> bool

Check if the model supports a specific language

Source

pub fn model_family(&self) -> ModelFamily

Get the model family (BGE, MiniLM, E5, etc.)

Source

pub fn to_fastembed_model(&self) -> EmbeddingModel

Convert to fastembed EmbeddingModel enum

Source

pub fn use_cases(&self) -> Vec<&str>

Get recommended use cases for the model

Trait Implementations§

Source§

impl Clone for FastEmbedModel

Source§

fn clone(&self) -> FastEmbedModel

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 FastEmbedModel

Source§

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

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

impl<'de> Deserialize<'de> for FastEmbedModel

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Hash for FastEmbedModel

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for FastEmbedModel

Source§

fn eq(&self, other: &FastEmbedModel) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for FastEmbedModel

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for FastEmbedModel

Source§

impl StructuralPartialEq for FastEmbedModel

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> 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> 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> 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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