camel-ai 0.2.45__py3-none-any.whl → 0.2.46__py3-none-any.whl

camel/models/modelscope_model.py

@@ -13,29 +13,19 @@
 # ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 
 import os
-from typing import Any, Dict, List, Optional, Type, Union
-
-from openai import AsyncOpenAI, AsyncStream, OpenAI, Stream
-from pydantic import BaseModel
+from typing import Any, Dict, Optional, Union
 
 from camel.configs import MODELSCOPE_API_PARAMS, ModelScopeConfig
-from camel.messages import OpenAIMessage
-from camel.models import BaseModelBackend
-from camel.models._utils import try_modify_message_with_format
-from camel.types import (
-    ChatCompletion,
-    ChatCompletionChunk,
-    ModelType,
-)
+from camel.models.openai_compatible_model import OpenAICompatibleModel
+from camel.types import ModelType
 from camel.utils import (
     BaseTokenCounter,
-    OpenAITokenCounter,
     api_keys_required,
 )
 
 
-class ModelScopeModel(BaseModelBackend):
-    r"""ModelScope API in a unified BaseModelBackend interface.
+class ModelScopeModel(OpenAICompatibleModel):
+    r"""ModelScope API in a unified OpenAICompatibleModel interface.
 
     Args:
         model_type (Union[ModelType, str]): Model for which a backend is
@@ -83,104 +73,13 @@ class ModelScopeModel(BaseModelBackend):
         )
         timeout = timeout or float(os.environ.get("MODEL_TIMEOUT", 180))
         super().__init__(
-            model_type, model_config_dict, api_key, url, token_counter, timeout
-        )
-        self._client = OpenAI(
-            timeout=self._timeout,
-            max_retries=3,
-            api_key=self._api_key,
-            base_url=self._url,
-        )
-        self._async_client = AsyncOpenAI(
-            timeout=self._timeout,
-            max_retries=3,
-            api_key=self._api_key,
-            base_url=self._url,
-        )
-
-    async def _arun(
-        self,
-        messages: List[OpenAIMessage],
-        response_format: Optional[Type[BaseModel]] = None,
-        tools: Optional[List[Dict[str, Any]]] = None,
-    ) -> Union[ChatCompletion, AsyncStream[ChatCompletionChunk]]:
-        r"""Runs inference of ModelScope chat completion.
-
-        Args:
-            messages (List[OpenAIMessage]): Message list with the chat history
-                in OpenAI API format.
-
-        Returns:
-            Union[ChatCompletion, AsyncStream[ChatCompletionChunk]]:
-                `ChatCompletion` in the non-stream mode, or
-                `AsyncStream[ChatCompletionChunk]` in the stream mode.
-        """
-        request_config = self._prepare_request(
-            messages, response_format, tools
-        )
-
-        response = await self._async_client.chat.completions.create(
-            messages=messages,
-            model=self.model_type,
-            **request_config,
-        )
-        return response
-
-    def _run(
-        self,
-        messages: List[OpenAIMessage],
-        response_format: Optional[Type[BaseModel]] = None,
-        tools: Optional[List[Dict[str, Any]]] = None,
-    ) -> Union[ChatCompletion, Stream[ChatCompletionChunk]]:
-        r"""Runs inference of ModelScope chat completion.
-
-        Args:
-            messages (List[OpenAIMessage]): Message list with the chat history
-                in OpenAI API format.
-
-        Returns:
-            Union[ChatCompletion, Stream[ChatCompletionChunk]]:
-                `ChatCompletion` in the non-stream mode, or
-                `Stream[ChatCompletionChunk]` in the stream mode.
-        """
-        request_config = self._prepare_request(
-            messages, response_format, tools
-        )
-
-        response = self._client.chat.completions.create(
-            messages=messages,
-            model=self.model_type,
-            **request_config,
+            model_type=model_type,
+            model_config_dict=model_config_dict,
+            api_key=api_key,
+            url=url,
+            token_counter=token_counter,
+            timeout=timeout,
         )
