camel-ai 0.2.15a0__py3-none-any.whl → 0.2.17__py3-none-any.whl

camel/models/gemini_model.py

@@ -52,6 +52,11 @@ class GeminiModel(BaseModelBackend):
             (default: :obj:`None`)
     """
 
+    @api_keys_required(
+        [
+            ("api_key", 'GEMINI_API_KEY'),
+        ]
+    )
     def __init__(
         self,
         model_type: Union[ModelType, str],
@@ -77,7 +82,6 @@ class GeminiModel(BaseModelBackend):
             base_url=self._url,
         )
 
-    @api_keys_required("GEMINI_API_KEY")
     def run(
         self,
         messages: List[OpenAIMessage],
@@ -93,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/groq_model.py

@@ -51,6 +51,11 @@ class GroqModel(BaseModelBackend):
             (default: :obj:`None`)
     """
 
+    @api_keys_required(
+        [
+            ("api_key", "GROQ_API_KEY"),
+        ]
+    )
     def __init__(
         self,
         model_type: Union[ModelType, str],
@@ -89,7 +94,6 @@ class GroqModel(BaseModelBackend):
             self._token_counter = OpenAITokenCounter(ModelType.GPT_4O_MINI)
         return self._token_counter
 
-    @api_keys_required("GROQ_API_KEY")
     def run(
         self,
         messages: List[OpenAIMessage],

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

@@ -59,6 +59,11 @@ class MistralModel(BaseModelBackend):
             be used. (default: :obj:`None`)
     """
 
+    @api_keys_required(
+        [
+            ("api_key", "MISTRAL_API_KEY"),
+        ]
+    )
     @dependencies_required('mistralai')
     def __init__(
         self,
@@ -142,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:
@@ -173,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]
                     )
                 )
@@ -200,7 +212,6 @@ class MistralModel(BaseModelBackend):
             )
         return self._token_counter
 
-    @api_keys_required("MISTRAL_API_KEY")
     def run(
         self,
         messages: List[OpenAIMessage],

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/nemotron_model.py

@@ -40,6 +40,11 @@ class NemotronModel(BaseModelBackend):
         Nemotron model doesn't support additional model config like OpenAI.
     """
 
+    @api_keys_required(
+        [
+            ("api_key", "NVIDIA_API_KEY"),
+        ]
+    )
     def __init__(
         self,
         model_type: Union[ModelType, str],
@@ -58,7 +63,6 @@ class NemotronModel(BaseModelBackend):
             api_key=self._api_key,
         )
 
-    @api_keys_required("NVIDIA_API_KEY")
     def run(
         self,
         messages: List[OpenAIMessage],

camel/models/nvidia_model.py

@@ -48,6 +48,11 @@ class NvidiaModel(BaseModelBackend):
             (default: :obj:`None`)
     """
 
+    @api_keys_required(
+        [
+            ("api_key", "NVIDIA_API_KEY"),
+        ]
+    )
     def __init__(
         self,
         model_type: Union[ModelType, str],
@@ -72,7 +77,6 @@ class NvidiaModel(BaseModelBackend):
             base_url=self._url,
         )
 
-    @api_keys_required("NVIDIA_API_KEY")
     def run(
         self,
         messages: List[OpenAIMessage],

camel/models/openai_model.py

@@ -52,6 +52,11 @@ class OpenAIModel(BaseModelBackend):
             be used. (default: :obj:`None`)
     """
 
+    @api_keys_required(
+        [
+            ("api_key", "OPENAI_API_KEY"),
+        ]
+    )
     def __init__(
         self,
         model_type: Union[ModelType, str],
@@ -86,7 +91,6 @@ class OpenAIModel(BaseModelBackend):
             self._token_counter = OpenAITokenCounter(self.model_type)
         return self._token_counter
 
-    @api_keys_required("OPENAI_API_KEY")
     def run(
         self,
         messages: List[OpenAIMessage],

camel/models/qwen_model.py

@@ -52,6 +52,11 @@ class QwenModel(BaseModelBackend):
             (default: :obj:`None`)
     """
 
+    @api_keys_required(
+        [
+            ("api_key", "QWEN_API_KEY"),
+        ]
+    )
     def __init__(
         self,
         model_type: Union[ModelType, str],
@@ -77,7 +82,6 @@ class QwenModel(BaseModelBackend):
             base_url=self._url,
         )
 
-    @api_keys_required("QWEN_API_KEY")
     def run(
         self,
         messages: List[OpenAIMessage],

camel/models/reka_model.py

@@ -56,6 +56,11 @@ class RekaModel(BaseModelBackend):
             be used. (default: :obj:`None`)
     """
 
+    @api_keys_required(
+        [
+            ("api_key", "REKA_API_KEY"),
+        ]
+    )
     @dependencies_required('reka')
     def __init__(
         self,
@@ -168,7 +173,6 @@ class RekaModel(BaseModelBackend):
             )
         return self._token_counter
 
-    @api_keys_required("REKA_API_KEY")
     def run(
         self,
         messages: List[OpenAIMessage],

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/nemotron_model.py

@@ -53,7 +53,11 @@ class NemotronRewardModel(BaseRewardModel):
             api_key=self.api_key,
         )
 
-    @api_keys_required("NVIDIA_API_KEY")
+    @api_keys_required(
+        [
+            (None, "NVIDIA_API_KEY"),
+        ]
+    )
     def evaluate(self, messages: List[Dict[str, str]]) -> Dict[str, float]:
         r"""Evaluate the messages using the Nemotron model.
 

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"]

camel/models/samba_model.py

@@ -74,6 +74,11 @@ class SambaModel(BaseModelBackend):
             ModelType.GPT_4O_MINI)` will be used.
     """
 
+    @api_keys_required(
+        [
+            ("api_key", 'SAMBA_API_KEY'),
+        ]
+    )
     def __init__(
         self,
         model_type: Union[ModelType, str],
@@ -143,7 +148,6 @@ class SambaModel(BaseModelBackend):
                 " SambaNova service"
             )
 
-    @api_keys_required("SAMBA_API_KEY")
     def run(  # type: ignore[misc]
         self, messages: List[OpenAIMessage]
     ) -> Union[ChatCompletion, Stream[ChatCompletionChunk]]:

camel/models/togetherai_model.py

@@ -53,6 +53,11 @@ class TogetherAIModel(BaseModelBackend):
             ModelType.GPT_4O_MINI)` will be used.
     """
 
+    @api_keys_required(
+        [
+            ("api_key", 'TOGETHER_API_KEY'),
+        ]
+    )
     def __init__(
         self,
         model_type: Union[ModelType, str],
@@ -78,7 +83,6 @@ class TogetherAIModel(BaseModelBackend):
             base_url=self._url,
         )
 
-    @api_keys_required("TOGETHER_API_KEY")
     def run(
         self,
         messages: List[OpenAIMessage],

camel/models/yi_model.py

@@ -52,6 +52,11 @@ class YiModel(BaseModelBackend):
             (default: :obj:`None`)
     """
 
+    @api_keys_required(
+        [
+            ("api_key", 'YI_API_KEY'),
+        ]
+    )
     def __init__(
         self,
         model_type: Union[ModelType, str],
@@ -76,7 +81,6 @@ class YiModel(BaseModelBackend):
             base_url=self._url,
         )
 
-    @api_keys_required("YI_API_KEY")
     def run(
         self,
         messages: List[OpenAIMessage],

camel/models/zhipuai_model.py

@@ -52,6 +52,11 @@ class ZhipuAIModel(BaseModelBackend):
             (default: :obj:`None`)
     """
 
+    @api_keys_required(
+        [
+            ("api_key", 'ZHIPUAI_API_KEY'),
+        ]
+    )
     def __init__(
         self,
         model_type: Union[ModelType, str],
@@ -76,7 +81,6 @@ class ZhipuAIModel(BaseModelBackend):
             base_url=self._url,
         )
 
-    @api_keys_required("ZHIPUAI_API_KEY")
     def run(
         self,
         messages: List[OpenAIMessage],

camel/schemas/openai_converter.py

@@ -53,6 +53,11 @@ class OpenAISchemaConverter(BaseConverter):
 
     """
 
+    @api_keys_required(
+        [
+            ("api_key", "OPENAI_API_KEY"),
+        ]
+    )
     def __init__(
         self,
         model_type: ModelType = ModelType.GPT_4O_MINI,
@@ -69,7 +74,6 @@ class OpenAISchemaConverter(BaseConverter):
         )._client
         super().__init__()
 
-    @api_keys_required("OPENAI_API_KEY")
     def convert(  # type: ignore[override]
         self,
         content: str,