Struct AzureConfig 

pub struct AzureConfig {
    pub azure_endpoint: Option<String>,
    pub azure_deployment: Option<String>,
    pub api_version: Option<String>,
    pub api_key: Option<String>,
    pub azure_ad_token: Option<String>,
}

Configuration builder for Azure OpenAI deployments.

Azure OpenAI uses different URL construction and authentication compared to the standard OpenAI API:

• URL: {endpoint}/openai/deployments/{deployment} or {endpoint}/openai
• Auth: api-key header (not Authorization: Bearer)
• Query: api-version parameter on every request

Examples

use openai_oxide::{OpenAI, AzureConfig};

let client = OpenAI::azure(
    AzureConfig::new()
        .azure_endpoint("https://my-resource.openai.azure.com")
        .azure_deployment("gpt-4")
        .api_version("2024-10-21")
        .api_key("my-azure-api-key")
)?;

// All resources work the same as with the standard client
let response = client.chat().completions().create(request).await?;

Fields

azure_endpoint: Option<String>

Azure endpoint URL, e.g. https://my-resource.openai.azure.com.

azure_deployment: Option<String>

Azure deployment name, e.g. gpt-4.

api_version: Option<String>

Azure API version, e.g. 2024-10-21.

api_key: Option<String>

Azure API key (mutually exclusive with azure_ad_token).

azure_ad_token: Option<String>

Azure AD token for authentication (mutually exclusive with api_key).

Implementations

impl AzureConfig

pub fn new() -> Self

Create a new empty Azure configuration.

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

Set the Azure endpoint URL.

Example: https://my-resource.openai.azure.com

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

Set the Azure deployment name.

When set, the base URL becomes {endpoint}/openai/deployments/{deployment}. When not set, the base URL is {endpoint}/openai.

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

Set the Azure API version.

Defaults to 2024-10-21 if not set and not in environment.

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

Set the Azure API key.

Mutually exclusive with azure_ad_token.

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

Set the Azure AD token for authentication.

Mutually exclusive with api_key. When using AD token auth, requests use Authorization: Bearer {token} instead of api-key header.

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

Build an OpenAI client from this Azure configuration.

Errors

Returns OpenAIError::InvalidArgument if:

• No endpoint is provided (and AZURE_OPENAI_ENDPOINT is not set)
• No credentials are provided (neither API key nor AD token)
• Both api_key and azure_ad_token are set (mutually exclusive)

pub fn from_env() -> Result<OpenAI, OpenAIError>

Build an OpenAI client from environment variables.

Reads:

• AZURE_OPENAI_API_KEY — API key
• AZURE_OPENAI_ENDPOINT — Azure endpoint URL
• OPENAI_API_VERSION — API version (defaults to 2024-10-21)
• AZURE_OPENAI_AD_TOKEN — Azure AD token (alternative to API key)

Trait Implementations

impl Clone for AzureConfig

fn clone(&self) -> AzureConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AzureConfig

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

Formats the value using the given formatter.

impl Default for AzureConfig

fn default() -> AzureConfig

Returns the “default value” for a type.