-        return response
-
-    def _prepare_request(
-        self,
-        messages: List[OpenAIMessage],
-        response_format: Optional[Type[BaseModel]] = None,
-        tools: Optional[List[Dict[str, Any]]] = None,
-    ) -> Dict[str, Any]:
-        request_config = self.model_config_dict.copy()
-        if tools:
-            request_config["tools"] = tools
-        elif response_format:
-            try_modify_message_with_format(messages[-1], response_format)
-            request_config["response_format"] = {"type": "json_object"}
-
-        return request_config
-
-    @property
-    def token_counter(self) -> BaseTokenCounter:
-        r"""Initialize the token counter for the model backend.
-
-        Returns:
-            OpenAITokenCounter: The token counter following the model's
-                tokenization style.
-        """
-
-        if not self._token_counter:
-            self._token_counter = OpenAITokenCounter(ModelType.GPT_4O_MINI)
-        return self._token_counter
 
     def check_model_config(self):
         r"""Check whether the model configuration contains any
@@ -196,13 +95,3 @@ class ModelScopeModel(BaseModelBackend):
                     f"Unexpected argument `{param}` is "
                     "input into ModelScope model backend."
                 )
-
-    @property
-    def stream(self) -> bool:
-        r"""Returns whether the model is in stream mode, which sends partial
-        results each time.
-
-        Returns:
-            bool: Whether the model is in stream mode.
-        """
-        return self.model_config_dict.get('stream', False)

camel/models/moonshot_model.py

@@ -15,13 +15,12 @@
 import os
 from typing import Any, Dict, List, Optional, Type, Union
 
-from openai import AsyncStream, OpenAI, Stream
+from openai import AsyncStream
 from pydantic import BaseModel
 
 from camel.configs import MOONSHOT_API_PARAMS, MoonshotConfig
 from camel.messages import OpenAIMessage
-from camel.models import BaseModelBackend
-from camel.models._utils import try_modify_message_with_format
+from camel.models.openai_compatible_model import OpenAICompatibleModel
 from camel.types import (
     ChatCompletion,
     ChatCompletionChunk,
@@ -29,13 +28,12 @@ from camel.types import (
 )
 from camel.utils import (
     BaseTokenCounter,
-    OpenAITokenCounter,
     api_keys_required,
 )
 
 
-class MoonshotModel(BaseModelBackend):
-    r"""Moonshot API in a unified BaseModelBackend interface.
+class MoonshotModel(OpenAICompatibleModel):
+    r"""Moonshot API in a unified OpenAICompatibleModel interface.
 
     Args:
         model_type (Union[ModelType, str]): Model for which a backend is
@@ -77,55 +75,13 @@ class MoonshotModel(BaseModelBackend):
         )
         timeout = timeout or float(os.environ.get("MODEL_TIMEOUT", 180))
         super().__init__(
-            model_type, model_config_dict, api_key, url, token_counter, timeout
+            model_type=model_type,
+            model_config_dict=model_config_dict,
+            api_key=api_key,
+            url=url,
+            token_counter=token_counter,
+            timeout=timeout,
         )
-        self._client = OpenAI(
-            api_key=self._api_key,
-            timeout=self._timeout,
-            max_retries=3,
-            base_url=self._url,
-        )
-
-    def _prepare_request(
-        self,
-        messages: List[OpenAIMessage],
-        response_format: Optional[Type[BaseModel]] = None,
-        tools: Optional[List[Dict[str, Any]]] = None,
-    ) -> Dict[str, Any]:
-        request_config = self.model_config_dict.copy()
-        if tools:
-            request_config["tools"] = tools
-        elif response_format:
-            try_modify_message_with_format(messages[-1], response_format)
-        return request_config
-
-    def _run(
-        self,
-        messages: List[OpenAIMessage],
-        response_format: Optional[Type[BaseModel]] = None,
-        tools: Optional[List[Dict[str, Any]]] = None,
-    ) -> Union[ChatCompletion, Stream[ChatCompletionChunk]]:
-        r"""Runs inference of Moonshot chat completion.
-
-        Args:
-            messages (List[OpenAIMessage]): Message list with the chat history
-                in OpenAI API format.
-
-        Returns:
-            Union[ChatCompletion, Stream[ChatCompletionChunk]]:
-                `ChatCompletion` in the non-stream mode, or
-                `Stream[ChatCompletionChunk]` in the stream mode.
-        """
-        request_config = self._prepare_request(
-            messages, response_format, tools
-        )
-
-        response = self._client.chat.completions.create(
-            messages=messages,
-            model=self.model_type,
-            **request_config,
-        )
-        return response
 
     async def _arun(
         self,
@@ -135,18 +91,6 @@ class MoonshotModel(BaseModelBackend):
     ) -> Union[ChatCompletion, AsyncStream[ChatCompletionChunk]]:
         raise NotImplementedError("Moonshot does not support async inference.")
 
-    @property
-    def token_counter(self) -> BaseTokenCounter:
-        r"""Initialize the token counter for the model backend.
-
-        Returns:
-            OpenAITokenCounter: The token counter following the model's
-                tokenization style.
-        """
-        if not self._token_counter:
-            self._token_counter = OpenAITokenCounter(ModelType.GPT_4O_MINI)
-        return self._token_counter
-
     def check_model_config(self):
         r"""Check whether the model configuration contains any
         unexpected arguments to Moonshot API.
