refactor: ModelType (#998)

Co-authored-by: Wendong <w3ndong.fan@gmail.com>
Co-authored-by: Wendong-Fan <133094783+Wendong-Fan@users.noreply.github.com>
Co-authored-by: Guohao Li <lightaime@gmail.com>

Author: 3 people

.github/workflows/build_package.yml

@@ -59,7 +59,7 @@ jobs:
           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_ENDPOINT: "${{ secrets.AZURE_OPENAI_ENDPOINT }}"
+          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 }}"

.github/workflows/pytest_package.yml

@@ -38,7 +38,7 @@ jobs:
         AZURE_OPENAI_API_KEY: "to-be-filled"
         AZURE_API_VERSION: "to-be-filled"
         AZURE_DEPLOYMENT_NAME: "to-be-filled"
-        AZURE_OPENAI_ENDPOINT: "https://camel.openai.azure.com/"
+        AZURE_OPENAI_BASE_URL: "https://camel.openai.azure.com/"
         MISTRAL_API_KEY: "${{ secrets.MISTRAL_API_KEY }}"
         REKA_API_KEY: "${{ secrets.REKA_API_KEY }}"
         NEO4J_URI: "${{ secrets.NEO4J_URI }}"
@@ -74,7 +74,7 @@ jobs:
         AZURE_OPENAI_API_KEY: "to-be-filled"
         AZURE_API_VERSION: "to-be-filled"
         AZURE_DEPLOYMENT_NAME: "to-be-filled"
-        AZURE_OPENAI_ENDPOINT: "https://camel.openai.azure.com/"
+        AZURE_OPENAI_BASE_URL: "https://camel.openai.azure.com/"
         MISTRAL_API_KEY: "${{ secrets.MISTRAL_API_KEY }}"
         REKA_API_KEY: "${{ secrets.REKA_API_KEY }}"
         NEO4J_URI: "${{ secrets.NEO4J_URI }}"
@@ -110,7 +110,7 @@ jobs:
         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_ENDPOINT: ${{ secrets.AZURE_OPENAI_ENDPOINT }}"
+        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/agents/chat_agent.py

@@ -34,7 +34,6 @@
 from pydantic import BaseModel
 
 from camel.agents.base import BaseAgent
