Skip to main content

ProviderConfig

Struct ProviderConfig 

Source
pub struct ProviderConfig {
    pub api_key: Option<String>,
    pub azure: Option<ProviderConfigAzure>,
    pub base_url: String,
    pub bearer_token: Option<String>,
    pub headers: Option<HashMap<String, String>>,
    pub max_context_window_tokens: Option<f64>,
    pub max_output_tokens: Option<f64>,
    pub max_prompt_tokens: Option<f64>,
    pub model_id: Option<String>,
    pub type: Option<ProviderConfigType>,
    pub wire_api: Option<ProviderConfigWireApi>,
    pub wire_model: Option<String>,
}
Expand description

Custom model-provider configuration (BYOK).

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

Fields§

§api_key: Option<String>

API key. Optional for local providers like Ollama.

§azure: Option<ProviderConfigAzure>

Azure-specific provider options.

§base_url: String

API endpoint URL.

§bearer_token: Option<String>

Bearer token for authentication. Sets the Authorization header directly. Takes precedence over apiKey when both are set.

§headers: Option<HashMap<String, String>>

Custom HTTP headers to include in all outbound requests to the provider.

§max_context_window_tokens: Option<f64>

Maximum context window tokens for the model.

§max_output_tokens: Option<f64>

Maximum output tokens for the model.

§max_prompt_tokens: Option<f64>

Maximum prompt/input tokens for the model.

§model_id: Option<String>

Well-known model ID used for capability lookup. When set, agent behavior config and token limits are inferred from this model.

§type: Option<ProviderConfigType>

Provider type. Defaults to “openai” for generic OpenAI-compatible APIs.

§wire_api: Option<ProviderConfigWireApi>

Wire API format (openai/azure only). Defaults to “completions”.

§wire_model: Option<String>

The model identifier sent to the provider API for inference (the “wire” model), as opposed to modelId which is the well-known base.

Trait Implementations§

Source§

impl Clone for ProviderConfig

Source§

fn clone(&self) -> ProviderConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ProviderConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ProviderConfig

Source§

fn default() -> ProviderConfig

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ProviderConfig

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ProviderConfig

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more