Struct ProviderModelConfig 

pub struct ProviderModelConfig {
    pub capabilities: Option<ModelCapabilitiesOverride>,
    pub id: String,
    pub max_context_window_tokens: Option<i64>,
    pub max_output_tokens: Option<i64>,
    pub max_prompt_tokens: Option<i64>,
    pub model_id: Option<String>,
    pub name: Option<String>,
    pub provider: String,
    pub system_message: Option<Value>,
    pub wire_model: Option<String>,
}

A BYOK model definition referencing a named provider.

Experimental. This type is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases.

Fields

capabilities: Option<ModelCapabilitiesOverride>

Optional capability overrides (vision, tool_calls, reasoning, etc.).

id: String

Provider-local model id, unique within its provider. The session-wide selection id (shown in the model list and passed to switchTo) is the provider-qualified provider/id.

max_context_window_tokens: Option<i64>

Maximum context window tokens for the model.

max_output_tokens: Option<i64>

Maximum output tokens for the model.

max_prompt_tokens: Option<i64>

Maximum prompt/input tokens for the model.

model_id: Option<String>

Well-known base model id used for behavior/capability/config lookup. Defaults to id.

name: Option<String>

Display name for model pickers. Defaults to the provider-qualified selection id (provider/id).

provider: String

Name of the configured provider that serves this model.

system_message: Option<Value>

System-message configuration used when the runtime builds the standard prompt for this provider-qualified model, including general-purpose subagents. It uses the same object hierarchy as session-level systemMessage configuration, except transform actions are rejected because the current callback protocol is not model-scoped. When present, it overrides the session-wide configuration on those prompt paths. Selected custom-agent and specialized-subagent prompts remain authoritative.

wire_model: Option<String>

The model name sent to the provider API for inference. Defaults to id.

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.