-from camel.configs import ChatGPTConfig
 from camel.memories import (
     AgentMemory,
     ChatHistoryMemory,
@@ -169,14 +168,13 @@ def __init__(
             else ModelFactory.create(
                 model_platform=ModelPlatformType.OPENAI,
                 model_type=ModelType.GPT_4O_MINI,
-                model_config_dict=ChatGPTConfig().as_dict(),
             )
         )
         self.output_language: Optional[str] = output_language
         if self.output_language is not None:
             self.set_output_language(self.output_language)
 
-        self.model_type: ModelType = self.model_backend.model_type
+        self.model_type = self.model_backend.model_type
 
         # tool registration
         external_tools = external_tools or []
@@ -439,12 +437,7 @@ def step(
                 a boolean indicating whether the chat session has terminated,
                 and information about the chat session.
         """
-        if (
-            isinstance(self.model_type, ModelType)
-            and "lama" in self.model_type.value
-            or isinstance(self.model_type, str)
-            and "lama" in self.model_type
-        ):
+        if "llama" in self.model_type.lower():
             if self.model_backend.model_config_dict.get("tools", None):
                 tool_prompt = self._generate_tool_prompt(self.tool_schema_list)
 
@@ -525,10 +518,7 @@ def step(
                     self._step_tool_call_and_update(response)
                 )
 
-            if (
-                output_schema is not None
-                and self.model_type.supports_tool_calling
-            ):
+            if output_schema is not None:
                 (
                     output_messages,
                     finish_reasons,
@@ -619,7 +609,7 @@ def step(
 
             if (
                 output_schema is not None
-                and self.model_type.supports_tool_calling
+                and self.model_type.support_native_tool_calling
             ):
                 (
                     output_messages,
@@ -727,7 +717,10 @@ async def step_async(
                 await self._step_tool_call_and_update_async(response)
             )
 
-        if output_schema is not None and self.model_type.supports_tool_calling:
+        if (
+            output_schema is not None
+            and self.model_type.support_native_tool_calling
+        ):
             (
                 output_messages,
                 finish_reasons,
@@ -1193,10 +1186,7 @@ def get_usage_dict(
         Returns:
             dict: Usage dictionary.
         """
-        if isinstance(self.model_type, ModelType):
-            encoding = get_model_encoding(self.model_type.value_for_tiktoken)
-        else:
-            encoding = get_model_encoding("gpt-4o-mini")
+        encoding = get_model_encoding(self.model_type.value_for_tiktoken)
         completion_tokens = 0
         for message in output_messages:
             completion_tokens += len(encoding.encode(message.content))

camel/configs/__init__.py

@@ -18,7 +18,7 @@
 from .litellm_config import LITELLM_API_PARAMS, LiteLLMConfig
 from .mistral_config import MISTRAL_API_PARAMS, MistralConfig
 from .ollama_config import OLLAMA_API_PARAMS, OllamaConfig
-from .openai_config import OPENAI_API_PARAMS, ChatGPTConfig, OpenSourceConfig
+from .openai_config import OPENAI_API_PARAMS, ChatGPTConfig
 from .reka_config import REKA_API_PARAMS, RekaConfig
 from .samba_config import (
     SAMBA_CLOUD_API_PARAMS,
@@ -40,7 +40,6 @@
     'ANTHROPIC_API_PARAMS',
     'GROQ_API_PARAMS',
     'GroqConfig',
-    'OpenSourceConfig',
     'LiteLLMConfig',
     'LITELLM_API_PARAMS',
     'OllamaConfig',

camel/configs/openai_config.py

@@ -112,24 +112,3 @@ class ChatGPTConfig(BaseConfig):
 
 
 OPENAI_API_PARAMS = {param for param in ChatGPTConfig.model_fields.keys()}
-
-
-class OpenSourceConfig(BaseConfig):
-    r"""Defines parameters for setting up open-source models and includes
-    parameters to be passed to chat completion function of OpenAI API.
-
-    Args:
-        model_path (str): The path to a local folder containing the model
-            files or the model card in HuggingFace hub.
-        server_url (str): The URL to the server running the model inference
-            which will be used as the API base of OpenAI API.
-        api_params (ChatGPTConfig): An instance of :obj:ChatGPTConfig to
-            contain the arguments to be passed to OpenAI API.
-    """
-
-    # Maybe the param needs to be renamed.
-    # Warning: Field "model_path" has conflict with protected namespace
-    # "model_".
-    model_path: str
-    server_url: str
-    api_params: ChatGPTConfig = Field(default_factory=ChatGPTConfig)

camel/models/__init__.py

@@ -21,9 +21,8 @@
 from .model_factory import ModelFactory
 from .nemotron_model import NemotronModel
 from .ollama_model import OllamaModel
-from .open_source_model import OpenSourceModel
 from .openai_audio_models import OpenAIAudioModels
-from .openai_compatibility_model import OpenAICompatibilityModel
+from .openai_compatible_model import OpenAICompatibleModel
 from .openai_model import OpenAIModel
 from .reka_model import RekaModel
 from .samba_model import SambaModel
@@ -41,15 +40,14 @@
     'GroqModel',
     'StubModel',
     'ZhipuAIModel',
-    'OpenSourceModel',
     'ModelFactory',
     'LiteLLMModel',
     'OpenAIAudioModels',
     'NemotronModel',
     'OllamaModel',
     'VLLMModel',
     'GeminiModel',
-    'OpenAICompatibilityModel',
+    'OpenAICompatibleModel',
     'RekaModel',
     'SambaModel',
     'TogetherAIModel',

camel/models/anthropic_model.py

@@ -12,11 +12,11 @@
 # limitations under the License.
 # =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
 import os
-from typing import Any, Dict, List, Optional
+from typing import Any, Dict, List, Optional, Union
 
 from anthropic import NOT_GIVEN, Anthropic
 
-from camel.configs import ANTHROPIC_API_PARAMS
+from camel.configs import ANTHROPIC_API_PARAMS, AnthropicConfig
 from camel.messages import OpenAIMessage
 from camel.models.base_model import BaseModelBackend
 from camel.types import ChatCompletion, ModelType
@@ -28,36 +28,39 @@
 
 
 class AnthropicModel(BaseModelBackend):
-    r"""Anthropic API in a unified BaseModelBackend interface."""
+    r"""Anthropic API in a unified BaseModelBackend interface.
+
+    Args:
+        model_type (Union[ModelType, str]): Model for which a backend is
+            created, one of CLAUDE_* series.
+        model_config_dict (Optional[Dict[str, Any]], optional): A dictionary
+            that will be fed into Anthropic.messages.create().  If
+            :obj:`None`, :obj:`AnthropicConfig().as_dict()` will be used.
+            (default::obj:`None`)
+        api_key (Optional[str], optional): The API key for authenticating with
+            the Anthropic service. (default: :obj:`None`)
+        url (Optional[str], optional): The url to the Anthropic service.
+            (default: :obj:`None`)
+        token_counter (Optional[BaseTokenCounter], optional): Token counter to
+            use for the model. If not provided, :obj:`AnthropicTokenCounter`
+            will be used. (default: :obj:`None`)
+    """
 
     def __init__(
         self,
-        model_type: ModelType,
-        model_config_dict: Dict[str, Any],
+        model_type: Union[ModelType, str],
+        model_config_dict: Optional[Dict[str, Any]] = None,
         api_key: Optional[str] = None,
         url: Optional[str] = None,
         token_counter: Optional[BaseTokenCounter] = None,
     ) -> None:
-        r"""Constructor for Anthropic backend.
-
-        Args:
-            model_type (ModelType): Model for which a backend is created,
-                one of CLAUDE_* series.
-            model_config_dict (Dict[str, Any]): A dictionary that will
-                be fed into Anthropic.messages.create().
-            api_key (Optional[str]): The API key for authenticating with the
-                Anthropic service. (default: :obj:`None`)
-            url (Optional[str]): The url to the Anthropic service. (default:
-                :obj:`None`)
-            token_counter (Optional[BaseTokenCounter]): Token counter to use
-                for the model. If not provided, `AnthropicTokenCounter` will
-                be used.
-        """
+        if model_config_dict is None:
+            model_config_dict = AnthropicConfig().as_dict()
+        api_key = api_key or os.environ.get("ANTHROPIC_API_KEY")
+        url = url or os.environ.get("ANTHROPIC_API_BASE_URL")
         super().__init__(
             model_type, model_config_dict, api_key, url, token_counter
         )
-        self._api_key = api_key or os.environ.get("ANTHROPIC_API_KEY")
-        self._url = url or os.environ.get("ANTHROPIC_API_BASE_URL")
         self.client = Anthropic(api_key=self._api_key, base_url=self._url)
 
     def _convert_response_from_anthropic_to_openai(self, response):
@@ -89,7 +92,7 @@ def token_counter(self) -> BaseTokenCounter:
                 tokenization style.
         """
         if not self._token_counter:
-            self._token_counter = AnthropicTokenCounter(self.model_type)
+            self._token_counter = AnthropicTokenCounter()
         return self._token_counter
 
     def count_tokens_from_prompt(self, prompt: str) -> int:
@@ -123,7 +126,7 @@ def run(
         else:
             sys_msg = NOT_GIVEN  # type: ignore[assignment]
         response = self.client.messages.create(
-            model=self.model_type.value,
+            model=self.model_type,
             system=sys_msg,
             messages=messages,  # type: ignore[arg-type]
             **self.model_config_dict,