Struct EmbeddingSpec 

pub struct EmbeddingSpec {
    pub spec: Option<String>,
    pub huggingface: Option<String>,
    pub local: Option<String>,
    pub ollama: Option<String>,
    pub url: Option<String>,
    pub model: Option<String>,
    pub revision: Option<String>,
    pub api_key_env: Option<String>,
    pub query_prefix: Option<String>,
    pub doc_prefix: Option<String>,
    pub pooling: Option<String>,
    pub download: Option<bool>,
}

Normalized, cross-SDK embedding config as forwarded by the native bindings. Exactly one primary source must be set: either spec (the raw string shortcut) or one of huggingface / local / ollama / url. The rest are modifiers.

Fields

spec: Option<String>

Raw string shortcut — a local model directory path only. A repo-id or URL string is rejected in favor of the explicit huggingface/url keys.

huggingface: Option<String>

Primary source: a HuggingFace repo id.

local: Option<String>

Primary source: a local model directory path.

ollama: Option<String>

Primary source: an Ollama model name (served via the local Ollama endpoint).

url: Option<String>

Primary source: a full OpenAI-compatible endpoint URL.

model: Option<String>

Model name for an endpoint source.

revision: Option<String>

Git revision for a HuggingFace source.

api_key_env: Option<String>

Env var holding the endpoint bearer key.

query_prefix: Option<String>

Query-side prefix for asymmetric models.

doc_prefix: Option<String>

Document-side prefix for asymmetric models (e.g. e5’s "passage: ").

pooling: Option<String>

"cls" | "mean" — overrides auto-detection for an in-process model.

download: Option<bool>

Opt in to letting Ratel download a HuggingFace model that is not yet cached (default false; the built-in default always downloads).

Trait Implementations

impl Clone for EmbeddingSpec

fn clone(&self) -> EmbeddingSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EmbeddingSpec

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

Formats the value using the given formatter.

impl Default for EmbeddingSpec

fn default() -> EmbeddingSpec

Returns the “default value” for a type.