Struct ClientConfigBuilder 

pub struct ClientConfigBuilder { /* private fields */ }

Builder for ClientConfig.

Construct with ClientConfigBuilder::new and call builder methods to customise the configuration, then call ClientConfigBuilder::build to obtain a ClientConfig.

Implementations

impl ClientConfigBuilder

pub fn new(api_key: impl Into<String>) -> Self

Create a new builder with the given API key and sensible defaults.

pub fn from_env() -> Self

Create a builder with no explicit API key.

load_env is true by default, so the key will be read from the provider’s environment variable (e.g. OPENAI_API_KEY) at client construction time. Call .load_env(false) to opt out.

pub fn load_env(self, enabled: bool) -> Self

Enable or disable automatic API key loading from environment variables.

When true (the default) and no explicit api_key was provided, [DefaultClient::new] reads the provider’s designated environment variable. Set to false to require an explicit key.

Has no effect on WASM targets.

pub fn base_url(self, url: impl Into<String>) -> Self

Override the provider base URL for all requests.

pub fn timeout(self, timeout: Duration) -> Self

Set the per-request timeout (default: 60 s).

pub fn max_retries(self, retries: u32) -> Self

Set the maximum number of retries on 429 / 5xx responses (default: 3).

pub fn credential_provider(self, provider: Arc<dyn CredentialProvider>) -> Self

Set a dynamic credential provider for token-based or refreshable auth.

When configured, the client calls resolve() before each request instead of using the static api_key for authentication.

pub fn header( self, key: impl Into<String>, value: impl Into<String>, ) -> Result<Self>

Add a custom header sent on every request.

Returns an error if either key or value is not a valid HTTP header name / value.

This method is only available when the native-http feature is enabled because header validation relies on reqwest’s header types.

pub fn build(self) -> ClientConfig

Consume the builder and return the completed ClientConfig.