Struct Client

pub struct Client { /* private fields */ }

Implementations

impl Client

pub fn new( auth: impl Into<AzureOpenAIAuth>, api_version: &str, azure_endpoint: &str, ) -> Self

Creates a new Azure OpenAI client.

Arguments

• auth - Azure OpenAI API key or token required for authentication
• api_version - API version to use (e.g., “2024-10-21” for GA, “2024-10-01-preview” for preview)
• azure_endpoint - Azure OpenAI endpoint URL, for example: https://{your-resource-name}.openai.azure.com

pub fn with_custom_client(self, client: Client) -> Self

Use your own reqwest::Client. The required headers will be automatically attached upon trying to make a request.

pub fn from_api_key( api_key: &str, api_version: &str, azure_endpoint: &str, ) -> Self

Creates a new Azure OpenAI client from an API key.

Arguments

• api_key - Azure OpenAI API key required for authentication
• api_version - API version to use (e.g., “2024-10-21” for GA, “2024-10-01-preview” for preview)
• azure_endpoint - Azure OpenAI endpoint URL

pub fn from_token(token: &str, api_version: &str, azure_endpoint: &str) -> Self

Creates a new Azure OpenAI client from a token.

Arguments

• token - Azure OpenAI token required for authentication
• api_version - API version to use (e.g., “2024-10-21” for GA, “2024-10-01-preview” for preview)
• azure_endpoint - Azure OpenAI endpoint URL

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CompletionClient for Client

fn completion_model(&self, model: &str) -> CompletionModel

Create a completion model with the given name.

Example

use rig::providers::azure::{Client, self};

// Initialize the Azure OpenAI client
let azure = Client::new("YOUR_API_KEY", "YOUR_API_VERSION", "YOUR_ENDPOINT");

let gpt4 = azure.completion_model(azure::GPT_4);

type CompletionModel = CompletionModel

The type of CompletionModel used by the client.

fn agent(&self, model: &str) -> AgentBuilder<Self::CompletionModel>

Create an agent builder with the given completion model.

fn extractor<T: JsonSchema + for<'a> Deserialize<'a> + Serialize + Send + Sync>( &self, model: &str, ) -> ExtractorBuilder<T, Self::CompletionModel>

Create an extractor builder with the given completion model.

impl Debug for Client

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

Formats the value using the given formatter.

impl EmbeddingsClient for Client

fn embedding_model(&self, model: &str) -> EmbeddingModel

Create an embedding model with the given name. Note: default embedding dimension of 0 will be used if model is not known. If this is the case, it’s better to use function embedding_model_with_ndims

Example

use rig::providers::azure::{Client, self};

// Initialize the Azure OpenAI client
let azure = Client::new("YOUR_API_KEY", "YOUR_API_VERSION", "YOUR_ENDPOINT");

let embedding_model = azure.embedding_model(azure::TEXT_EMBEDDING_3_LARGE);

fn embedding_model_with_ndims( &self, model: &str, ndims: usize, ) -> EmbeddingModel

Create an embedding model with the given name and the number of dimensions in the embedding generated by the model.

Example

use rig::providers::azure::{Client, self};

// Initialize the Azure OpenAI client
let azure = Client::new("YOUR_API_KEY", "YOUR_API_VERSION", "YOUR_ENDPOINT");

let embedding_model = azure.embedding_model("model-unknown-to-rig", 3072);

type EmbeddingModel = EmbeddingModel

The type of EmbeddingModel used by the Client

fn embeddings<D: Embed>( &self, model: &str, ) -> EmbeddingsBuilder<Self::EmbeddingModel, D>

Create an embedding builder with the given embedding model.

fn embeddings_with_ndims<D: Embed>( &self, model: &str, ndims: usize, ) -> EmbeddingsBuilder<Self::EmbeddingModel, D>

Create an embedding builder with the given name and the number of dimensions in the embedding generated by the model.

impl ProviderClient for Client

fn from_env() -> Self

Create a new Azure OpenAI client from the AZURE_API_KEY or AZURE_TOKEN, AZURE_API_VERSION, and AZURE_ENDPOINT environment variables.

fn boxed(self) -> Box<dyn ProviderClient>

where Self: Sized + 'static,

A helper method to box the client.

fn from_env_boxed<'a>() -> Box<dyn ProviderClient + 'a>

where Self: Sized + 'a,

Create a boxed client from the process’s environment. Panics if an environment is improperly configured.

impl TranscriptionClient for Client

fn transcription_model(&self, model: &str) -> TranscriptionModel

Create a transcription model with the given name.

Example

use rig::providers::azure::{Client, self};

// Initialize the Azure OpenAI client
let azure = Client::new("YOUR_API_KEY", "YOUR_API_VERSION", "YOUR_ENDPOINT");

let whisper = azure.transcription_model("model-unknown-to-rig");

type TranscriptionModel = TranscriptionModel

The type of TranscriptionModel used by the Client