Skip to content

armgit / camel

Public Imported from GitHub
0

🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org

4.5 KB
Raw Blame
<a id="camel.models.azure_openai_model"></a>

<a id="camel.models.azure_openai_model.AzureOpenAIModel"></a>

## AzureOpenAIModel

```python
class AzureOpenAIModel(OpenAIModel):
```

Azure OpenAI API in a unified BaseModelBackend interface.

Inherits all Responses API, chat completion, and streaming methods
from :obj:`OpenAIModel`. Only the client initialization and
Azure-specific configuration are different.

**Parameters:**

- **model_type** (Union[ModelType, str]): Model for which a backend is created, Should be the deployment name you chose when you deployed an azure model.
- **model_config_dict** (Optional[Dict[str, Any]], optional): A dictionary that will be fed into:obj:`openai.ChatCompletion.create()`. If :obj:`None`, :obj:`ChatGPTConfig().as_dict()` will be used. (default: :obj:`None`)
- **api_key** (Optional[str], optional): The API key for authenticating with the OpenAI service. (default: :obj:`None`)
- **url** (Optional[str], optional): The url to the OpenAI service. (default: :obj:`None`)
- **api_version** (Optional[str], optional): The api version for the model. (default: :obj:`None`)
- **azure_ad_token** (Optional[str], optional): Your Azure Active Directory token, https://www.microsoft.com/en-us/security/business/ identity-access/microsoft-entra-id. (default: :obj:`None`)
- **azure_ad_token_provider** (Optional[AzureADTokenProvider], optional): A function that returns an Azure Active Directory token, will be invoked on every request. (default: :obj:`None`)
- **token_counter** (Optional[BaseTokenCounter], optional): Token counter to use for the model. If not provided, :obj:`OpenAITokenCounter` will be used. (default: :obj:`None`)
- **timeout** (Optional[float], optional): The timeout value in seconds for API calls. If not provided, will fall back to the MODEL_TIMEOUT environment variable or default to 180 seconds. (default: :obj:`None`)
- **max_retries** (int, optional): Maximum number of retries for API calls. (default: :obj:`3`)
- **client** (Optional[Any], optional): A custom synchronous AzureOpenAI client instance. If provided, this client will be used instead of creating a new one. Useful for RL frameworks like AReaL or rLLM that provide Azure OpenAI-compatible clients. The client should implement the AzureOpenAI client interface with `.chat.completions.create()` and `.beta.chat.completions.parse()` methods. (default: :obj:`None`)
- **async_client** (Optional[Any], optional): A custom asynchronous AzureOpenAI client instance. If provided, this client will be used instead of creating a new one. The client should implement the AsyncAzureOpenAI client interface. (default: :obj:`None`)
- **azure_deployment_name** (Optional[str], optional): **Deprecated**. Use `model_type` parameter instead. This parameter is kept for backward compatibility and will be removed in a future version. (default: :obj:`None`)
- **api_mode** (`Literal["chat_completions", "responses"], optional`): Azure OpenAI API mode to use. Supported values: `"chat_completions"` (default) and `"responses"`. The `"responses"` mode uses the Azure OpenAI Responses API, which supports stateful response chaining via `previous_response_id`. (default: :obj:`"chat_completions"`) **kwargs (Any): Additional arguments to pass to the client initialization. Ignored if custom clients are provided.
- **References**: 
- **https**: //learn.microsoft.com/en-us/azure/ai-services/openai/

<a id="camel.models.azure_openai_model.AzureOpenAIModel.__init__"></a>

### __init__

```python
def __init__(
    self,
    model_type: Union[ModelType, str],
    model_config_dict: Optional[Dict[str, Any]] = None,
    api_key: Optional[str] = None,
    url: Optional[str] = None,
    timeout: Optional[float] = None,
    token_counter: Optional[BaseTokenCounter] = None,
    api_version: Optional[str] = None,
    azure_ad_token_provider: Optional['AzureADTokenProvider'] = None,
    azure_ad_token: Optional[str] = None,
    max_retries: int = 3,
    client: Optional[Any] = None,
    async_client: Optional[Any] = None,
    azure_deployment_name: Optional[str] = None,
    api_mode: Literal['chat_completions', 'responses'] = 'chat_completions',
    **kwargs: Any
):
```

<a id="camel.models.azure_openai_model.AzureOpenAIModel._sanitize_config"></a>

### _sanitize_config

```python
def _sanitize_config(self, config_dict: Dict[str, Any]):
```

No-op (Azure does not need)

<a id="camel.models.azure_openai_model.AzureOpenAIModel._adapt_messages_for_o1_models"></a>

### _adapt_messages_for_o1_models

```python
def _adapt_messages_for_o1_models(self, messages: List[OpenAIMessage]):
```

No-op (Azure does not need)