chore: unify Azure OpenAI model type interface (#3353)

Author: Wendong-Fan

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -26,7 +26,7 @@ body:
     attributes:
       label: What version of camel are you using?
       description: Run command `python3 -c 'print(__import__("camel").__version__)'` in your shell and paste the output here.
-      placeholder: E.g., 0.2.79a0
+      placeholder: E.g., 0.2.79a1
     validations:
       required: true
 

.github/workflows/pytest_package.yml

@@ -209,10 +209,10 @@ jobs:
         ZHIPUAI_API_BASE_URL: "${{ secrets.ZHIPUAI_API_BASE_URL }}"
         ZHIPUAI_API_KEY: "${{ secrets.ZHIPUAI_API_KEY }}"
         HF_TOKEN: "${{ secrets.HF_TOKEN }}"
-        AZURE_OPENAI_API_KEY: ${{ secrets.AZURE_OPENAI_API_KEY }}"
-        AZURE_API_VERSION: ${{ secrets.AZURE_API_VERSION }}"
-        AZURE_DEPLOYMENT_NAME: ${{ secrets.AZURE_DEPLOYMENT_NAME }}"
-        AZURE_OPENAI_BASE_URL: ${{ secrets.AZURE_OPENAI_BASE_URL }}"
+        AZURE_OPENAI_API_KEY: "${{ secrets.AZURE_OPENAI_API_KEY }}"
+        AZURE_API_VERSION: "${{ secrets.AZURE_API_VERSION }}"
+        AZURE_DEPLOYMENT_NAME: "${{ secrets.AZURE_DEPLOYMENT_NAME }}"
+        AZURE_OPENAI_BASE_URL: "${{ secrets.AZURE_OPENAI_BASE_URL }}"
         MISTRAL_API_KEY: "${{ secrets.MISTRAL_API_KEY }}"
         REKA_API_KEY: "${{ secrets.REKA_API_KEY }}"
         NEO4J_URI: "${{ secrets.NEO4J_URI }}"

camel/__init__.py

@@ -14,7 +14,7 @@
 
 from camel.logger import disable_logging, enable_logging, set_log_level
 
-__version__ = '0.2.79a0'
+__version__ = '0.2.79a1'
 
 __all__ = [
     '__version__',

camel/models/azure_openai_model.py

@@ -13,6 +13,7 @@
 # ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 import copy
 import os
+import warnings
 from typing import Any, Callable, Dict, List, Optional, Type, Union
 
 from openai import AsyncAzureOpenAI, AsyncStream, AzureOpenAI, Stream
@@ -60,7 +61,8 @@ class AzureOpenAIModel(BaseModelBackend):
 
     Args:
         model_type (Union[ModelType, str]): Model for which a backend is
-            created, one of GPT_* series.
+            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.
@@ -71,8 +73,6 @@ class AzureOpenAIModel(BaseModelBackend):
             (default: :obj:`None`)
         api_version (Optional[str], optional): The api version for the model.
             (default: :obj:`None`)
-        azure_deployment_name (Optional[str], optional): The deployment name
-            you chose when you deployed an azure 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`)
@@ -99,6 +99,10 @@ class AzureOpenAIModel(BaseModelBackend):
             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`)
         **kwargs (Any): Additional arguments to pass to the client
             initialization. Ignored if custom clients are provided.
 
@@ -115,14 +119,35 @@ def __init__(
         timeout: Optional[float] = None,
         token_counter: Optional[BaseTokenCounter] = None,
         api_version: Optional[str] = None,
-        azure_deployment_name: 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,
         **kwargs: Any,
     ) -> None:
+        # Handle deprecated azure_deployment_name parameter
+        if azure_deployment_name is not None:
+            warnings.warn(
+                "The 'azure_deployment_name' parameter is deprecated. "
+                "Please use 'model_type' parameter instead. "
+                "The 'azure_deployment_name' parameter is being ignored.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+
+        # Handle deprecated AZURE_DEPLOYMENT_NAME environment variable
+        if os.environ.get("AZURE_DEPLOYMENT_NAME") is not None:
+            warnings.warn(
+                "The 'AZURE_DEPLOYMENT_NAME' environment variable is "
+                "deprecated. Please use the 'model_type' parameter "
+                "instead. The 'AZURE_DEPLOYMENT_NAME' environment "
+                "variable is being ignored.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+
         if model_config_dict is None:
             model_config_dict = ChatGPTConfig().as_dict()
         api_key = api_key or os.environ.get("AZURE_OPENAI_API_KEY")
@@ -133,9 +158,6 @@ def __init__(
         )
 
         self.api_version = api_version or os.environ.get("AZURE_API_VERSION")
-        self._azure_deployment_name = azure_deployment_name or os.environ.get(
-            "AZURE_DEPLOYMENT_NAME"
-        )
         self._azure_ad_token = azure_ad_token or os.environ.get(
             "AZURE_AD_TOKEN"
         )
@@ -145,11 +167,6 @@ def __init__(
                 "Must provide either the `api_version` argument "
                 "or `AZURE_API_VERSION` environment variable."
             )
-        if self._azure_deployment_name is None:
-            raise ValueError(
-                "Must provide either the `azure_deployment_name` argument "
-                "or `AZURE_DEPLOYMENT_NAME` environment variable."
-            )
 
         # Use custom clients if provided, otherwise create new ones
         if client is not None:
@@ -162,7 +179,7 @@ def __init__(
 
                 self._client = LangfuseOpenAI(
                     azure_endpoint=str(self._url),
-                    azure_deployment=self._azure_deployment_name,
+                    azure_deployment=str(self.model_type),
                     api_version=self.api_version,
                     api_key=self._api_key,
                     azure_ad_token=self._azure_ad_token,
@@ -174,7 +191,7 @@ def __init__(
             else:
                 self._client = AzureOpenAI(
                     azure_endpoint=str(self._url),
-                    azure_deployment=self._azure_deployment_name,
+                    azure_deployment=str(self.model_type),
                     api_version=self.api_version,
                     api_key=self._api_key,
                     azure_ad_token=self._azure_ad_token,
@@ -196,7 +213,7 @@ def __init__(
 
                 self._async_client = LangfuseAsyncOpenAI(
                     azure_endpoint=str(self._url),
-                    azure_deployment=self._azure_deployment_name,
+                    azure_deployment=str(self.model_type),
                     api_version=self.api_version,
                     api_key=self._api_key,
                     azure_ad_token=self._azure_ad_token,
@@ -208,7 +225,7 @@ def __init__(
             else:
                 self._async_client = AsyncAzureOpenAI(
                     azure_endpoint=str(self._url),
-                    azure_deployment=self._azure_deployment_name,
+                    azure_deployment=str(self.model_type),
                     api_version=self.api_version,
                     api_key=self._api_key,
                     azure_ad_token=self._azure_ad_token,
@@ -359,7 +376,7 @@ def _request_chat_completion(
 
         return self._client.chat.completions.create(
             messages=messages,
-            model=self._azure_deployment_name,  # type:ignore[arg-type]
+            model=str(self.model_type),
             **request_config,
         )
 
@@ -375,7 +392,7 @@ async def _arequest_chat_completion(
 
         return await self._async_client.chat.completions.create(
             messages=messages,
-            model=self._azure_deployment_name,  # type:ignore[arg-type]
+            model=str(self.model_type),
             **request_config,
         )
 
@@ -396,7 +413,7 @@ def _request_parse(
 
         return self._client.beta.chat.completions.parse(
             messages=messages,
-            model=self._azure_deployment_name,  # type:ignore[arg-type]
+            model=str(self.model_type),
             **request_config,
         )
 
@@ -417,7 +434,7 @@ async def _arequest_parse(
 
         return await self._async_client.beta.chat.completions.parse(
             messages=messages,
-            model=self._azure_deployment_name,  # type:ignore[arg-type]
+            model=str(self.model_type),
             **request_config,
         )
 
@@ -443,7 +460,7 @@ def _request_stream_parse(
         # Use the beta streaming API for structured outputs
         return self._client.beta.chat.completions.stream(
             messages=messages,
-            model=self.model_type,
+            model=str(self.model_type),
             response_format=response_format,
             **request_config,
         )
@@ -470,7 +487,7 @@ async def _arequest_stream_parse(
         # Use the beta streaming API for structured outputs
         return self._async_client.beta.chat.completions.stream(
             messages=messages,
-            model=self.model_type,
+            model=str(self.model_type),
             response_format=response_format,
             **request_config,
         )

docs/conf.py

@@ -27,7 +27,7 @@
 project = 'CAMEL'
 copyright = '2024, CAMEL-AI.org'
 author = 'CAMEL-AI.org'
-release = '0.2.79a0'
+release = '0.2.79a1'
 
 html_favicon = (
     'https://raw.githubusercontent.com/camel-ai/camel/master/misc/favicon.png'

examples/models/azure_openai_model_example.py

@@ -11,23 +11,25 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+import os
+
 from camel.agents import ChatAgent
-from camel.configs import ChatGPTConfig
 from camel.models import ModelFactory
-from camel.types import ModelPlatformType, ModelType
+from camel.types import ModelPlatformType
 
 """
 please set the below os environment:
 export AZURE_OPENAI_BASE_URL=""
 export AZURE_API_VERSION=""
 export AZURE_OPENAI_API_KEY=""
-export AZURE_DEPLOYMENT_NAME=""
 """
 
 model = ModelFactory.create(
     model_platform=ModelPlatformType.AZURE,
-    model_type=ModelType.GPT_4O_MINI,
-    model_config_dict=ChatGPTConfig(temperature=0.2).as_dict(),
+    model_type="gpt-4.1",
+    api_key=os.getenv("AZURE_OPENAI_API_KEY"),
+    url=os.getenv("AZURE_OPENAI_BASE_URL"),
+    api_version="2024-12-01-preview",
 )
 
 # Define system message

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "camel-ai"
-version = "0.2.79a0"
+version = "0.2.79a1"
 description = "Communicative Agents for AI Society Study"
 authors = [{ name = "CAMEL-AI.org" }]
 requires-python = ">=3.10,<3.15"

test/models/test_azure_openai_model.py

@@ -15,11 +15,9 @@
 please set the below os environment:
 export AZURE_OPENAI_BASE_URL=""
 
-# if `AZURE_API_VERSION` is not set, `OPENAI_API_VERSION` will be used as api
-# version
+# if `AZURE_API_VERSION` is not set, the api_version parameter must be provided
 export AZURE_API_VERSION=""
 export AZURE_OPENAI_API_KEY=""
-export AZURE_DEPLOYMENT_NAME=""
 """
 
 import pytest
@@ -43,7 +41,13 @@
 )
 def test_openai_model(model_type):
     model_config_dict = ChatGPTConfig().as_dict()
-    model = AzureOpenAIModel(model_type, model_config_dict)
+    model = AzureOpenAIModel(
+        model_type,
+        model_config_dict,
+        api_version="2024-02-15-preview",
+        api_key="test-key",
+        url="https://test.openai.azure.com/",
+    )
     assert model.model_type == model_type
     assert model.model_config_dict == model_config_dict
     assert isinstance(model.token_counter, OpenAITokenCounter)
@@ -67,5 +71,8 @@ def test_openai_model_create(model_type: ModelType):
         model_platform=ModelPlatformType.AZURE,
         model_type=model_type,
         model_config_dict=ChatGPTConfig(temperature=0.8, n=3).as_dict(),
+        api_version="2024-02-15-preview",
+        api_key="test-key",
+        url="https://test.openai.azure.com/",
     )
     assert model.model_type == model_type