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

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

@@ -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. =========
+from .aiml_model import AIMLModel
 from .anthropic_model import AnthropicModel
 from .azure_openai_model import AzureOpenAIModel
 from .base_model import BaseModelBackend
@@ -24,6 +25,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 +72,6 @@ __all__ = [
     'DeepSeekModel',
     'FishAudioModel',
     'InternLMModel',
+    'MoonshotModel',
+    'AIMLModel',
 ]

camel/models/aiml_model.py

@@ -0,0 +1,147 @@
+# ========= 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 AIML_API_PARAMS, AIMLConfig
+from camel.messages import OpenAIMessage
+from camel.models.base_model import BaseModelBackend
+from camel.types import (
+    ChatCompletion,
+    ChatCompletionChunk,
+    ModelType,
+)
+from camel.utils import (
+    BaseTokenCounter,
+    OpenAITokenCounter,
+    api_keys_required,
+)
+
+
+class AIMLModel(BaseModelBackend):
+    r"""AIML API in a unified BaseModelBackend interface.
+
+    Args:
+        model_type (Union[ModelType, str]): Model for which a backend is
+            created.
+        model_config_dict (Optional[Dict[str, Any]], optional): A dictionary
+            that will be fed into OpenAI client. If :obj:`None`,
+            :obj:`AIMLConfig().as_dict()` will be used.
+            (default: :obj:`None`)
+        api_key (Optional[str], optional): The API key for authenticating with
+            the AIML service. (default: :obj:`None`)
+        url (Optional[str], optional): The URL to the AIML service. If
+            not provided, :obj:`https://api.aimlapi.com/v1` will be used.
+            (default: :obj:`None`)
+        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", 'AIML_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 = AIMLConfig().as_dict()
+        api_key = api_key or os.environ.get("AIML_API_KEY")
+        url = url or os.environ.get(
+            "AIML_API_BASE_URL",
+            "https://api.aimlapi.com/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 OpenAI 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.
+        """
+        # Process model configuration parameters
+        model_config = self.model_config_dict.copy()
+
+        # Handle special case for tools parameter
+        if model_config.get('tools') is None:
+            model_config['tools'] = []
+
+        response = self._client.chat.completions.create(
+            messages=messages, model=self.model_type, **model_config
+        )
+        return response
+
+    @property
+    def token_counter(self) -> BaseTokenCounter:
+        r"""Initialize the token counter for the model backend.
+
+        Returns:
+            BaseTokenCounter: 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 AIML API.
+
+        Raises:
+            ValueError: If the model configuration dictionary contains any
+                unexpected arguments to AIML API.
+        """
+        for param in self.model_config_dict:
+            if param not in AIML_API_PARAMS:
+                raise ValueError(
+                    f"Unexpected argument `{param}` is "
+                    "input into AIML model backend."
+                )
+
+    @property
+    def stream(self) -> bool:
+        """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/model_factory.py

@@ -13,6 +13,7 @@
 # ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 from typing import Dict, Optional, Type, Union
 
+from camel.models.aiml_model import AIMLModel
 from camel.models.anthropic_model import AnthropicModel
 from camel.models.azure_openai_model import AzureOpenAIModel
 from camel.models.base_model import BaseModelBackend
@@ -23,6 +24,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 +33,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 +103,10 @@ 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_aiml:
+            model_class = AIMLModel
 
         elif model_platform.is_openai and model_type.is_openai:
             model_class = OpenAIModel
@@ -127,6 +134,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)

camel/models/siliconflow_model.py

@@ -0,0 +1,142 @@
+# ========= 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 SILICONFLOW_API_PARAMS, SiliconFlowConfig
+from camel.messages import OpenAIMessage
+from camel.models.base_model import BaseModelBackend
+from camel.types import (
+    ChatCompletion,
+    ChatCompletionChunk,
+    ModelType,
+)
+from camel.utils import (
+    BaseTokenCounter,
+    OpenAITokenCounter,
+    api_keys_required,
+)
+
+
+class SiliconFlowModel(BaseModelBackend):
+    r"""SiliconFlow API in a unified BaseModelBackend interface.
+
+    Args:
+        model_type (Union[ModelType, str]): Model for which a backend is
+            created.
+        model_config_dict (Optional[Dict[str, Any]], optional): A dictionary
+            that will be fed into OpenAI client. If :obj:`None`,
+            :obj:`SiliconFlowConfig().as_dict()` will be used.
+            (default: :obj:`None`)
+        api_key (Optional[str], optional): The API key for authenticating with
+            the SiliconFlow service. (default: :obj:`None`)
+        url (Optional[str], optional): The URL to the SiliconFlow service. If
+            not provided, :obj:`https://api.siliconflow.cn/v1/` will be used.
+            (default: :obj:`None`)
+        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", 'SILICONFLOW_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 = SiliconFlowConfig().as_dict()
+        api_key = api_key or os.environ.get("SILICONFLOW_API_KEY")
+        url = url or os.environ.get(
+            "SILICONFLOW_API_BASE_URL",
+            "https://api.siliconflow.cn/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 SiliconFlow 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:
+            BaseTokenCounter: 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 SiliconFlow API.
+
+        Raises:
+            ValueError: If the model configuration dictionary contains any
+                unexpected arguments to SiliconFlow API.
+        """
+        for param in self.model_config_dict:
+            if param not in SILICONFLOW_API_PARAMS:
+                raise ValueError(
+                    f"Unexpected argument `{param}` is "
+                    "input into SiliconFlow model backend."
+                )
+
+    @property
+    def stream(self) -> bool:
+        """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/societies/workforce/role_playing_worker.py

@@ -168,11 +168,9 @@ class RolePlayingWorker(Worker):
             chat_history=chat_history_str,
             additional_info=task.additional_info,
         )
