camel-ai 0.2.18__py3-none-any.whl → 0.2.20a0__py3-none-any.whl

camel/models/deepseek_model.py

@@ -13,12 +13,12 @@
 # ========= 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
 
 from camel.configs import DEEPSEEK_API_PARAMS, DeepSeekConfig
+from camel.logger import get_logger
 from camel.messages import OpenAIMessage
 from camel.models.base_model import BaseModelBackend
 from camel.types import (
@@ -28,6 +28,8 @@ from camel.types import (
 )
 from camel.utils import BaseTokenCounter, OpenAITokenCounter, api_keys_required
 
+logger = get_logger(__name__)
+
 
 class DeepSeekModel(BaseModelBackend):
     r"""DeepSeek API in a unified BaseModelBackend interface.
@@ -116,11 +118,12 @@ class DeepSeekModel(BaseModelBackend):
         if self.model_type in [
             ModelType.DEEPSEEK_REASONER,
         ]:
-            warnings.warn(
-                "Warning: You are using an DeepSeek Reasoner model, "
+            import re
+
+            logger.warning(
+                "You are using a DeepSeek Reasoner model, "
                 "which has certain limitations, reference: "
-                "`https://api-docs.deepseek.com/guides/reasoning_model#api-parameters`.",
-                UserWarning,
+                "`https://api-docs.deepseek.com/guides/reasoning_model#api-parameters`"
             )
 
             # Check and remove unsupported parameters and reset the fixed
@@ -138,14 +141,29 @@ class DeepSeekModel(BaseModelBackend):
                 if key in self.model_config_dict:
                     del self.model_config_dict[key]
 
+            # Remove thinking content from messages before sending to API
+            # This ensures only the final response is sent, excluding
+            # intermediate thought processes
+            messages = [
+                {  # type: ignore[misc]
+                    **msg,
+                    'content': re.sub(
+                        r'<think>.*?</think>',
+                        '',
+                        msg['content'],  # type: ignore[arg-type]
+                        flags=re.DOTALL,
+                    ).strip(),
+                }
+                for msg in messages
+            ]
+
         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
+        # Handle reasoning content with <think> tags at the beginning
         if (
             self.model_type
             in [
@@ -156,10 +174,10 @@ class DeepSeekModel(BaseModelBackend):
         ):
             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 "")
-            )
+                f"<think>\n{reasoning_content}\n</think>\n"
+                if reasoning_content
+                else ""
+            ) + response.choices[0].message.content
 
             response = ChatCompletion.construct(
                 id=response.id,

camel/models/groq_model.py

@@ -88,8 +88,6 @@ class GroqModel(BaseModelBackend):
             BaseTokenCounter: The token counter following the model's
                 tokenization style.
         """
-        # Make sure you have the access to these open-source model in
-        # HuggingFace
         if not self._token_counter:
             self._token_counter = OpenAITokenCounter(ModelType.GPT_4O_MINI)
         return self._token_counter

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)

camel/models/openai_model.py

@@ -21,7 +21,6 @@ from camel.configs import OPENAI_API_PARAMS, ChatGPTConfig
 from camel.messages import OpenAIMessage
 from camel.models import BaseModelBackend
 from camel.types import (
-    NOT_GIVEN,
     ChatCompletion,
     ChatCompletionChunk,
     ModelType,
@@ -112,6 +111,7 @@ class OpenAIModel(BaseModelBackend):
             ModelType.O1,
             ModelType.O1_MINI,
             ModelType.O1_PREVIEW,
+            ModelType.O3_MINI,
         ]:
             warnings.warn(
                 "Warning: You are using an O1 model (O1_MINI or O1_PREVIEW), "
@@ -148,14 +148,6 @@ class OpenAIModel(BaseModelBackend):
 
             return self._to_chat_completion(response)
 
-        # Removing 'strict': True from the dictionary for
-        # client.chat.completions.create
-        if self.model_config_dict.get('tools') is not NOT_GIVEN:
-            for tool in self.model_config_dict.get('tools', []):
-                function_dict = tool.get('function', {})
-                if 'strict' in function_dict:
-                    del function_dict['strict']
-
         response = self._client.chat.completions.create(
             messages=messages,
             model=self.model_type,

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 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/toolkits/__init__.py

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

camel/toolkits/search_toolkit.py

@@ -13,10 +13,9 @@
 # ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 import os
 import xml.etree.ElementTree as ET
-from typing import Any, Dict, List, Literal, Optional, Type, TypeAlias, Union
+from typing import Any, Dict, List, Literal, Optional, TypeAlias, Union
 
 import requests
-from pydantic import BaseModel
 
 from camel.toolkits.base import BaseToolkit
 from camel.toolkits.function_tool import FunctionTool
@@ -77,7 +76,7 @@ class SearchToolkit(BaseToolkit):
         output_type: Literal[
             "searchResults", "sourcedAnswer", "structured"
         ] = "searchResults",
-        structured_output_schema: Union[Type[BaseModel], str, None] = None,
+        structured_output_schema: Optional[str] = None,
     ) -> Dict[str, Any]:
         r"""Search for a query in the Linkup API and return results in various
         formats.
@@ -92,9 +91,9 @@ class SearchToolkit(BaseToolkit):
                 - "searchResults" for raw search results,
                 - "sourcedAnswer" for an answer with supporting sources,
                 - "structured" for output based on a provided schema.
-            structured_output_schema (Union[Type[BaseModel], str, None]): If
-                `output_type` is "structured",specify the schema of the
-                output. Can be a Pydantic BaseModel or a JSON schema string.
+            structured_output_schema (Optional[str]): If `output_type` is
+                "structured", specify the schema of the output. Must be a
+                string representing a valid object JSON schema.
 
         Returns:
             Dict[str, Any]: A dictionary representing the search result. The
@@ -581,6 +580,18 @@ class SearchToolkit(BaseToolkit):
                 "image_url": image_url,
             }
 
+            # For Results pod, collect all plaintext values from subpods
+            if pod.get("@title") == "Results":
+                results_text = []
+                if isinstance(subpod_data, list):
+                    for subpod in subpod_data:
+                        if subpod.get("plaintext"):
+                            results_text.append(subpod["plaintext"])
+                else:
+                    if description:
+                        results_text.append(description)
+                pod_info["description"] = "\n".join(results_text)
+
             # Add to steps list
             output["pod_info"].append(pod_info)