wx44wx/pipecat
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update AzureLLMService docstrings

Browse Source
This commit is contained in:
Mark Backman
2025-06-26 10:25:17 -04:00
parent 7bf805b829
commit 9cbe85bf99
1 changed files with 17 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
src/pipecat/services/azure/llm.py
View File

@@ -4,6 +4,8 @@
# SPDX-License-Identifier: BSD 2-Clause License # SPDX-License-Identifier: BSD 2-Clause License
# #
"""Azure OpenAI service implementation for the Pipecat AI framework."""
from loguru import logger from loguru import logger
from openai import AsyncAzureOpenAI from openai import AsyncAzureOpenAI
@@ -17,11 +19,11 @@ class AzureLLMService(OpenAILLMService):
maintaining full compatibility with OpenAI's interface and functionality. maintaining full compatibility with OpenAI's interface and functionality.
Args: Args:
api_key (str): The API key for accessing Azure OpenAI api_key: The API key for accessing Azure OpenAI.
endpoint (str): The Azure endpoint URL endpoint: The Azure endpoint URL.
model (str): The model identifier to use model: The model identifier to use.
api_version (str, optional): Azure API version. Defaults to "2024-09-01-preview" api_version: Azure API version. Defaults to "2024-09-01-preview".
**kwargs: Additional keyword arguments passed to OpenAILLMService **kwargs: Additional keyword arguments passed to OpenAILLMService.
""" """
def __init__( def __init__(
@@ -40,7 +42,16 @@ class AzureLLMService(OpenAILLMService):
super().__init__(api_key=api_key, model=model, **kwargs) super().__init__(api_key=api_key, model=model, **kwargs)
def create_client(self, api_key=None, base_url=None, **kwargs): def create_client(self, api_key=None, base_url=None, **kwargs):
"""Create OpenAI-compatible client for Azure OpenAI endpoint.""" """Create OpenAI-compatible client for Azure OpenAI endpoint.
Args:
api_key: API key for authentication. Uses instance key if None.
base_url: Base URL for the client. Ignored for Azure implementation.
**kwargs: Additional keyword arguments. Ignored for Azure implementation.
Returns:
AsyncAzureOpenAI: Configured Azure OpenAI client instance.
"""
logger.debug(f"Creating Azure OpenAI client with endpoint {self._endpoint}") logger.debug(f"Creating Azure OpenAI client with endpoint {self._endpoint}")
return AsyncAzureOpenAI( return AsyncAzureOpenAI(
api_key=api_key, api_key=api_key,