Struct ProviderModelConfig 

#[non_exhaustive]
pub struct ProviderModelConfig {
    pub id: String,
    pub provider: String,
    pub wire_model: Option<String>,
    pub model_id: Option<String>,
    pub name: Option<String>,
    pub max_prompt_tokens: Option<i64>,
    pub max_context_window_tokens: Option<i64>,
    pub max_output_tokens: Option<i64>,
    pub capabilities: Option<ModelCapabilitiesOverride>,
}

A BYOK model definition in the multi-provider registry.

Experimental. Multi-provider BYOK configuration is part of an experimental surface and may change or be removed in a future release.

References a NamedProviderConfig by provider and becomes selectable under the provider-qualified id provider/id.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: String

Model identifier, unique within its provider. Combined with provider to form the selection id provider/id.

provider: String

Name of the NamedProviderConfig this model is served by.

wire_model: Option<String>

Model name sent to the provider API for inference. Use when the provider’s model name differs from id.

model_id: Option<String>

Well-known model ID used to look up agent config and default token limits.

name: Option<String>

Human-readable display name.

max_prompt_tokens: Option<i64>

Overrides the resolved model’s default max prompt tokens.

max_context_window_tokens: Option<i64>

Overrides the resolved model’s default max context window tokens.

max_output_tokens: Option<i64>

Overrides the resolved model’s default max output tokens.

capabilities: Option<ModelCapabilitiesOverride>

Per-property overrides for model capabilities, deep-merged over runtime defaults.

Implementations

impl ProviderModelConfig

pub fn new(id: impl Into<String>, provider: impl Into<String>) -> Self

Construct a ProviderModelConfig with the required id and provider set; all other fields default to unset.

pub fn with_wire_model(self, wire_model: impl Into<String>) -> Self

Set the model name sent to the provider API for inference.

pub fn with_model_id(self, model_id: impl Into<String>) -> Self

Set the well-known model ID used to look up agent config and default token limits.

pub fn with_name(self, name: impl Into<String>) -> Self

Set the human-readable display name.

pub fn with_max_prompt_tokens(self, max: i64) -> Self

Override the resolved model’s default max prompt tokens.

pub fn with_max_context_window_tokens(self, max: i64) -> Self

Override the resolved model’s default max context window tokens.

pub fn with_max_output_tokens(self, max: i64) -> Self

Override the resolved model’s default max output tokens.

pub fn with_capabilities(self, capabilities: ModelCapabilitiesOverride) -> Self

Set per-property model capability overrides.

Trait Implementations

impl Clone for ProviderModelConfig

fn clone(&self) -> ProviderModelConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProviderModelConfig

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

Formats the value using the given formatter.

impl Default for ProviderModelConfig

fn default() -> ProviderModelConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ProviderModelConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ProviderModelConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.