Struct AzureAuth 

pub struct AzureAuth { /* private fields */ }

Azure OpenAI API authentication configuration

Handles authentication for Azure OpenAI Service, which uses different header names and endpoint URL patterns than the standard OpenAI API.

Header Format

api-key: {key}

Endpoint Format

The base_url should be a complete endpoint URL including deployment path, API path (e.g., /chat/completions), and query parameters (e.g., ?api-version=...). The endpoint() method returns this URL as-is.

Example

use openai_tools::common::auth::AzureAuth;

// For Chat API
let auth = AzureAuth::new(
    "your-api-key",
    "https://my-resource.openai.azure.com/openai/deployments/gpt-4o/chat/completions?api-version=2024-08-01-preview"
);

// For Embedding API
let auth = AzureAuth::new(
    "your-api-key",
    "https://my-resource.openai.azure.com/openai/deployments/text-embedding/embeddings?api-version=2024-08-01-preview"
);

Implementations

impl AzureAuth

pub fn new<T: Into<String>>(api_key: T, base_url: T) -> Self

Creates a new Azure OpenAI authentication configuration

Arguments

• api_key - Azure OpenAI API key
• base_url - Complete endpoint URL including deployment path, API path, and api-version

Returns

A new AzureAuth instance

Example

use openai_tools::common::auth::AzureAuth;

// Complete endpoint URL for Chat API
let auth = AzureAuth::new(
    "your-api-key",
    "https://my-resource.openai.azure.com/openai/deployments/gpt-4o/chat/completions?api-version=2024-08-01-preview"
);

pub fn api_key(&self) -> &str

Returns the API key

pub fn base_url(&self) -> &str

Returns the base URL

Trait Implementations

impl Clone for AzureAuth

fn clone(&self) -> AzureAuth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AzureAuth

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

Formats the value using the given formatter.