Struct ClientBuilder 

pub struct ClientBuilder { /* private fields */ }

Builder for Client. Unset fields fall back to the same environment variables the Python SDK uses: OPENAI_API_KEY, OPENAI_BASE_URL, OPENAI_ORG_ID, OPENAI_PROJECT_ID.

Implementations

impl ClientBuilder

pub fn new() -> Self

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

API key used in the Authorization: Bearer header.

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

Base URL of the API, e.g. https://api.openai.com/v1 or any OpenAI-compatible provider endpoint.

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

Sent as the OpenAI-Organization header.

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

Sent as the OpenAI-Project header.

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

Read timeout, applied per read operation (mirroring the Python SDK’s httpx behavior) so streaming responses are not cut off by a total deadline. Defaults to 600 seconds.

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

Connection timeout. Defaults to 5 seconds.

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

Maximum number of retries for retryable failures. Defaults to 2.

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

Add a header sent with every request.

pub fn azure( self, endpoint: impl Into<String>, api_version: impl Into<String>, ) -> Self

Target an Azure OpenAI resource, mirroring the Python AzureOpenAI client: requests go to {endpoint}/openai[...] with an api-version query parameter, authenticated via api-key header (or a bearer token set with ClientBuilder::azure_ad_token).

The API key falls back to the AZURE_OPENAI_API_KEY environment variable; api_version may be empty to use OPENAI_API_VERSION.

pub fn azure_deployment(self, deployment: impl Into<String>) -> Self

Pin all requests to a specific Azure deployment ({endpoint}/openai/deployments/{deployment}). Without this, the deployment is derived per request from the body’s model field.

pub fn azure_ad_token(self, token: impl Into<String>) -> Self

Authenticate to Azure with an Entra ID (Azure AD) bearer token instead of an API key. Falls back to AZURE_OPENAI_AD_TOKEN.

pub fn build(self) -> Result<Client, OpenAIError>

Resolve environment fallbacks and construct the Client.

Trait Implementations

impl Clone for ClientBuilder

fn clone(&self) -> ClientBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientBuilder

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

Formats the value using the given formatter.

impl Default for ClientBuilder

fn default() -> ClientBuilder

Returns the “default value” for a type.