# # Copyright 2026 The Dapr Authors # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # http://www.apache.org/licenses/LICENSE-2.0 # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # import logging import os from typing import Optional, Union from azure.identity import ( DefaultAzureCredential, ManagedIdentityCredential, get_bearer_token_provider, ) from openai import AzureOpenAI from dapr_agents.llm.utils import HTTPHelper from dapr_agents.types.llm import AzureOpenAIClientConfig logger = logging.getLogger(__name__) class AzureOpenAIClient: """ Client for Azure OpenAI language models, handling API communication and authentication. """ def __init__( self, api_key: Optional[str] = None, azure_ad_token: Optional[str] = None, organization: Optional[str] = None, project: Optional[str] = None, api_version: Optional[str] = None, azure_endpoint: Optional[str] = None, azure_deployment: Optional[str] = None, azure_client_id: Optional[str] = None, timeout: Union[int, float, dict] = 1500, ): """ Initializes the client with API key or Azure AD credentials. Args: api_key: Azure OpenAI API key (inferred from env variable if not provided). azure_ad_token: Azure AD token (inferred from env variable if not provided). organization: Organization name (optional). project: Project name (optional). api_version: API version (inferred from env variable if not provided). azure_endpoint: Azure endpoint (inferred from env variable if not provided). azure_deployment: Deployment name (inferred from env variable if not provided). azure_client_id: Managed Identity client ID (optional). timeout: Request timeout in seconds (default: 1500). """ # Use provided values or fallback to environment variables self.api_key = api_key or os.getenv("AZURE_OPENAI_API_KEY") self.azure_ad_token = azure_ad_token or os.getenv("AZURE_OPENAI_AD_TOKEN") self.organization = organization or os.getenv("OPENAI_ORG_ID") self.project = project or os.getenv("OPENAI_PROJECT_ID") self.api_version = api_version or os.getenv("AZURE_OPENAI_API_VERSION") self.azure_endpoint = azure_endpoint or os.getenv("AZURE_OPENAI_ENDPOINT") self.azure_deployment = azure_deployment or os.getenv("AZURE_OPENAI_DEPLOYMENT") self.azure_client_id = azure_client_id or os.getenv("AZURE_CLIENT_ID") if not self.azure_endpoint or not self.azure_deployment: raise ValueError( "Azure OpenAI endpoint and deployment must be provided, either via arguments or environment variables." ) self.timeout = HTTPHelper.configure_timeout(timeout) def get_client(self) -> AzureOpenAI: """ Returns the Azure OpenAI client. Returns: AzureOpenAI: The initialized Azure OpenAI client. """ # Authentication: API Key, Azure AD Token, or Azure Identity # The api_key, azure_ad_token, and azure_ad_token_provider arguments are mutually exclusive. # Case 1: Use API Key if self.api_key: logger.info("Using API key for authentication.") return self._create_client(api_key=self.api_key) # Case 2: Use Azure AD Token if self.azure_ad_token: logger.info("Using Azure AD token for authentication.") return self._create_client(azure_ad_token=self.azure_ad_token) # Case 3: Use Azure Identity Credentials logger.info( "No API key or Azure AD token provided, attempting to use Azure Identity credentials." ) try: credential = ( ManagedIdentityCredential(client_id=self.azure_client_id) if self.azure_client_id else DefaultAzureCredential(exclude_shared_token_cache_credential=True) ) azure_ad_token_provider = get_bearer_token_provider( credential, "https://cognitiveservices.azure.com/.default" ) return self._create_client(azure_ad_token_provider=azure_ad_token_provider) except Exception as e: logger.error(f"Failed to initialize Azure Identity credentials: {e}") raise ValueError( "Unable to authenticate using Azure Identity credentials. Check your setup." ) from e def _create_client(self, **kwargs) -> AzureOpenAI: """ Helper method to create and return an Azure OpenAI client. """ return AzureOpenAI( azure_endpoint=self.azure_endpoint, azure_deployment=self.azure_deployment, api_version=self.api_version, timeout=self.timeout, **kwargs, ) @classmethod def from_config( cls, client_options: AzureOpenAIClientConfig, azure_client_id: Optional[str] = None, timeout: Union[int, float, dict] = 1500, ): """ Initialize AzureOpenAIClient using AzureOpenAIClientOptions. Args: client_options: An instance of AzureOpenAIClientOptions containing configuration details. azure_client_id: Optional Azure client ID for Managed Identity authentication. timeout: Optional timeout value for requests (default is 1500 seconds). Returns: AzureOpenAIClient: An initialized instance of AzureOpenAIClient. """ return cls( api_key=client_options.api_key, azure_ad_token=client_options.azure_ad_token, organization=client_options.organization, project=client_options.project, api_version=client_options.api_version, azure_endpoint=client_options.azure_endpoint, azure_deployment=client_options.azure_deployment, azure_client_id=azure_client_id, timeout=timeout, )