camel-ai 0.2.19__py3-none-any.whl → 0.2.20a1__py3-none-any.whl

camel/__init__.py

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

camel/agents/chat_agent.py

@@ -86,18 +86,18 @@ except (ImportError, AttributeError):
     from camel.utils import track_agent
 
 
-class FunctionCallingRecord(BaseModel):
-    r"""Historical records of functions called in the conversation.
+class ToolCallingRecord(BaseModel):
+    r"""Historical records of tools called in the conversation.
 
     Attributes:
-        func_name (str): The name of the function being called.
+        tool_name (str): The name of the tool being called.
         args (Dict[str, Any]): The dictionary of arguments passed to
-            the function.
-        result (Any): The execution result of calling this function.
+            the tools.
+        result (Any): The execution result of calling this tool.
         tool_call_id (str): The ID of the tool call, if available.
     """
 
-    func_name: str
+    tool_name: str
     args: Dict[str, Any]
     result: Any
     tool_call_id: str
@@ -106,10 +106,10 @@ class FunctionCallingRecord(BaseModel):
         r"""Overridden version of the string function.
 
         Returns:
-            str: Modified string to represent the function calling.
+            str: Modified string to represent the tool calling.
         """
         return (
-            f"Function Execution: {self.func_name}\n"
+            f"Tool Execution: {self.tool_name}\n"
             f"\tArgs: {self.args}\n"
             f"\tResult: {self.result}\n"
         )
@@ -489,7 +489,7 @@ class ChatAgent(BaseAgent):
         usage: Optional[Dict[str, int]],
         termination_reasons: List[str],
         num_tokens: int,
-        tool_calls: List[FunctionCallingRecord],
+        tool_calls: List[ToolCallingRecord],
         external_tool_request: Optional[ChatCompletionMessageToolCall] = None,
     ) -> Dict[str, Any]:
         r"""Returns a dictionary containing information about the chat session.
@@ -501,7 +501,7 @@ class ChatAgent(BaseAgent):
             termination_reasons (List[str]): The reasons for the termination
                 of the chat session.
             num_tokens (int): The number of tokens used in the chat session.
-            tool_calls (List[FunctionCallingRecord]): The list of function
+            tool_calls (List[ToolCallingRecord]): The list of function
                 calling records, containing the information of called tools.
             external_tool_request
                 (Optional[ChatCompletionMessageToolCall], optional):
@@ -645,7 +645,7 @@ class ChatAgent(BaseAgent):
             )
 
         # Record function calls made during the session
-        tool_call_records: List[FunctionCallingRecord] = []
+        tool_call_records: List[ToolCallingRecord] = []
 
         external_tool_request = None
 
@@ -885,7 +885,7 @@ class ChatAgent(BaseAgent):
 
         self.update_memory(input_message, OpenAIBackendRole.USER)
 
-        tool_call_records: List[FunctionCallingRecord] = []
+        tool_call_records: List[ToolCallingRecord] = []
         while True:
             try:
                 openai_messages, num_tokens = self.memory.get_context()
@@ -970,7 +970,7 @@ class ChatAgent(BaseAgent):
 
     def _step_tool_call_and_update(
         self, response: ChatCompletion
-    ) -> FunctionCallingRecord:
+    ) -> ToolCallingRecord:
         r"""Processes a function call within the chat completion response,
         records the function call in the provided list of tool calls and
         updates the memory of the current agent.
@@ -980,7 +980,7 @@ class ChatAgent(BaseAgent):
                 completion.
 
         Returns:
-            FunctionCallingRecord: The record of calling the function.
+            ToolCallingRecord: The record of calling the function.
         """
 
         # Perform function calling
