fix: enhance new feature implementation (#1826)

Author: Wendong-Fan

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -26,7 +26,7 @@ body:
     attributes:
       label: What version of camel are you using?
       description: Run command `python3 -c 'print(__import__("camel").__version__)'` in your shell and paste the output here.
-      placeholder: E.g., 0.2.26
+      placeholder: E.g., 0.2.27
     validations:
       required: true
 

.github/workflows/build_package.yml

@@ -97,6 +97,7 @@ jobs:
           MOONSHOT_API_KEY: "${{ secrets.MOONSHOT_API_KEY }}"
           AIML_API_KEY: "${{ secrets.AIML_API_KEY }}"
           NVIDIA_API_KEY: "${{ secrets.NVIDIA_API_KEY }}"
+          VOLCANO_API_KEY: "${{ secrets.VOLCANO_API_KEY }}"
         run: |
           source test_venv/bin/activate
           pytest --fast-test-mode ./test

.github/workflows/pytest_package.yml

@@ -62,6 +62,7 @@ jobs:
         MOONSHOT_API_KEY: "${{ secrets.MOONSHOT_API_KEY }}"
         SILICONFLOW_API_KEY: "${{ secrets.SILICONFLOW_API_KEY }}"
         AIML_API_KEY: "${{ secrets.AIML_API_KEY }}"
+        VOLCANO_API_KEY: "${{ secrets.VOLCANO_API_KEY }}"
       run: |
         source .venv/bin/activate
         uv pip install -e ".[all, dev, docs]"
@@ -116,6 +117,7 @@ jobs:
         MOONSHOT_API_KEY: "${{ secrets.MOONSHOT_API_KEY }}"
         SILICONFLOW_API_KEY: "${{ secrets.SILICONFLOW_API_KEY }}"
         AIML_API_KEY: "${{ secrets.AIML_API_KEY }}"
+        VOLCANO_API_KEY: "${{ secrets.VOLCANO_API_KEY }}"
       run: |
         source .venv/bin/activate
         uv pip install -e ".[all, dev, docs]"
@@ -168,6 +170,7 @@ jobs:
         INTERNLM_API_KEY: "${{ secrets.INTERNLM_API_KEY }}"
         JINA_API_KEY: "${{ secrets.JINA_API_KEY }}"
         MOONSHOT_API_KEY: "${{ secrets.MOONSHOT_API_KEY }}"
+        VOLCANO_API_KEY: "${{ secrets.VOLCANO_API_KEY }}"
       run: |
         source .venv/bin/activate
         uv pip install -e ".[all, dev, docs]"

camel/__init__.py

@@ -14,7 +14,7 @@
 
 from camel.logger import disable_logging, enable_logging, set_log_level
 
-__version__ = '0.2.26'
+__version__ = '0.2.27'
 
 __all__ = [
     '__version__',

camel/models/volcano_model.py

@@ -13,14 +13,11 @@
 # ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 
 import os
-from typing import Any, Dict, List, Optional, Type, Union
-
-from pydantic import BaseModel
+from typing import Any, Dict, Optional, Union
 
 from camel.configs import OPENAI_API_PARAMS
-from camel.messages import OpenAIMessage
 from camel.models.openai_compatible_model import OpenAICompatibleModel
-from camel.types import ChatCompletion, ModelType
+from camel.types import ModelType
 from camel.utils import (
     BaseTokenCounter,
     OpenAITokenCounter,
@@ -61,14 +58,14 @@ def __init__(
     ) -> None:
         if model_config_dict is None:
             model_config_dict = {}
-        
+
         api_key = api_key or os.environ.get("VOLCANO_API_KEY")
         url = (
             url
             or os.environ.get("VOLCANO_API_BASE_URL")
             or "https://ark.cn-beijing.volces.com/api/v3"
         )
-        
+
         super().__init__(
             model_type, model_config_dict, api_key, url, token_counter
         )
@@ -100,4 +97,4 @@ def check_model_config(self):
                 raise ValueError(
                     f"Unexpected argument `{param}` is "
                     "input into Volcano model backend."
-                ) 
+                )

camel/toolkits/__init__.py

@@ -55,7 +55,7 @@
 from .video_analysis_toolkit import VideoAnalysisToolkit
 from .image_analysis_toolkit import ImageAnalysisToolkit
 from .mcp_toolkit import MCPToolkit
-from .web_toolkit import WebToolkit
+from .browser_toolkit import BrowserToolkit
 from .file_write_toolkit import FileWriteToolkit
 from .terminal_toolkit import TerminalToolkit
 from .pubmed_toolkit import PubMedToolkit
@@ -102,7 +102,7 @@
     'ExcelToolkit',
     'VideoAnalysisToolkit',
     'ImageAnalysisToolkit',
-    'WebToolkit',
+    'BrowserToolkit',
     'FileWriteToolkit',
     'TerminalToolkit',
     'PubMedToolkit',

camel/toolkits/web_toolkit.py camel/toolkits/browser_toolkit.py

@@ -915,7 +915,7 @@ def get_webpage_content(self) -> str:
         return markdown_content
 
 
-class WebToolkit(BaseToolkit):
+class BrowserToolkit(BaseToolkit):
     r"""A class for browsing the web and interacting with web pages.
 
     This class provides methods for browsing the web and interacting with web
@@ -931,7 +931,7 @@ def __init__(
         planning_agent_model: Optional[BaseModelBackend] = None,
         output_language: str = "en",
     ):
-        r"""Initialize the WebToolkit instance.
+        r"""Initialize the BrowserToolkit instance.
 
         Args:
             headless (bool): Whether to run the browser in headless mode.
@@ -1289,7 +1289,7 @@ def _task_replanning(
             return False, replanned_schema
 
     @dependencies_required("playwright")
-    def browser_simulation(
+    def browse_url(
         self, task_prompt: str, start_url: str, round_limit: int = 12
     ) -> str:
         r"""A powerful toolkit which can simulate the browser interaction to solve the task which needs multi-step actions.
@@ -1370,4 +1370,4 @@ def browser_simulation(
         return simulation_result
 
     def get_tools(self) -> List[FunctionTool]:
-        return [FunctionTool(self.browser_simulation)]
+        return [FunctionTool(self.browse_url)]

camel/toolkits/search_toolkit.py

@@ -731,8 +731,8 @@ def search_bocha(
 
         Returns:
             Dict[str, Any]: A dictionary containing search results, including
-            web pages, images, and videos if available. The structure follows
-            the Bocha AI search API response format.
+                web pages, images, and videos if available. The structure
+                follows the Bocha AI search API response format.
         """
         import json
 

camel/types/enums.py

@@ -249,6 +249,7 @@ def support_native_tool_calling(self) -> bool:
                 self.is_siliconflow,
                 self.is_zhipuai,
                 self.is_aiml,
+                self.is_azure_openai,
             ]
         )
 

docs/conf.py

@@ -27,7 +27,7 @@
 project = 'CAMEL'
 copyright = '2024, CAMEL-AI.org'
 author = 'CAMEL-AI.org'
-release = '0.2.26'
+release = '0.2.27'
 
 html_favicon = (
     'https://raw.githubusercontent.com/camel-ai/camel/master/misc/favicon.png'

docs/key_modules/loaders.md

@@ -340,14 +340,14 @@ response = jina_reader.read_content("https://docs.camel-ai.org/")
 print(response)
 ```
 ```markdown
->>>Welcome to CAMEL’s documentation! — CAMEL 0.2.26 documentation
+>>>Welcome to CAMEL’s documentation! — CAMEL 0.2.27 documentation
 ===============
 
 [Skip to main content](https://docs.camel-ai.org/#main-content)
 
 Back to top Ctrl+K
 
- [![Image 1](https://raw.githubusercontent.com/camel-ai/camel/master/misc/logo_light.png) ![Image 2](https://raw.githubusercontent.com/camel-ai/camel/master/misc/logo_light.png)CAMEL 0.2.26](https://docs.camel-ai.org/#)
+ [![Image 1](https://raw.githubusercontent.com/camel-ai/camel/master/misc/logo_light.png) ![Image 2](https://raw.githubusercontent.com/camel-ai/camel/master/misc/logo_light.png)CAMEL 0.2.27](https://docs.camel-ai.org/#)
 
 Search Ctrl+K
 

docs/key_modules/tools.md

@@ -183,7 +183,7 @@ CAMEL provides a variety of built-in toolkits that you can use right away. Here'
 | VideoAnalysisToolkit | A toolkit for analyzing video content with vision-language models, including frame extraction and question answering about video content. |
 | VideoDownloaderToolkit | A toolkit for downloading videos and optionally splitting them into chunks, with support for various video services. |
 | WeatherToolkit | A toolkit for fetching weather data for cities using the OpenWeatherMap API. |
-| WebToolkit | A toolkit for browsing the web and interacting with web pages, including browser simulation and content extraction. |
+| BrowserToolkit | A toolkit for browsing the web and interacting with web pages, including browser simulation and content extraction. |
 | WhatsAppToolkit | A toolkit for interacting with the WhatsApp Business API, including sending messages, managing message templates, and accessing business profile information. |
 | ZapierToolkit | A toolkit for interacting with Zapier's NLA API to execute actions through natural language commands and automate workflows. |
 

examples/models/role_playing_with_volcano.py

@@ -12,12 +12,10 @@
 # limitations under the License.
 # ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 
-import os
 from typing import Dict, List, Optional, Tuple
 
-from camel.societies import RolePlaying
-from camel.configs import ChatGPTConfig
 from camel.models import ModelFactory
+from camel.societies import RolePlaying
 from camel.types import ModelPlatformType
 from camel.utils import print_text_animated
 
@@ -41,7 +39,7 @@ def main(
     with_task_specify: bool = True,
     model_config_dict: Optional[Dict] = None,
 ) -> Tuple[List[Dict], List[Dict]]:
-    """Run a role-playing session with Volcano Engine API.
+    r"""Run a role-playing session with Volcano Engine API.
 
     Args:
         assistant_role_name: The role name of the assistant.
@@ -54,18 +52,10 @@ def main(
         A tuple of assistant and user message lists.
     """
     if model_config_dict is None:
-        model_config_dict = ChatGPTConfig(
-            temperature=0.2,
-            max_tokens=1024,
-        ).as_dict()
-
-    # Check if VOLCANO_API_KEY is set
-    api_key = os.environ.get("VOLCANO_API_KEY")
-    if not api_key:
-        raise ValueError(
-            "VOLCANO_API_KEY environment variable is not set. "
-            "Please set it before running this example."
-        )
+        model_config_dict = {
+            "temperature": 0.2,
+            "max_tokens": 1024,
+        }
 
     # Create models for assistant and user
     assistant_model = ModelFactory.create(
@@ -104,7 +94,9 @@ def main(
     input_msg = role_playing.init_chat()  # Initialize the chat
     while n < 10:
         n += 1
-        assistant_response, user_response = role_playing.step(input_msg)  # Provide input_msg
+        assistant_response, user_response = role_playing.step(
+            input_msg
+        )  # Provide input_msg
         if assistant_response is None or user_response is None:
             break
 
@@ -126,10 +118,13 @@ def main(
         if "<CAMEL_TASK_DONE>" in user_response.msg.content:
             break
 
-        input_msg = assistant_response.msg  # Update input_msg for the next step
+        input_msg = (
+            assistant_response.msg
+        )  # Update input_msg for the next step
 
-    # return role_playing.assistant_agent.chat_history, role_playing.user_agent.chat_history
+    # return role_playing.assistant_agent.chat_history, role_playing.
+    # user_agent.chat_history
 
 
 if __name__ == "__main__":
-    main() 
+    main()

examples/models/volcano_model_example.py

@@ -44,4 +44,4 @@
 
 # Get response information
 response = camel_agent.step(user_msg)
-print(response.msgs[0].content) 
+print(response.msgs[0].content)

examples/toolkits/search_toolkit.py

@@ -78,7 +78,8 @@
 response = agent.step(input_message=usr_msg, response_format=None)
 
 print(response.msgs[0].content)
-'''
+"""
+===============================================================================
 The current temperature in Tokyo can be found on various weather websites. 
 Here are a couple of reliable sources where you can check the latest weather 
 conditions:
@@ -88,8 +89,8 @@
 
 You can visit these links to get the most up-to-date temperature and weather 
 conditions in Tokyo.
-'''
-
+===============================================================================
+"""
 search_linkup_response = SearchToolkit().search_linkup(
     query="Can you tell me which women were awared the Physics Nobel Prize",
     depth="standard",
@@ -98,6 +99,7 @@
 
 print(search_linkup_response)
 """
+===============================================================================
 {'results': [{'type': 'text', 'name': 'Physics Nobel Prizes awarded to women | 
 Scientia News', 'url': 'https://www.scientianews.org/
 physics-nobel-prize-winners', 'content': 'The next female Nobel Prize in 
@@ -163,6 +165,7 @@
 and 1972 . Marie Curie was awarded the Nobel Prize twice, once in physics 1903 
 and once in chemistry 1911.. See the list of multiple Nobel Prize laureates 
 within other Nobel Prize categories here'}]}
+===============================================================================
 """
 
 search_linkup_response = SearchToolkit().search_linkup(
@@ -173,6 +176,7 @@
 
 print(search_linkup_response)
 """
+===============================================================================
 {'answer': "The women who have been awarded the Nobel Prize in Physics are: 1. 
 Marie Curie - 1903 2. Maria Goeppert Mayer - 1963 3. Donna Strickland - 2018 
 4. Anne L'Huillier - 2023", 'sources': [{'name': 'Nobel Prize awarded women - 
@@ -188,7 +192,7 @@
 "The most recent women to be awarded a Nobel Prize were Han Kang in Literature 
 (2024), Claudia Goldin in Economics, Narges Mohammadi for Peace, Anne 
 L'Huillier in Physics and Katalin Karikó in Physiology or Medicine (2023)."}]}
-(camel-ai-py3.10) ruihan@RuideMac-mini camel % 
+===============================================================================
 """
 
 
@@ -207,11 +211,13 @@ class PersonInfo(BaseModel):
 print(search_linkup_response)
 
 """
+===============================================================================
 {'name': 'Female Nobel Prize Winners in Physics', 'description': 'The women 
 awarded the Nobel Prize in Physics include: 1. Marie Curie (1903) 2. Maria 
 Goeppert-Mayer (1963) 3. Donna Strickland (2018) 4. (4th winner not mentioned 
 in the provided data) 5. (5th winner not mentioned in the provided data). Less 
 than 5 women have won the Nobel Prize in Physics out of 225 total laureates.'}
+===============================================================================
 """
 
 search_bocha_response = SearchToolkit().search_bocha(
@@ -223,6 +229,7 @@ class PersonInfo(BaseModel):
 print(search_bocha_response)
 
 """
+===============================================================================
 {"_type":"SearchResponse","queryContext":{"originalQuery":"阿里巴巴2024年的esg报
 告"},"webPages":{"webSearchUrl":"","totalEstimatedMatches":8912791,"value":[
 {"id":None,"name":"阿里巴巴发布2024年ESG报告持续推进减碳与数字化普惠","url":"ht
@@ -242,4 +249,5 @@ class PersonInfo(BaseModel):
 dingFormat":None,"hostPageDisplayUrl":"https://m.sohu.com/a/796245119_121713887
 /?pvid=000115_3w_a","width":1285,"height":722,"thumbnail":None}],"isFamilyFrien
 dly":None},"videos":None}
+===============================================================================
 """

examples/toolkits/web_toolkit.py

@@ -16,7 +16,7 @@
 from camel.agents import ChatAgent
 from camel.configs import ChatGPTConfig
 from camel.models import ModelFactory
-from camel.toolkits import WebToolkit
+from camel.toolkits import BrowserToolkit
 from camel.types import ModelPlatformType, ModelType
 
 model = ModelFactory.create(
@@ -43,7 +43,7 @@
     ).as_dict(),
 )
 
-web_toolkit = WebToolkit(
+web_toolkit = BrowserToolkit(
     headless=False,
     web_agent_model=web_agent_model,
     planning_agent_model=planning_agent_model,

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "camel-ai"
-version = "0.2.26"
+version = "0.2.27"
 description = "Communicative Agents for AI Society Study"
 authors = [{ name = "CAMEL-AI.org" }]
 requires-python = ">=3.10,<3.13"