Enum EmbeddingModel 

#[non_exhaustive]
pub enum EmbeddingModel {
    BgeSmallEnV15,
    BgeBaseEnV15,
    BgeLargeEnV15,
    MultilingualE5Small,
    MultilingualE5Base,
    Qwen3Embedding0_6B,
    Qwen3Embedding4B,
    AllMiniLmL6V2,
    ParaphraseMultilingualMiniLmL12V2,
    TextEmbedding3Small,
}

Stable: external consumers may depend on this; breaking changes require a SemVer bump.

Registry of supported local and remote embedding models.

See docs/model.md for model capabilities and identity rules.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

BgeSmallEnV15

BGE small English v1.5 (384 dimensions) - fast and efficient.

BgeBaseEnV15

BGE base English v1.5 (768 dimensions) - balanced quality/speed.

BgeLargeEnV15

BGE large English v1.5 (1024 dimensions) - highest quality local.

MultilingualE5Small

Multilingual E5 small (384 dimensions) - multilingual, same arch as BGE.

MultilingualE5Base

Multilingual E5 base (768 dimensions) - best multilingual quality/speed.

Qwen3Embedding0_6B

Qwen3-Embedding-0.6B (1024 dimensions) - multilingual, decoder-only, GPU-accelerated.

Qwen3Embedding4B

Qwen3-Embedding-4B (2560 dimensions, MRL-capable) - multilingual, decoder-only, GPU-accelerated.

AllMiniLmL6V2

all-MiniLM-L6-v2 (384 dimensions) - BERT-class, WordPiece tokenizer, sentence-transformers.

ParaphraseMultilingualMiniLmL12V2

paraphrase-multilingual-MiniLM-L12-v2 (384 dimensions) - multilingual, XLM-R base, sentence-transformers.

TextEmbedding3Small

OpenAI text-embedding-3-small (1536 dimensions) - remote API.

Implementations

impl EmbeddingModel

pub const fn native_dimensions(&self) -> usize

Stable: get the native (full-resolution) output dimension of this model’s embeddings.

Returns the model’s intrinsic dimension regardless of any MRL truncation. For MRL-capable models with a configured truncation, use ModelConfig::dimensions().

pub const fn dimensions(&self) -> usize

Stable: get this model’s native output dimension.

See docs/model.md for active-dimension selection.

pub const fn is_local(&self) -> bool

Stable: check if this model can run locally (via lattice-inference).

pub const fn is_remote(&self) -> bool

Stable: check if this model requires a remote API.

pub const fn max_input_tokens(&self) -> usize

Stable: conservative maximum input tokens for chunking and truncation.

See docs/model.md for per-model limits.

pub const fn query_instruction(&self) -> Option<&'static str>

Stable: query instruction prefix for asymmetric retrieval, when required.

See docs/model.md for prompt policy and vector-space implications.

pub const fn document_instruction(&self) -> Option<&'static str>

Stable: document instruction prefix for asymmetric retrieval, when required.

See docs/model.md for prompt policy and vector-space implications.

pub const fn max_instruction_bytes(&self) -> usize

Stable: byte length of this model’s longest retrieval instruction.

Zero for symmetric models, which take no prefix at all.

Callers apply an instruction to caller-supplied text, so text that has already been prepared is longer than what the caller passed by at most this many bytes. Length guards that run on prepared text size themselves with this; guards that run on caller text use MAX_TEXT_BYTES exactly.

pub const fn model_id(&self) -> &'static str

Stable: get the model identifier (HuggingFace ID or provider/model).

pub const fn supports_output_dim(&self) -> bool

Stable: whether this model supports configurable output dimensions (MRL/Matryoshka).

pub const fn bert_pooling(&self) -> Option<BertPooling>

Stable: BERT pooling strategy for this model, or None for non-BERT paths.

See docs/model.md for pooling routing.

pub const fn key_version(&self) -> &'static str

Stable: embedding key revision string for this model family.

Trait Implementations

impl Clone for EmbeddingModel

fn clone(&self) -> EmbeddingModel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for EmbeddingModel

impl Debug for EmbeddingModel

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

Formats the value using the given formatter.

impl Default for EmbeddingModel

fn default() -> EmbeddingModel

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EmbeddingModel

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for EmbeddingModel

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

Formats the value using the given formatter.

impl Eq for EmbeddingModel

impl FromStr for EmbeddingModel

fn from_str(s: &str) -> Result<Self, Self::Err>

Stable: parse a normalized canonical name, alias, or supported provider identifier.

See docs/model.md for accepted forms and persistence guidance.

type Err = String

The associated error which can be returned from parsing.

impl Hash for EmbeddingModel

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for EmbeddingModel

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for EmbeddingModel

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EmbeddingModel