Struct ModelProviderInfo 

pub struct ModelProviderInfo {
    pub name: String,
    pub base_url: Option<String>,
    pub env_key: Option<String>,
    pub env_key_instructions: Option<String>,
    pub wire_api: WireApi,
    pub query_params: Option<HashMap<String, String>>,
    pub http_headers: Option<HashMap<String, String>>,
    pub env_http_headers: Option<HashMap<String, String>>,
    pub request_max_retries: Option<u64>,
    pub stream_max_retries: Option<u64>,
    pub stream_idle_timeout_ms: Option<u64>,
    pub requires_openai_auth: bool,
}

Serializable representation of a provider definition.

Fields

name: String

Friendly display name.

base_url: Option<String>

Base URL for the provider’s OpenAI-compatible API.

env_key: Option<String>

Environment variable that stores the user’s API key for this provider.

env_key_instructions: Option<String>

Optional instructions to help the user get a valid value for the variable and set it.

wire_api: WireApi

Which wire protocol this provider expects.

query_params: Option<HashMap<String, String>>

Optional query parameters to append to the base URL.

http_headers: Option<HashMap<String, String>>

Additional HTTP headers to include in requests to this provider where the (key, value) pairs are the header name and value.

env_http_headers: Option<HashMap<String, String>>

Optional HTTP headers to include in requests to this provider where the (key, value) pairs are the header name and environment variable whose value should be used. If the environment variable is not set, or the value is empty, the header will not be included in the request.

request_max_retries: Option<u64>

Maximum number of times to retry a failed HTTP request to this provider.

stream_max_retries: Option<u64>

Number of times to retry reconnecting a dropped streaming response before failing.

stream_idle_timeout_ms: Option<u64>

Idle timeout (in milliseconds) to wait for activity on a streaming response before treating the connection as lost.

requires_openai_auth: bool

Whether this provider requires some form of standard authentication (API key, ChatGPT token).

Implementations

impl ModelProviderInfo

pub async fn create_request_builder<'a>( &'a self, client: &'a Client, auth: &Option<CodexAuth>, ) -> Result<RequestBuilder>

Construct a POST RequestBuilder for the given URL using the provided reqwest Client applying: • provider-specific headers (static + env based) • Bearer auth header when an API key is available. • Auth token for OAuth.

If the provider declares an env_key but the variable is missing/empty, returns an Err identical to the one produced by ModelProviderInfo::api_key.

pub fn api_key(&self) -> Result<Option<String>>

If env_key is Some, returns the API key for this provider if present (and non-empty) in the environment. If env_key is required but cannot be found, returns an error.

pub fn request_max_retries(&self) -> u64

Effective maximum number of request retries for this provider.

pub fn stream_max_retries(&self) -> u64

Effective maximum number of stream reconnection attempts for this provider.

pub fn stream_idle_timeout(&self) -> Duration

Effective idle timeout for streaming responses.

Trait Implementations

impl Clone for ModelProviderInfo

fn clone(&self) -> ModelProviderInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModelProviderInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ModelProviderInfo

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ModelProviderInfo

fn eq(&self, other: &ModelProviderInfo) -> 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 ModelProviderInfo

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ModelProviderInfo