@@ -996,7 +996,7 @@ class ChatAgent(BaseAgent):
 
     async def _step_tool_call_and_update_async(
         self, response: ChatCompletion
-    ) -> FunctionCallingRecord:
+    ) -> ToolCallingRecord:
         (
             func_assistant_msg,
             func_result_msg,
@@ -1015,7 +1015,7 @@ class ChatAgent(BaseAgent):
         List[str],
         Dict[str, int],
         str,
-        FunctionCallingRecord,
+        ToolCallingRecord,
         int,
     ]:
         r"""Internal function of structuring the output of the agent based on
@@ -1027,7 +1027,7 @@ class ChatAgent(BaseAgent):
 
         Returns:
             Tuple[List[BaseMessage], List[str], Dict[str, int], str,
-                FunctionCallingRecord, int]:
+                ToolCallingRecord, int]:
                 A tuple containing the output messages, finish reasons, usage
                 dictionary, response ID, function calling record, and number of
                 tokens.
@@ -1141,7 +1141,7 @@ class ChatAgent(BaseAgent):
         finish_reasons: List[str],
         usage_dict: Dict[str, int],
         response_id: str,
-        tool_calls: List[FunctionCallingRecord],
+        tool_calls: List[ToolCallingRecord],
         num_tokens: int,
         external_tool_request: Optional[ChatCompletionMessageToolCall] = None,
     ) -> Dict[str, Any]:
@@ -1160,7 +1160,7 @@ class ChatAgent(BaseAgent):
             usage_dict (Dict[str, int]): Dictionary containing token usage
                 information.
             response_id (str): The ID of the response from the model.
-            tool_calls (List[FunctionCallingRecord]): Records of function calls
+            tool_calls (List[ToolCallingRecord]): Records of function calls
                 made during this step.
             num_tokens (int): The number of tokens used in this step.
             external_tool_request (Optional[ChatCompletionMessageToolCall]):
@@ -1335,7 +1335,7 @@ class ChatAgent(BaseAgent):
     def _step_token_exceed(
         self,
         num_tokens: int,
-        tool_calls: List[FunctionCallingRecord],
+        tool_calls: List[ToolCallingRecord],
         termination_reason: str,
     ) -> ChatAgentResponse:
         r"""Return trivial response containing number of tokens and information
@@ -1343,7 +1343,7 @@ class ChatAgent(BaseAgent):
 
         Args:
             num_tokens (int): Number of tokens in the messages.
-            tool_calls (List[FunctionCallingRecord]): List of information
+            tool_calls (List[ToolCallingRecord]): List of information
                 objects of functions called in the current step.
             termination_reason (str): String of termination reason.
 
@@ -1372,7 +1372,7 @@ class ChatAgent(BaseAgent):
         self,
         response: ChatCompletion,
     ) -> Tuple[
-        FunctionCallingMessage, FunctionCallingMessage, FunctionCallingRecord
+        FunctionCallingMessage, FunctionCallingMessage, ToolCallingRecord
     ]:
         r"""Execute the function with arguments following the model's response.
 
@@ -1418,8 +1418,8 @@ class ChatAgent(BaseAgent):
         )
 
         # Record information about this function call
-        func_record = FunctionCallingRecord(
-            func_name=func_name,
+        func_record = ToolCallingRecord(
+            tool_name=func_name,
             args=args,
             result=result,
             tool_call_id=tool_call_id,
@@ -1442,7 +1442,7 @@ class ChatAgent(BaseAgent):
         self,
         response: ChatCompletion,
     ) -> Tuple[
-        FunctionCallingMessage, FunctionCallingMessage, FunctionCallingRecord
+        FunctionCallingMessage, FunctionCallingMessage, ToolCallingRecord
     ]:
         r"""Execute the async function with arguments following the model's
         response.
@@ -1488,8 +1488,8 @@ class ChatAgent(BaseAgent):
         )
 
         # Record information about this function call
