Struct ModelAliasSpec 

pub struct ModelAliasSpec {
    pub alias: String,
    pub task: ModelTask,
    pub provider_id: String,
    pub model_id: String,
    pub revision: Option<String>,
    pub warmup: WarmupPolicy,
    pub required: bool,
    pub timeout: Option<u64>,
    pub load_timeout: Option<u64>,
    pub retry: Option<RetryConfig>,
    pub options: Value,
}

Declarative specification that maps a human-readable alias to a concrete provider and model.

A model catalog is a Vec<ModelAliasSpec> — either built programmatically or parsed from JSON with catalog_from_str / catalog_from_file.

Example JSON

{
  "alias": "embed/default",
  "task": "embed",
  "provider_id": "local/candle",
  "model_id": "sentence-transformers/all-MiniLM-L6-v2",
  "warmup": "lazy"
}

Fields

alias: String

Human-readable name used to request this model (e.g. "embed/default"). Must contain a / separator.

task: ModelTask

The inference task this alias targets.

provider_id: String

Identifier of the provider that will load this model (e.g. "local/candle", "remote/openai").

model_id: String

Model identifier understood by the provider — typically a HuggingFace repo ID for local providers or an API model name for remote providers.

revision: Option<String>

Optional HuggingFace revision (branch, tag, or commit hash).

warmup: WarmupPolicy

When this model should be initialized. Defaults to WarmupPolicy::Lazy.

required: bool

If true, a failed eager warmup aborts runtime startup. Defaults to false.

timeout: Option<u64>

Per-inference timeout in seconds. None means no timeout.

load_timeout: Option<u64>

Model load timeout in seconds. Defaults to 600 s if unset.

retry: Option<RetryConfig>

Retry configuration for transient inference failures.

options: Value

Provider-specific options (e.g. {"isq": "Q4K"} for mistral.rs, {"api_key_env": "MY_KEY"} for remote providers). Defaults to {}.

Implementations

impl ModelAliasSpec

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

Validate invariants: alias must be non-empty and contain a '/', timeouts must be non-zero when set.

pub fn from_json(value: Value) -> Result<ModelAliasSpec, RuntimeError>

Parse a single ModelAliasSpec from a JSON value.

pub fn from_json_str(s: &str) -> Result<ModelAliasSpec, RuntimeError>

Parse a single ModelAliasSpec from a JSON string.

Trait Implementations

impl Clone for ModelAliasSpec

fn clone(&self) -> ModelAliasSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModelAliasSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ModelAliasSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ModelAliasSpec

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for ModelAliasSpec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ModelAliasSpec