Struct AzureOpenAIClient 

pub struct AzureOpenAIClient { /* private fields */ }

An Azure OpenAI chat client (POST {endpoint}/openai/deployments/{deployment}/chat/completions).

Implementations

impl AzureOpenAIClient

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

Create a client authenticating with a static API key (api-key header).

pub fn with_token_credential( endpoint: impl Into<String>, deployment: impl Into<String>, credential: Arc<dyn TokenCredential>, ) -> Self

Create a client authenticating via a TokenCredential (Authorization: Bearer <token>, e.g. Microsoft Entra ID).

pub fn from_env() -> Result<Self>

Build an API-key-authenticated client from AZURE_OPENAI_ENDPOINT, AZURE_OPENAI_API_KEY, AZURE_OPENAI_CHAT_DEPLOYMENT_NAME, and optional AZURE_OPENAI_API_VERSION.

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

Override the API version (default "2024-10-21").

pub fn deployment(&self) -> &str

The deployment name this client targets.

pub fn api_version(&self) -> &str

The API version this client sends.

Trait Implementations

impl ChatClient for AzureOpenAIClient

fn get_response<'life0, 'async_trait>( &'life0 self, messages: Vec<Message>, options: ChatOptions, ) -> Pin<Box<dyn Future<Output = Result<ChatResponse>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get a complete (non-streaming) response.

fn get_streaming_response<'life0, 'async_trait>( &'life0 self, messages: Vec<Message>, options: ChatOptions, ) -> Pin<Box<dyn Future<Output = Result<ChatStream>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get a streaming response as a sequence of updates.

fn model(&self) -> Option<&str>

The default model id for this client, if any.

impl Clone for AzureOpenAIClient

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AzureOpenAIClient

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

Formats the value using the given formatter.