@@ -161,13 +105,3 @@ class MoonshotModel(BaseModelBackend):
                     f"Unexpected argument `{param}` is "
                     "input into Moonshot model backend."
                 )
-
-    @property
-    def stream(self) -> bool:
-        r"""Returns whether the model is in stream mode, which sends partial
-        results each time.
-
-        Returns:
-            bool: Whether the model is in stream mode.
-        """
-        return self.model_config_dict.get('stream', False)

camel/models/nemotron_model.py

@@ -12,21 +12,17 @@
 # limitations under the License.
 # ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 import os
-from typing import Any, Dict, List, Optional, Type, Union
+from typing import Optional, Union
 
-from openai import AsyncOpenAI, OpenAI
-from pydantic import BaseModel
-
-from camel.messages import OpenAIMessage
-from camel.models import BaseModelBackend
-from camel.types import ChatCompletion, ModelType
+from camel.models.openai_compatible_model import OpenAICompatibleModel
+from camel.types import ModelType
 from camel.utils import (
     BaseTokenCounter,
     api_keys_required,
 )
 
 
-class NemotronModel(BaseModelBackend):
+class NemotronModel(OpenAICompatibleModel):
     r"""Nemotron model API backend with OpenAI compatibility.
 
     Args:
@@ -63,58 +59,6 @@ class NemotronModel(BaseModelBackend):
         api_key = api_key or os.environ.get("NVIDIA_API_KEY")
         timeout = timeout or float(os.environ.get("MODEL_TIMEOUT", 180))
         super().__init__(model_type, {}, api_key, url, None, timeout)
-        self._client = OpenAI(
-            timeout=self._timeout,
-            max_retries=3,
-            base_url=self._url,
-            api_key=self._api_key,
-        )
-        self._async_client = AsyncOpenAI(
-            timeout=self._timeout,
-            max_retries=3,
-            base_url=self._url,
-            api_key=self._api_key,
-        )
-
-    async def _arun(
-        self,
-        messages: List[OpenAIMessage],
-        response_format: Optional[Type[BaseModel]] = None,
-        tools: Optional[List[Dict[str, Any]]] = None,
-    ) -> ChatCompletion:
-        r"""Runs inference of OpenAI chat completion asynchronously.
-
-        Args:
-            messages (List[OpenAIMessage]): Message list.
-
-        Returns:
-            ChatCompletion.
-        """
-        response = await self._async_client.chat.completions.create(
-            messages=messages,
-            model=self.model_type,
-        )
-        return response
-
-    def _run(
-        self,
-        messages: List[OpenAIMessage],
-        response_format: Optional[Type[BaseModel]] = None,
-        tools: Optional[List[Dict[str, Any]]] = None,
-    ) -> ChatCompletion:
-        r"""Runs inference of OpenAI chat completion.
-
-        Args:
-            messages (List[OpenAIMessage]): Message list.
-
-        Returns:
-            ChatCompletion.
-        """
-        response = self._client.chat.completions.create(
-            messages=messages,
-            model=self.model_type,
-        )
-        return response
 
     @property
     def token_counter(self) -> BaseTokenCounter:

camel/models/nvidia_model.py

@@ -13,24 +13,16 @@
 # ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 
 import os
-from typing import Any, Dict, List, Optional, Type, Union
-
-from openai import AsyncOpenAI, AsyncStream, OpenAI, Stream
-from openai.types.chat import (
-    ChatCompletion,
-    ChatCompletionChunk,
-)
-from pydantic import BaseModel
+from typing import Any, Dict, Optional, Union
 
 from camel.configs import NVIDIA_API_PARAMS, NvidiaConfig
-from camel.messages import OpenAIMessage
-from camel.models import BaseModelBackend
+from camel.models.openai_compatible_model import OpenAICompatibleModel
 from camel.types import ModelType
-from camel.utils import BaseTokenCounter, OpenAITokenCounter, api_keys_required
+from camel.utils import BaseTokenCounter, api_keys_required
 
 
-class NvidiaModel(BaseModelBackend):
-    r"""NVIDIA API in a unified BaseModelBackend interface.
+class NvidiaModel(OpenAICompatibleModel):
+    r"""NVIDIA API in a unified OpenAICompatibleModel interface.
 
     Args:
         model_type (Union[ModelType, str]): Model for which a backend is
@@ -75,95 +67,13 @@ class NvidiaModel(BaseModelBackend):
         )
         timeout = timeout or float(os.environ.get("MODEL_TIMEOUT", 180))
         super().__init__(
-            model_type, model_config_dict, api_key, url, token_counter, timeout
-        )
-        self._client = OpenAI(
-            timeout=self._timeout,
-            max_retries=3,
-            api_key=self._api_key,
-            base_url=self._url,
-        )
-        self._async_client = AsyncOpenAI(
-            timeout=self._timeout,
-            max_retries=3,
-            api_key=self._api_key,
-            base_url=self._url,
-        )
-
-    async def _arun(
-        self,
-        messages: List[OpenAIMessage],
-        response_format: Optional[Type[BaseModel]] = None,
-        tools: Optional[List[Dict[str, Any]]] = None,
-    ) -> Union[ChatCompletion, AsyncStream[ChatCompletionChunk]]:
-        r"""Runs inference of NVIDIA chat completion.
-
-        Args:
-            messages (List[OpenAIMessage]): Message list with the chat history
-                in OpenAI API format.
-
-        Returns:
-            Union[ChatCompletion, AsyncStream[ChatCompletionChunk]]:
-                `ChatCompletion` in the non-stream mode, or
-                `AsyncStream[ChatCompletionChunk]` in the stream mode.
-        """
-
-        # Remove tool-related parameters if no tools are specified
-        config = dict(self.model_config_dict)
-        if not config.get("tools"):  # None or empty list
-            config.pop("tools", None)
-            config.pop("tool_choice", None)
-
-        response = await self._async_client.chat.completions.create(
-            messages=messages,
-            model=self.model_type,
-            **config,
-        )
-        return response
-
-    def _run(
-        self,
-        messages: List[OpenAIMessage],
-        response_format: Optional[Type[BaseModel]] = None,
-        tools: Optional[List[Dict[str, Any]]] = None,
-    ) -> Union[ChatCompletion, Stream[ChatCompletionChunk]]:
-        r"""Runs inference of NVIDIA chat completion.
-
-        Args:
-            messages (List[OpenAIMessage]): Message list with the chat history
-                in OpenAI API format.
-
-        Returns:
-            Union[ChatCompletion, Stream[ChatCompletionChunk]]:
-                `ChatCompletion` in the non-stream mode, or
-                `Stream[ChatCompletionChunk]` in the stream mode.
-        """
-
-        # Remove tool-related parameters if no tools are specified
-        config = dict(self.model_config_dict)
-        if not config.get('tools'):  # None or empty list
-            config.pop('tools', None)
-            config.pop('tool_choice', None)
-
-        response = self._client.chat.completions.create(
-            messages=messages,
-            model=self.model_type,
-            **config,
+            model_type=model_type,
+            model_config_dict=model_config_dict,
+            api_key=api_key,
+            url=url,
+            token_counter=token_counter,
+            timeout=timeout,
         )
-        return response
-
-    @property
-    def token_counter(self) -> BaseTokenCounter:
-        r"""Initialize the token counter for the model backend.
-
-        Returns:
-            OpenAITokenCounter: The token counter following the model's
-                tokenization style.
-        """
-
-        if not self._token_counter:
-            self._token_counter = OpenAITokenCounter(ModelType.GPT_4O_MINI)
-        return self._token_counter
 
     def check_model_config(self):
         r"""Check whether the model configuration contains any
@@ -179,13 +89,3 @@ class NvidiaModel(BaseModelBackend):
                     f"Unexpected argument `{param}` is "
                     "input into NVIDIA model backend."
                 )
-
-    @property
-    def stream(self) -> bool:
-        r"""Returns whether the model is in stream mode, which sends partial
-        results each time.
-
-        Returns:
-            bool: Whether the model is in stream mode.
-        """
-        return self.model_config_dict.get('stream', False)