Struct AzureOpenAIEmbeddingClient 

pub struct AzureOpenAIEmbeddingClient { /* private fields */ }

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

Implementations

impl AzureOpenAIEmbeddingClient

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_EMBEDDING_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 DEFAULT_API_VERSION).

pub fn deployment(&self) -> &str

The deployment name this client targets.

Trait Implementations

impl Clone for AzureOpenAIEmbeddingClient

fn clone(&self) -> AzureOpenAIEmbeddingClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl EmbeddingClient for AzureOpenAIEmbeddingClient

fn get_embeddings<'life0, 'async_trait>( &'life0 self, values: Vec<String>, options: Option<EmbeddingGenerationOptions>, ) -> Pin<Box<dyn Future<Output = Result<GeneratedEmbeddings>> + Send + 'async_trait>>

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

Generate embeddings for the given values (one per value, in order).

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

The default embedding model id for this client, if any.