Enum EmbeddingModel 

pub enum EmbeddingModel {
    Default,
    HuggingFace {
        repo: String,
        revision: Option<String>,
        query_prefix: Option<String>,
        doc_prefix: Option<String>,
        pooling: Option<Pooling>,
        download: bool,
    },
    Local {
        path: PathBuf,
        query_prefix: Option<String>,
        doc_prefix: Option<String>,
        pooling: Option<Pooling>,
    },
    Endpoint {
        url: String,
        model: String,
        api_key_env: Option<String>,
        query_prefix: Option<String>,
        doc_prefix: Option<String>,
    },
}

The embedding model backing a catalog’s semantic/hybrid engines.

Variants

Default

Built-in bge-small-en-v1.5, pinned. The zero-config default.

HuggingFace

A BERT-family HuggingFace repo, loaded in-process via Candle. revision defaults to main; pooling is auto-detected when None. download (default false) must be opted into for Ratel to fetch it — otherwise it must already be in the local cache (Ratel auto-downloads only the default).

Fields

repo: String

HuggingFace repo id (e.g. intfloat/e5-small-v2).

revision: Option<String>

Git revision to pin; None → main.

query_prefix: Option<String>

Query-side prefix for asymmetric models.

doc_prefix: Option<String>

Document-side prefix for asymmetric models.

pooling: Option<Pooling>

Pooling override; None auto-detects.

download: bool

Opt in to downloading if not already cached.

Local

A BERT-family model directory on disk (config.json / tokenizer.json / model.safetensors), loaded in-process via Candle.

Fields

path: PathBuf

Path to the model directory.

query_prefix: Option<String>

Query-side prefix for asymmetric models.

doc_prefix: Option<String>

Document-side prefix for asymmetric models.

pooling: Option<Pooling>

Pooling override; None auto-detects.

Endpoint

An OpenAI-compatible /embeddings HTTP endpoint (OpenAI, Ollama, TEI, vLLM…). api_key_env names the env var holding the key (read at call time). Pooling lives server-side, so there is no pooling here.

Fields

url: String

Full endpoint URL.

model: String

Model name sent in the request body.

api_key_env: Option<String>

Env var holding the bearer key; None for no auth.

query_prefix: Option<String>

Query-side prefix for asymmetric models.

doc_prefix: Option<String>

Document-side prefix for asymmetric models.

Implementations

impl EmbeddingModel

pub fn validate(&self) -> Result<(), EmbedderError>

Validate a concrete Rust model value. SDK configs normally enter through Self::resolve, but Rust callers can construct public enum variants directly; this keeps that path subject to the same nonblank-field rules.

Errors

EmbedderError::Config when a required source, model, URL, or env-var name is blank.

pub fn resolve(spec: EmbeddingSpec) -> Result<EmbeddingModel, EmbedderError>

Validate and resolve a spec into a concrete model. Runs at catalog construction, so config mistakes surface immediately (not at first search).

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 Debug for EmbeddingModel

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

Formats the value using the given formatter.

impl PartialEq for EmbeddingModel

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for EmbeddingModel