-        func_record = FunctionCallingRecord(
-            func_name=func_name,
+        func_record = ToolCallingRecord(
+            tool_name=func_name,
             args=args,
             result=result,
             tool_call_id=tool_call_id,

camel/configs/__init__.py

@@ -20,6 +20,7 @@ from .groq_config import GROQ_API_PARAMS, GroqConfig
 from .internlm_config import INTERNLM_API_PARAMS, InternLMConfig
 from .litellm_config import LITELLM_API_PARAMS, LiteLLMConfig
 from .mistral_config import MISTRAL_API_PARAMS, MistralConfig
+from .moonshot_config import MOONSHOT_API_PARAMS, MoonshotConfig
 from .nvidia_config import NVIDIA_API_PARAMS, NvidiaConfig
 from .ollama_config import OLLAMA_API_PARAMS, OllamaConfig
 from .openai_config import OPENAI_API_PARAMS, ChatGPTConfig
@@ -32,6 +33,7 @@ from .samba_config import (
     SambaVerseAPIConfig,
 )
 from .sglang_config import SGLANG_API_PARAMS, SGLangConfig
+from .siliconflow_config import SILICONFLOW_API_PARAMS, SiliconFlowConfig
 from .togetherai_config import TOGETHERAI_API_PARAMS, TogetherAIConfig
 from .vllm_config import VLLM_API_PARAMS, VLLMConfig
 from .yi_config import YI_API_PARAMS, YiConfig
@@ -79,4 +81,8 @@ __all__ = [
     'DEEPSEEK_API_PARAMS',
     'InternLMConfig',
     'INTERNLM_API_PARAMS',
+    'MoonshotConfig',
+    "MOONSHOT_API_PARAMS",
+    'SiliconFlowConfig',
+    'SILICONFLOW_API_PARAMS',
 ]

camel/configs/moonshot_config.py

@@ -0,0 +1,63 @@
+# ========= 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 List, Optional, Union
+
+from camel.configs.base_config import BaseConfig
+
+
+class MoonshotConfig(BaseConfig):
+    r"""Defines the parameters for generating chat completions using the
+    Moonshot API. You can refer to the following link for more details:
+    https://platform.moonshot.cn/docs/api-reference
+
+    Args:
+        temperature (float, optional): Controls randomness in the response.
+            Lower values make the output more focused and deterministic.
+            (default: :obj:`0.3`)
+        max_tokens (int, optional): The maximum number of tokens to generate.
+            (default: :obj:`None`)
+        stream (bool, optional): Whether to stream the response.
+            (default: :obj:`False`)
+        tools (list, optional): List of tools that the model can use for
+            function calling. Each tool should be a dictionary containing
+            type, function name, description, and parameters.
+            (default: :obj:`None`)
+        top_p (float, optional): Controls diversity via nucleus sampling.
+            (default: :obj:`1.0`)
+        n (int, optional): How many chat completion choices to generate for
+            each input message. (default: :obj:`1`)
+        presence_penalty (float, optional): Penalty for new tokens based on
+            whether they appear in the text so far.
+            (default: :obj:`0.0`)
+        frequency_penalty (float, optional): Penalty for new tokens based on
+            their frequency in the text so far.
+            (default: :obj:`0.0`)
+        stop (Optional[Union[str, List[str]]], optional): Up to 4 sequences
+            where the API will stop generating further tokens.
+            (default: :obj:`None`)
+    """
+
+    temperature: float = 0.3
+    max_tokens: Optional[int] = None
+    stream: bool = False
+    tools: Optional[list] = None
+    top_p: float = 1.0
+    n: int = 1
+    presence_penalty: float = 0.0
+    frequency_penalty: float = 0.0
+    stop: Optional[Union[str, List[str]]] = None
+
+
+MOONSHOT_API_PARAMS = {param for param in MoonshotConfig.model_fields.keys()}

camel/configs/siliconflow_config.py

@@ -0,0 +1,91 @@
+# ========= 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 __future__ import annotations
+
+from typing import Any, Sequence, Type, Union
+
+from pydantic import BaseModel
+
+from camel.configs.base_config import BaseConfig
+from camel.types import NOT_GIVEN, NotGiven
+
+
+class SiliconFlowConfig(BaseConfig):
+    r"""Defines the parameters for generating chat completions using the
+    SiliconFlow API.
+
+    Args:
+        temperature (float, optional): Determines the degree of randomness
+            in the response. (default: :obj:`0.7`)
+        top_p (float, optional): The top_p (nucleus) parameter is used to
+            dynamically adjust the number of choices for each predicted token
+            based on the cumulative probabilities. (default: :obj:`0.7`)
+        n (int, optional): Number of generations to return. (default::obj:`1`)
+        response_format (object, optional): An object specifying the format
+            that the model must output.
+        stream (bool, optional): If set, tokens are returned as Server-Sent
+            Events as they are made available. (default: :obj:`False`)
+        stop (str or list, optional): Up to :obj:`4` sequences where the API
+            will stop generating further tokens. (default: :obj:`None`)
+        max_tokens (int, optional): The maximum number of tokens to generate.
+            (default: :obj:`None`)
+        frequency_penalty (float, optional): Number between :obj:`-2.0` and
+            :obj:`2.0`. Positive values penalize new tokens based on their
+            existing frequency in the text so far, decreasing the model's
+            likelihood to repeat the same line verbatim. See more information
+            about frequency and presence penalties. (default: :obj:`0.0`)
+        tools (list[FunctionTool], optional): A list of tools the model may
+            call. Currently, only functions are supported as a tool. Use this
+            to provide a list of functions the model may generate JSON inputs
+            for. A max of 128 functions are supported.
+    """
+
+    temperature: float = 0.7
+    top_p: float = 0.7
+    n: int = 1
+    stream: bool = False
+    stop: Union[str, Sequence[str], NotGiven] = NOT_GIVEN
+    max_tokens: Union[int, NotGiven] = NOT_GIVEN
+    response_format: Union[Type[BaseModel], dict, NotGiven] = NOT_GIVEN
+    frequency_penalty: float = 0.0
+
+    def as_dict(self) -> dict[str, Any]:
+        r"""Convert the current configuration to a dictionary.
+
+        This method converts the current configuration object to a dictionary
+        representation, which can be used for serialization or other purposes.
+
+        Returns:
+            dict[str, Any]: A dictionary representation of the current
+                configuration.
+        """
+        config_dict = self.model_dump()
+        if self.tools:
+            from camel.toolkits import FunctionTool
+
+            tools_schema = []
+            for tool in self.tools:
+                if not isinstance(tool, FunctionTool):
+                    raise ValueError(
+                        f"The tool {tool} should "
+                        "be an instance of `FunctionTool`."
+                    )
+                tools_schema.append(tool.get_openai_tool_schema())
+        config_dict["tools"] = NOT_GIVEN
+        return config_dict
+
+
+SILICONFLOW_API_PARAMS = {
+    param for param in SiliconFlowConfig.model_fields.keys()
+}

camel/datahubs/huggingface.py

@@ -32,19 +32,19 @@ class HuggingFaceDatasetManager(BaseDatasetManager):
 
     Args:
         token (str): The Hugging Face API token. If not provided, the token
-            will be read from the environment variable `HUGGING_FACE_TOKEN`.
+            will be read from the environment variable `HF_TOKEN`.
     """
 
     @api_keys_required(
         [
-            ("token", "HUGGING_FACE_TOKEN"),
+            ("token", "HF_TOKEN"),
         ]
     )
     @dependencies_required('huggingface_hub')
     def __init__(self, token: Optional[str] = None):
         from huggingface_hub import HfApi
 
-        self._api_key = token or os.getenv("HUGGING_FACE_TOKEN")
+        self._api_key = token or os.getenv("HF_TOKEN")
         self.api = HfApi(token=self._api_key)
 
     def create_dataset_card(

camel/embeddings/jina_embedding.py

@@ -35,6 +35,11 @@ class JinaEmbedding(BaseEmbedding[Union[str, Image.Image]]):
             Jina AI. (default: :obj:`None`)
         dimensions (Optional[int], optional): The dimension of the output
             embeddings. (default: :obj:`None`)
+        embedding_type (Optional[str], optional): The type of embedding format
+            to generate. Options: 'int8' (binary encoding with higher storage
+            and transfer efficiency), 'uint8' (unsigned binary encoding with
+            higher storage and transfer efficiency), 'base64' (base64 string
+            encoding with higher transfer efficiency). (default: :obj:`None`)
         task (Optional[str], optional): The type of task for text embeddings.
             Options: retrieval.query, retrieval.passage, text-matching,
             classification, separation. (default: :obj:`None`)
@@ -120,7 +125,7 @@ class JinaEmbedding(BaseEmbedding[Union[str, Image.Image]]):
             else:
                 raise ValueError(
                     f"Input type {type(obj)} is not supported. "
-                    "Must be either str or PIL.Image"
+                    "Must be either str or PIL.Image."
                 )
 
         data = {

camel/models/__init__.py

@@ -24,6 +24,7 @@ from .litellm_model import LiteLLMModel
 from .mistral_model import MistralModel
 from .model_factory import ModelFactory
 from .model_manager import ModelManager, ModelProcessingError
+from .moonshot_model import MoonshotModel
 from .nemotron_model import NemotronModel
 from .nvidia_model import NvidiaModel
 from .ollama_model import OllamaModel
@@ -70,4 +71,5 @@ __all__ = [
     'DeepSeekModel',
     'FishAudioModel',
     'InternLMModel',
+    'MoonshotModel',
 ]

camel/models/model_factory.py

@@ -23,6 +23,7 @@ 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.moonshot_model import MoonshotModel
 from camel.models.nvidia_model import NvidiaModel
 from camel.models.ollama_model import OllamaModel
 from camel.models.openai_compatible_model import OpenAICompatibleModel
@@ -31,6 +32,7 @@ from camel.models.qwen_model import QwenModel
 from camel.models.reka_model import RekaModel
 from camel.models.samba_model import SambaModel
 from camel.models.sglang_model import SGLangModel
+from camel.models.siliconflow_model import SiliconFlowModel
 from camel.models.stub_model import StubModel
 from camel.models.togetherai_model import TogetherAIModel
 from camel.models.vllm_model import VLLMModel
@@ -100,6 +102,8 @@ class ModelFactory:
             model_class = LiteLLMModel
         elif model_platform.is_nvidia:
             model_class = NvidiaModel
+        elif model_platform.is_siliconflow:
+            model_class = SiliconFlowModel
 
         elif model_platform.is_openai and model_type.is_openai:
             model_class = OpenAIModel
@@ -127,6 +131,8 @@ class ModelFactory:
             model_class = DeepSeekModel
         elif model_platform.is_internlm and model_type.is_internlm:
             model_class = InternLMModel
+        elif model_platform.is_moonshot and model_type.is_moonshot:
+            model_class = MoonshotModel
         elif model_type == ModelType.STUB:
             model_class = StubModel
 

camel/models/moonshot_model.py

@@ -0,0 +1,138 @@
+# ========= 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 MOONSHOT_API_PARAMS, MoonshotConfig
+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 MoonshotModel(BaseModelBackend):
+    r"""Moonshot API in a unified BaseModelBackend interface.
+
+    Args:
+        model_type (Union[ModelType, str]): Model for which a backend is
+            created, one of Moonshot series.
+        model_config_dict (Optional[Dict[str, Any]], optional): A dictionary
+            that will be fed into :obj:`openai.ChatCompletion.create()`. If
+            :obj:`None`, :obj:`MoonshotConfig().as_dict()` will be used.
+            (default: :obj:`None`)
+        api_key (Optional[str], optional): The API key for authenticating with
+            the Moonshot service. (default: :obj:`None`)
+        url (Optional[str], optional): The url to the Moonshot service.
+            (default: :obj:`https://api.moonshot.cn/v1`)
+        token_counter (Optional[BaseTokenCounter], optional): Token counter to
+            use for the model. If not provided, :obj:`OpenAITokenCounter(
+            ModelType.GPT_4)` will be used.
+            (default: :obj:`None`)
+    """
+
+    @api_keys_required([("api_key", "MOONSHOT_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 = MoonshotConfig().as_dict()
+        api_key = api_key or os.environ.get("MOONSHOT_API_KEY")
+        url = url or os.environ.get(
+            "MOONSHOT_API_BASE_URL",
+            "https://api.moonshot.cn/v1",
+        )
+        super().__init__(
+            model_type, model_config_dict, api_key, url, token_counter
+        )
+        self._client = OpenAI(
+            api_key=self._api_key,
+            timeout=180,
+            max_retries=3,
+            base_url=self._url,
+        )
+
+    def run(
+        self,
+        messages: List[OpenAIMessage],
+    ) -> 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.
+        """
+        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 Moonshot API.
+
+        Raises:
+            ValueError: If the model configuration dictionary contains any
+                unexpected arguments to Moonshot API.
+        """
+        for param in self.model_config_dict:
+            if param not in MOONSHOT_API_PARAMS:
+                raise ValueError(
+                    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)