Struct Client 

pub struct Client<T = Client> { /* private fields */ }

Implementations

impl<T> Client<T>

where T: Default,

pub fn builder( auth: impl Into<AzureOpenAIAuth>, endpoint: &str, ) -> ClientBuilder<'_, T>

Create a new Azure OpenAI client builder.

Example

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

// Initialize the Azure OpenAI client
let azure = Client::builder("your-azure-api-key", "https://{your-resource-name}.openai.azure.com")
   .build()

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

Creates a new Azure OpenAI client. For more control, use the builder method.

Trait Implementations

impl AudioGenerationClient for Client<Client>

Available on crate feature audio only.

type AudioGenerationModel = AudioGenerationModel

The AudioGenerationModel used by the Client

fn audio_generation_model(&self, model: &str) -> Self::AudioGenerationModel

Create an audio generation model with the given name.

impl<T: Clone> Clone for Client<T>

fn clone(&self) -> Client<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CompletionClient for Client<Client>

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

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>( &self, model: &str, ) -> ExtractorBuilder<Self::CompletionModel, T>

where T: JsonSchema + for<'a> Deserialize<'a> + Serialize + Send + Sync,

Create an extractor builder with the given completion model.

impl<T> Debug for Client<T>

where T: Debug,

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

Formats the value using the given formatter.

impl EmbeddingsClient for Client<Client>

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

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<Client>

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 ImageGenerationClient for Client<Client>

Available on crate feature image only.

type ImageGenerationModel = ImageGenerationModel

The ImageGenerationModel used by the Client

fn image_generation_model(&self, model: &str) -> Self::ImageGenerationModel

Create an image generation model with the given name.

impl ProviderClient for Client<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 from_val(input: ProviderValue) -> Self

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.

fn from_val_boxed<'a>(input: ProviderValue) -> 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<Client>

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

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

impl VerifyClient for Client<Client>

async fn verify(&self) -> Result<(), VerifyError>

Verify the configuration.