camel-ai 0.2.16__py3-none-any.whl → 0.2.18__py3-none-any.whl

camel/messages/func_message.py

@@ -11,6 +11,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+import json
 from dataclasses import dataclass
 from typing import Any, Dict, Optional
 
@@ -18,8 +19,8 @@ from camel.messages import (
     BaseMessage,
     HermesFunctionFormatter,
     OpenAIAssistantMessage,
-    OpenAIFunctionMessage,
     OpenAIMessage,
+    OpenAIToolMessageParam,
 )
 from camel.messages.conversion import (
     ShareGPTMessage,
@@ -44,11 +45,14 @@ class FunctionCallingMessage(BaseMessage):
             function. (default: :obj:`None`)
         result (Optional[Any]): The result of function execution.
             (default: :obj:`None`)
+        tool_call_id (Optional[str]): The ID of the tool call, if available.
+            (default: :obj:`None`)
     """
 
     func_name: Optional[str] = None
     args: Optional[Dict] = None
     result: Optional[Any] = None
+    tool_call_id: Optional[str] = None
 
     def to_openai_message(
         self,
@@ -66,7 +70,7 @@ class FunctionCallingMessage(BaseMessage):
         if role_at_backend == OpenAIBackendRole.ASSISTANT:
             return self.to_openai_assistant_message()
         elif role_at_backend == OpenAIBackendRole.FUNCTION:
-            return self.to_openai_function_message()
+            return self.to_openai_tool_message()
         else:
             raise ValueError(f"Unsupported role: {role_at_backend}.")
 
@@ -120,24 +124,29 @@ class FunctionCallingMessage(BaseMessage):
                 " due to missing function name or arguments."
             )
 
-        msg_dict: OpenAIAssistantMessage = {
+        return {
             "role": "assistant",
-            "content": self.content,
-            "function_call": {
-                "name": self.func_name,
-                "arguments": str(self.args),
-            },
+            "content": self.content or "",
+            "tool_calls": [
+                {
+                    "id": self.tool_call_id or "null",
+                    "type": "function",
+                    "function": {
+                        "name": self.func_name,
+                        "arguments": json.dumps(self.args),
+                    },
+                }
+            ],
         }
 
-        return msg_dict
-
-    def to_openai_function_message(self) -> OpenAIFunctionMessage:
-        r"""Converts the message to an :obj:`OpenAIMessage` object
-        with the role being "function".
+    def to_openai_tool_message(self) -> OpenAIToolMessageParam:
+        r"""Converts the message to an :obj:`OpenAIToolMessageParam` object
+        with the role being "tool".
 
         Returns:
-            OpenAIMessage: The converted :obj:`OpenAIMessage` object
-                with its role being "function".
+            OpenAIToolMessageParam: The converted
+                :obj:`OpenAIToolMessageParam` object with its role being
+                "tool".
         """
         if not self.func_name:
             raise ValueError(
@@ -145,11 +154,10 @@ class FunctionCallingMessage(BaseMessage):
                 " due to missing function name."
             )
 
-        result_content = {"result": {str(self.result)}}
-        msg_dict: OpenAIFunctionMessage = {
-            "role": "function",
-            "name": self.func_name,
-            "content": f'{result_content}',
-        }
+        result_content = json.dumps(self.result)
 
-        return msg_dict
+        return {
+            "role": "tool",
+            "content": result_content,
+            "tool_call_id": self.tool_call_id or "null",
+        }

camel/models/__init__.py

@@ -19,6 +19,7 @@ from .deepseek_model import DeepSeekModel
 from .fish_audio_model import FishAudioModel
 from .gemini_model import GeminiModel
 from .groq_model import GroqModel
+from .internlm_model import InternLMModel
 from .litellm_model import LiteLLMModel
 from .mistral_model import MistralModel
 from .model_factory import ModelFactory
@@ -68,4 +69,5 @@ __all__ = [
     'ModelProcessingError',
     'DeepSeekModel',
     'FishAudioModel',
+    'InternLMModel',
 ]

camel/models/anthropic_model.py

@@ -12,7 +12,7 @@
 # limitations under the License.
 # ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 import os
-from typing import Any, Dict, List, Literal, Optional, Union
+from typing import Any, Dict, List, Optional, Union
 
 from camel.configs import ANTHROPIC_API_PARAMS, AnthropicConfig
 from camel.messages import OpenAIMessage
@@ -102,27 +102,6 @@ class AnthropicModel(BaseModelBackend):
             self._token_counter = AnthropicTokenCounter(self.model_type)
         return self._token_counter
 
-    @dependencies_required('anthropic')
-    def count_tokens_from_prompt(
-        self, prompt: str, role: Literal["user", "assistant"]
-    ) -> int:
-        r"""Count the number of tokens from a prompt.
-
-        Args:
-            prompt (str): The prompt string.
-            role (Literal["user", "assistant"]): The role of the message
-                sender, either "user" or "assistant".
-
-        Returns:
-            int: The number of tokens in the prompt.
-        """
-        from anthropic.types.beta import BetaMessageParam
-
-        return self.client.beta.messages.count_tokens(
-            messages=[BetaMessageParam(content=prompt, role=role)],
-            model=self.model_type,
-        ).input_tokens
-
     def run(
         self,
         messages: List[OpenAIMessage],

camel/models/cohere_model.py

@@ -228,6 +228,14 @@ class CohereModel(BaseModelBackend):
 
         cohere_messages = self._to_cohere_chatmessage(messages)
 
+        # Removing 'strict': True from the dictionary for
+        # cohere client
+        if self.model_config_dict.get('tools') is not None:
+            for tool in self.model_config_dict.get('tools', []):
+                function_dict = tool.get('function', {})
+                if 'strict' in function_dict:
+                    del function_dict['strict']
+
         try:
             response = self._client.chat(
                 messages=cohere_messages,

camel/models/deepseek_model.py

@@ -13,6 +13,7 @@
 # ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 
 import os
+import warnings
 from typing import Any, Dict, List, Optional, Union
 
 from openai import OpenAI, Stream
@@ -110,11 +111,77 @@ class DeepSeekModel(BaseModelBackend):
                 `ChatCompletion` in the non-stream mode, or
                 `Stream[ChatCompletionChunk]` in the stream mode.
         """
+        # deepseek reasoner has limitations
+        # reference: https://api-docs.deepseek.com/guides/reasoning_model#api-parameters
+        if self.model_type in [
+            ModelType.DEEPSEEK_REASONER,
+        ]:
+            warnings.warn(
+                "Warning: You are using an DeepSeek Reasoner model, "
+                "which has certain limitations, reference: "
+                "`https://api-docs.deepseek.com/guides/reasoning_model#api-parameters`.",
+                UserWarning,
+            )
+
+            # Check and remove unsupported parameters and reset the fixed
+            # parameters
+            unsupported_keys = [
+                "temperature",
+                "top_p",
+                "presence_penalty",
+                "frequency_penalty",
+                "logprobs",
+                "top_logprobs",
+                "tools",
+            ]
+            for key in unsupported_keys:
+                if key in self.model_config_dict:
+                    del self.model_config_dict[key]
+
         response = self._client.chat.completions.create(
             messages=messages,
             model=self.model_type,
             **self.model_config_dict,
         )
+
+        # Temporary solution to handle the case where
+        # deepseek returns a reasoning_content
+        if (
+            self.model_type
+            in [
+                ModelType.DEEPSEEK_REASONER,
+            ]
+            and os.environ.get("GET_REASONING_CONTENT", "false").lower()
+            == "true"
+        ):
+            reasoning_content = response.choices[0].message.reasoning_content
+            combined_content = (
+                response.choices[0].message.content
+                + "\n\nBELOW IS THE REASONING CONTENT:\n\n"
+                + (reasoning_content if reasoning_content else "")
+            )
+
+            response = ChatCompletion.construct(
+                id=response.id,
+                choices=[
+                    dict(
+                        index=response.choices[0].index,
+                        message={
+                            "role": response.choices[0].message.role,
+                            "content": combined_content,
+                            "tool_calls": None,
+                        },
+                        finish_reason=response.choices[0].finish_reason
+                        if response.choices[0].finish_reason
+                        else None,
+                    )
+                ],
+                created=response.created,
+                model=response.model,
+                object="chat.completion",
+                usage=response.usage,
+            )
+
         return response
 
     def check_model_config(self):

camel/models/gemini_model.py

@@ -97,8 +97,17 @@ class GeminiModel(BaseModelBackend):
                 `ChatCompletion` in the non-stream mode, or
                 `Stream[ChatCompletionChunk]` in the stream mode.
         """
+        # Process messages to ensure no empty content, it's not accepeted by
+        # Gemini
+        processed_messages = []
+        for msg in messages:
+            msg_copy = msg.copy()
+            if 'content' in msg_copy and msg_copy['content'] == '':
+                msg_copy['content'] = 'null'
+            processed_messages.append(msg_copy)
+
         response = self._client.chat.completions.create(
-            messages=messages,
+            messages=processed_messages,
             model=self.model_type,
             **self.model_config_dict,
         )

camel/models/internlm_model.py

@@ -0,0 +1,143 @@
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# 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 typing import Any, Dict, List, Optional, Union
+
+from openai import OpenAI, Stream
+
+from camel.configs import INTERNLM_API_PARAMS, InternLMConfig
+from camel.messages import OpenAIMessage
+from camel.models import BaseModelBackend
+from camel.types import (
+    ChatCompletion,
+    ChatCompletionChunk,
+    ModelType,
+)
+from camel.utils import (
+    BaseTokenCounter,
+    OpenAITokenCounter,
+    api_keys_required,
+)
+
+
+class InternLMModel(BaseModelBackend):
+    r"""InternLM API in a unified BaseModelBackend interface.
+
+    Args:
+        model_type (Union[ModelType, str]): Model for which a backend is
+            created, one of InternLM series.
+        model_config_dict (Optional[Dict[str, Any]], optional): A dictionary
+            that will be fed into:obj:`openai.ChatCompletion.create()`. If
+            :obj:`None`, :obj:`InternLMConfig().as_dict()` will be used.
+            (default: :obj:`None`)
+        api_key (Optional[str], optional): The API key for authenticating with
+            the InternLM service. (default: :obj:`None`)
+        url (Optional[str], optional): The url to the InternLM service.
+            (default: :obj:`https://internlm-chat.intern-ai.org.cn/puyu/api/v1`)
+        token_counter (Optional[BaseTokenCounter], optional): Token counter to
+            use for the model. If not provided, :obj:`OpenAITokenCounter(
+            ModelType.GPT_4O_MINI)` will be used.
+            (default: :obj:`None`)
+    """
+
+    @api_keys_required(
+        [
+            ("api_key", "INTERNLM_API_KEY"),
+        ]
+    )
+    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,
+        token_counter: Optional[BaseTokenCounter] = None,
+    ) -> None:
+        if model_config_dict is None:
+            model_config_dict = InternLMConfig().as_dict()
+        api_key = api_key or os.environ.get("INTERNLM_API_KEY")
+        url = url or os.environ.get(
+            "INTERNLM_API_BASE_URL",
+            "https://internlm-chat.intern-ai.org.cn/puyu/api/v1",
+        )
+        super().__init__(
+            model_type, model_config_dict, api_key, url, token_counter
+        )
+        self._client = OpenAI(
+            timeout=180,
+            max_retries=3,
+            api_key=self._api_key,
+            base_url=self._url,
+        )
+
+    def run(
+        self,
+        messages: List[OpenAIMessage],
+    ) -> Union[ChatCompletion, Stream[ChatCompletionChunk]]:
+        r"""Runs inference of InternLM 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.
+        """
+        response = self._client.chat.completions.create(
+            messages=messages,
+            model=self.model_type,
+            **self.model_config_dict,
+        )
+        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
+        unexpected arguments to InternLM API.
+
+        Raises:
+            ValueError: If the model configuration dictionary contains any
+                unexpected arguments to InternLM API.
+        """
+        for param in self.model_config_dict:
+            if param not in INTERNLM_API_PARAMS:
+                raise ValueError(
+                    f"Unexpected argument `{param}` is "
+                    "input into InternLM 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/mistral_model.py

@@ -147,18 +147,25 @@ class MistralModel(BaseModelBackend):
         new_messages = []
         for msg in messages:
             tool_id = uuid.uuid4().hex[:9]
-            tool_call_id = uuid.uuid4().hex[:9]
+            tool_call_id = msg.get("tool_call_id") or uuid.uuid4().hex[:9]
 
             role = msg.get("role")
-            function_call = msg.get("function_call")
+            tool_calls = msg.get("tool_calls")
             content = msg.get("content")
 
             mistral_function_call = None
-            if function_call:
-                mistral_function_call = FunctionCall(
-                    name=function_call.get("name"),  # type: ignore[attr-defined]
-                    arguments=function_call.get("arguments"),  # type: ignore[attr-defined]
+            if tool_calls:
+                # Ensure tool_calls is treated as a list
+                tool_calls_list = (
+                    tool_calls
+                    if isinstance(tool_calls, list)
+                    else [tool_calls]
                 )
+                for tool_call in tool_calls_list:
+                    mistral_function_call = FunctionCall(
+                        name=tool_call["function"].get("name"),  # type: ignore[attr-defined]
+                        arguments=tool_call["function"].get("arguments"),  # type: ignore[attr-defined]
+                    )
 
             tool_calls = None
             if mistral_function_call:
@@ -178,7 +185,7 @@ class MistralModel(BaseModelBackend):
                 new_messages.append(
                     ToolMessage(
                         content=content,  # type: ignore[arg-type]
-                        tool_call_id=tool_call_id,
+                        tool_call_id=tool_call_id,  # type: ignore[arg-type]
                         name=msg.get("name"),  # type: ignore[arg-type]
                     )
                 )

camel/models/model_factory.py

@@ -20,6 +20,7 @@ from camel.models.cohere_model import CohereModel
 from camel.models.deepseek_model import DeepSeekModel
 from camel.models.gemini_model import GeminiModel
 from camel.models.groq_model import GroqModel
+from camel.models.internlm_model import InternLMModel
 from camel.models.litellm_model import LiteLLMModel
 from camel.models.mistral_model import MistralModel
 from camel.models.nvidia_model import NvidiaModel
@@ -124,6 +125,8 @@ class ModelFactory:
             model_class = QwenModel
         elif model_platform.is_deepseek:
             model_class = DeepSeekModel
+        elif model_platform.is_internlm and model_type.is_internlm:
+            model_class = InternLMModel
         elif model_type == ModelType.STUB:
             model_class = StubModel
 

camel/models/reward/__init__.py

@@ -14,9 +14,11 @@
 from .base_reward_model import BaseRewardModel
 from .evaluator import Evaluator
 from .nemotron_model import NemotronRewardModel
+from .skywork_model import SkyworkRewardModel
 
 __all__ = [
     'BaseRewardModel',
     'NemotronRewardModel',
     'Evaluator',
+    'SkyworkRewardModel',
 ]

camel/models/reward/skywork_model.py

@@ -0,0 +1,88 @@
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+from typing import Dict, List, Optional, Union
+
+import torch
+
+from camel.models.reward import BaseRewardModel
+from camel.types import ModelType
+
+
+class SkyworkRewardModel(BaseRewardModel):
+    r"""Reward model based on the transformers, it will download the model
+    from huggingface.
+
+    Args:
+        model_type (Union[ModelType, str]): Model for which a backend is
+            created.
+        api_key (Optional[str], optional): Not used. (default: :obj:`None`)
+        url (Optional[str], optional): Not used. (default: :obj:`None`)
+        device_map (Optional[str], optional): choose the device map.
+            (default: :obj:`auto`)
+        attn_implementation (Optional[str], optional): choose the attention
+            implementation. (default: :obj:`flash_attention_2`)
+        offload_folder (Optional[str], optional): choose the offload folder.
+            (default: :obj:`offload`)
+    """
+
+    def __init__(
+        self,
+        model_type: Union[ModelType, str],
+        api_key: Optional[str] = None,
+        url: Optional[str] = None,
+        device_map: Optional[str] = "auto",
+        attn_implementation: Optional[str] = "flash_attention_2",
+        offload_folder: Optional[str] = "offload",
+    ) -> None:
+        from transformers import (
+            AutoModelForSequenceClassification,
+            AutoTokenizer,
+        )
+
+        super().__init__(model_type, api_key, url)
+        self._client = AutoModelForSequenceClassification.from_pretrained(
+            model_type,
+            torch_dtype=torch.bfloat16,
+            device_map=device_map,
+            attn_implementation=attn_implementation,
+            offload_folder=offload_folder,
+            num_labels=1,
+        )
+        self._tokenizer = AutoTokenizer.from_pretrained(model_type)
+
+    def evaluate(self, messages: List[Dict[str, str]]) -> Dict[str, float]:
+        r"""Evaluate the messages using the Skywork model.
+
+        Args:
+            messages (List[Dict[str, str]]): A list of messages.
+
+        Returns:
+            ChatCompletion: A ChatCompletion object with the scores.
+        """
+        inputs = self._tokenizer.apply_chat_template(
+            messages,
+            tokenize=True,
+            return_tensors="pt",
+        )
+        with torch.no_grad():
+            score = self._client(inputs).logits[0][0].item()
+            return {"Score": score}
+
+    def get_scores_types(self) -> List[str]:
+        r"""get the scores types
+
+        Returns:
+            List[str]: list of scores types
+        """
+        return ["Score"]