-        req = BaseMessage.make_user_message(
-            role_name="User",
-            content=prompt,
+        response = self.summarize_agent.step(
+            prompt, response_format=TaskResult
         )
-        response = self.summarize_agent.step(req, response_format=TaskResult)
         result_dict = json.loads(response.msg.content)
         task_result = TaskResult(**result_dict)
         task.result = task_result.content

camel/societies/workforce/single_agent_worker.py

@@ -19,7 +19,6 @@ from typing import Any, List
 from colorama import Fore
 
 from camel.agents import ChatAgent
-from camel.messages.base import BaseMessage
 from camel.societies.workforce.prompts import PROCESS_TASK_PROMPT
 from camel.societies.workforce.utils import TaskResult
 from camel.societies.workforce.worker import Worker
@@ -72,12 +71,8 @@ class SingleAgentWorker(Worker):
             dependency_tasks_info=dependency_tasks_info,
             additional_info=task.additional_info,
         )
-        req = BaseMessage.make_user_message(
-            role_name="User",
-            content=prompt,
-        )
         try:
-            response = self.worker.step(req, response_format=TaskResult)
+            response = self.worker.step(prompt, response_format=TaskResult)
         except Exception as e:
             print(
                 f"{Fore.RED}Error occurred while processing task {task.id}:"

camel/societies/workforce/workforce.py

@@ -281,13 +281,9 @@ class Workforce(BaseNode):
             child_nodes_info=self._get_child_nodes_info(),
             additional_info=task.additional_info,
         )
-        req = BaseMessage.make_user_message(
-            role_name="User",
-            content=prompt,
-        )
 
         response = self.coordinator_agent.step(
-            req, response_format=TaskAssignResult
+            prompt, response_format=TaskAssignResult
         )
         result_dict = json.loads(response.msg.content)
         task_assign_result = TaskAssignResult(**result_dict)
@@ -315,11 +311,9 @@ class Workforce(BaseNode):
             child_nodes_info=self._get_child_nodes_info(),
             additional_info=task.additional_info,
         )
-        req = BaseMessage.make_user_message(
-            role_name="User",
-            content=prompt,
+        response = self.coordinator_agent.step(
+            prompt, response_format=WorkerConf
         )
-        response = self.coordinator_agent.step(req, response_format=WorkerConf)
         result_dict = json.loads(response.msg.content)
         new_node_conf = WorkerConf(**result_dict)
 

camel/toolkits/__init__.py

@@ -45,6 +45,8 @@ from .human_toolkit import HumanToolkit
 from .stripe_toolkit import StripeToolkit
 from .video_toolkit import VideoDownloaderToolkit
 from .dappier_toolkit import DappierToolkit
+from .sympy_toolkit import SymPyToolkit
+from .semantic_scholar_toolkit import SemanticScholarToolkit
 
 __all__ = [
     'BaseToolkit',
@@ -77,4 +79,6 @@ __all__ = [
     'MeshyToolkit',
     'OpenBBToolkit',
     'DappierToolkit',
+    'SymPyToolkit',
+    'SemanticScholarToolkit',
 ]