camel-ai 0.1.9__py3-none-any.whl → 0.2.1__py3-none-any.whl

camel/__init__.py

@@ -12,7 +12,7 @@
 # limitations under the License.
 # =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
 
-__version__ = '0.1.9'
+__version__ = '0.2.1'
 
 __all__ = [
     '__version__',

camel/agents/chat_agent.py

@@ -181,6 +181,16 @@ class ChatAgent(BaseAgent):
             tool.get_function_name(): tool.func for tool in all_tools
         }
 
+        # If the user hasn't configured tools in `BaseModelBackend`,
+        # the tools set from `ChatAgent` will be used.
+        # This design simplifies the interface while retaining tool-running
+        # capabilities for `BaseModelBackend`.
+        if all_tools and not self.model_backend.model_config_dict['tools']:
+            tool_schema_list = [
+                tool.get_openai_tool_schema() for tool in all_tools
+            ]
+            self.model_backend.model_config_dict['tools'] = tool_schema_list
+
         self.model_config_dict = self.model_backend.model_config_dict
 
         self.model_token_limit = token_limit or self.model_backend.token_limit
@@ -612,9 +622,11 @@ class ChatAgent(BaseAgent):
 
         # Replace the original tools with the structuring function
         self.func_dict = {func.get_function_name(): func.func}
+        self.model_backend.model_config_dict = original_model_dict.copy()
         self.model_backend.model_config_dict["tools"] = [
             func.get_openai_tool_schema()
         ]
+        self.model_backend.model_config_dict["tool_choice"] = "required"
 
         openai_messages, num_tokens = self.memory.get_context()
         (

camel/loaders/firecrawl_reader.py

@@ -49,7 +49,6 @@ class Firecrawl:
         self,
         url: str,
         params: Optional[Dict[str, Any]] = None,
-        wait_until_done: bool = True,
         **kwargs: Any,
     ) -> Any:
         r"""Crawl a URL and all accessible subpages. Customize the crawl by
@@ -60,14 +59,12 @@ class Firecrawl:
             url (str): The URL to crawl.
             params (Optional[Dict[str, Any]]): Additional parameters for the
                 crawl request. Defaults to `None`.
-            wait_until_done (bool): Whether to wait until the crawl job is
-                completed. Defaults to `True`.
             **kwargs (Any): Additional keyword arguments, such as
-                `poll_interval`, `idempotency_key`, etc.
+                `poll_interval`, `idempotency_key`.
 
         Returns:
-            Any: The list content of the URL if `wait_until_done` is True;
-                otherwise, a string job ID.
+            Any: The crawl job ID or the crawl results if waiting until
+                completion.
 
         Raises:
             RuntimeError: If the crawling process fails.
@@ -78,13 +75,8 @@ class Firecrawl:
                 url=url,
                 params=params,
                 **kwargs,
-                wait_until_done=wait_until_done,
-            )
-            return (
-                crawl_response
-                if wait_until_done
-                else crawl_response.get("jobId")
             )
+            return crawl_response
         except Exception as e:
             raise RuntimeError(f"Failed to crawl the URL: {e}")
 
@@ -103,7 +95,10 @@ class Firecrawl:
         """
 
         try:
-            crawl_result = self.app.crawl_url(url=url)
+            crawl_result = self.app.crawl_url(
+                url,
+                {'formats': ['markdown']},
+            )
             if not isinstance(crawl_result, list):
                 raise ValueError("Unexpected response format")
             markdown_contents = [
@@ -180,41 +175,14 @@ class Firecrawl:
             data = self.app.scrape_url(
                 url,
                 {
-                    'extractorOptions': {
-                        "mode": "llm-extraction",
-                        "extractionPrompt": "Based on the information on "
-                        "the page, extract the information from the schema.",
-                        'extractionSchema': output_schema.model_json_schema(),
-                    },
-                    'pageOptions': {'onlyMainContent': True},
+                    'formats': ['extract'],
+                    'extract': {'schema': output_schema.model_json_schema()},
                 },
             )
-            return data.get("llm_extraction", {})
+            return data.get("extract", {})
         except Exception as e:
             raise RuntimeError(f"Failed to perform structured scrape: {e}")
 
-    def tidy_scrape(self, url: str) -> str:
-        r"""Only return the main content of the page, excluding headers,
-        navigation bars, footers, etc. in Markdown format.
-
-        Args:
-            url (str): The URL to read.
-
-        Returns:
-            str: The markdown content of the URL.
-
-        Raises:
-            RuntimeError: If the scrape process fails.
-        """
-
-        try:
-            scrape_result = self.app.scrape_url(
-                url, {'pageOptions': {'onlyMainContent': True}}
-            )
-            return scrape_result.get("markdown", "")
-        except Exception as e:
-            raise RuntimeError(f"Failed to perform tidy scrape: {e}")
-
     def map_site(
         self, url: str, params: Optional[Dict[str, Any]] = None
     ) -> list:

camel/models/mistral_model.py

@@ -93,7 +93,7 @@ class MistralModel(BaseModelBackend):
                         "name": tool_call.function.name,  # type: ignore[union-attr]
                         "arguments": tool_call.function.arguments,  # type: ignore[union-attr]
                     },
-                    type=tool_call.TYPE,  # type: ignore[union-attr]
+                    type=tool_call.type,  # type: ignore[union-attr]
                 )
                 for tool_call in response.choices[0].message.tool_calls
             ]

camel/models/openai_model.py

@@ -93,6 +93,22 @@ class OpenAIModel(BaseModelBackend):
                 `ChatCompletion` in the non-stream mode, or
                 `Stream[ChatCompletionChunk]` in the stream mode.
         """
+        # o1-preview and o1-mini have Beta limitations
+        # reference: https://platform.openai.com/docs/guides/reasoning
+        if self.model_type in [ModelType.O1_MINI, ModelType.O1_PREVIEW]:
+            # Remove system message that is not supported in o1 model.
+            messages = [msg for msg in messages if msg.get("role") != "system"]
+
+            # Remove unsupported parameters and reset the fixed parameters
+            del self.model_config_dict["stream"]
+            del self.model_config_dict["tools"]
+            del self.model_config_dict["tool_choice"]
+            self.model_config_dict["temperature"] = 1.0
+            self.model_config_dict["top_p"] = 1.0
+            self.model_config_dict["n"] = 1.0
+            self.model_config_dict["presence_penalty"] = 0.0
+            self.model_config_dict["frequency_penalty"] = 0.0
+
         response = self._client.chat.completions.create(
             messages=messages,
             model=self.model_type.value,

camel/tasks/task.py

@@ -93,6 +93,10 @@ class Task(BaseModel):
 
     result: Optional[str] = ""
 
+    failure_count: int = 0
+
+    additional_info: Optional[str] = None
+
     @classmethod
     def from_message(cls, message: BaseMessage) -> "Task":
         r"""Create a task from a message.
@@ -193,7 +197,7 @@ class Task(BaseModel):
     def decompose(
         self,
         agent: ChatAgent,
-        template: TextPrompt = TASK_DECOMPOSE_PROMPT,
+        prompt: Optional[str] = None,
         task_parser: Callable[[str, str], List["Task"]] = parse_response,
     ) -> List["Task"]:
         r"""Decompose a task to a list of sub-tasks. It can be used for data
@@ -201,8 +205,8 @@ class Task(BaseModel):
 
         Args:
             agent (ChatAgent): An agent that used to decompose the task.
-            template (TextPrompt): The prompt template to decompose
-                task. If not provided, the default template will be used.
+            prompt (str, optional): A prompt to decompose the task. If not
+                provided, the default prompt will be used.
             task_parser (Callable[[str, str], List[Task]], optional): A
                 function to extract Task from response. If not provided,
                 the default parse_response will be used.
@@ -212,7 +216,7 @@ class Task(BaseModel):
         """
 
         role_name = agent.role_name
-        content = template.format(
+        content = prompt or TASK_DECOMPOSE_PROMPT.format(
             role_name=role_name,
             content=self.content,
         )
@@ -221,6 +225,8 @@ class Task(BaseModel):
         )
         response = agent.step(msg)
         tasks = task_parser(response.msg.content, self.id)
+        for task in tasks:
+            task.additional_info = self.additional_info
         return tasks
 
     def compose(
@@ -248,6 +254,7 @@ class Task(BaseModel):
         content = template.format(
             role_name=role_name,
             content=self.content,
+            additional_info=self.additional_info,
             other_results=sub_tasks_result,
         )
         msg = BaseMessage.make_user_message(

camel/tasks/task_prompt.py

@@ -39,6 +39,10 @@ The root task is:
 
 {content}
 
+The additional information of the task is:
+
+{additional_info}
+
 The related tasks result and status:
 
 {other_results}

camel/toolkits/__init__.py

@@ -19,19 +19,18 @@ from .openai_function import (
 )
 from .open_api_specs.security_config import openapi_security_config
 
-from .google_maps_toolkit import MAP_FUNCS, GoogleMapsToolkit
-from .math_toolkit import MATH_FUNCS, MathToolkit
-from .open_api_toolkit import OPENAPI_FUNCS, OpenAPIToolkit
-from .retrieval_toolkit import RETRIEVAL_FUNCS, RetrievalToolkit
-from .search_toolkit import SEARCH_FUNCS, SearchToolkit
-from .twitter_toolkit import TWITTER_FUNCS, TwitterToolkit
-from .weather_toolkit import WEATHER_FUNCS, WeatherToolkit
-from .slack_toolkit import SLACK_FUNCS, SlackToolkit
-from .dalle_toolkit import DALLE_FUNCS, DalleToolkit
-from .linkedin_toolkit import LINKEDIN_FUNCS, LinkedInToolkit
-from .reddit_toolkit import REDDIT_FUNCS, RedditToolkit
+from .google_maps_toolkit import GoogleMapsToolkit
+from .math_toolkit import MathToolkit, MATH_FUNCS
+from .open_api_toolkit import OpenAPIToolkit
+from .retrieval_toolkit import RetrievalToolkit
+from .search_toolkit import SearchToolkit, SEARCH_FUNCS
+from .twitter_toolkit import TwitterToolkit
+from .weather_toolkit import WeatherToolkit, WEATHER_FUNCS
+from .slack_toolkit import SlackToolkit
+from .dalle_toolkit import DalleToolkit, DALLE_FUNCS
+from .linkedin_toolkit import LinkedInToolkit
+from .reddit_toolkit import RedditToolkit
 
-from .base import BaseToolkit
 from .code_execution import CodeExecutionToolkit
 from .github_toolkit import GithubToolkit
 
@@ -40,18 +39,6 @@ __all__ = [
     'get_openai_function_schema',
     'get_openai_tool_schema',
     'openapi_security_config',
-    'MATH_FUNCS',
-    'MAP_FUNCS',
-    'OPENAPI_FUNCS',
-    'RETRIEVAL_FUNCS',
-    'SEARCH_FUNCS',
-    'TWITTER_FUNCS',
-    'WEATHER_FUNCS',
-    'SLACK_FUNCS',
-    'DALLE_FUNCS',
-    'LINKEDIN_FUNCS',
-    'REDDIT_FUNCS',
-    'BaseToolkit',
     'GithubToolkit',
     'MathToolkit',
     'GoogleMapsToolkit',
@@ -65,4 +52,8 @@ __all__ = [
     'LinkedInToolkit',
     'RedditToolkit',
     'CodeExecutionToolkit',
+    'MATH_FUNCS',
+    'SEARCH_FUNCS',
+    'WEATHER_FUNCS',
+    'DALLE_FUNCS',
 ]

camel/toolkits/google_maps_toolkit.py

@@ -142,10 +142,6 @@ class GoogleMapsToolkit(BaseToolkit):
                 information on address completion, formatted address,
                 geographical coordinates (latitude and longitude), and metadata
                 types true for the address.
-
-        Raises:
-            ImportError: If the `googlemaps` library is not installed.
-            Exception: For unexpected errors during the address validation.
         """
         addressvalidation_result = self.gmaps.addressvalidation(
             [address],
@@ -304,6 +300,3 @@ class GoogleMapsToolkit(BaseToolkit):
             OpenAIFunction(self.get_elevation),
             OpenAIFunction(self.get_timezone),
         ]
-
-
-MAP_FUNCS: List[OpenAIFunction] = GoogleMapsToolkit().get_tools()

camel/toolkits/linkedin_toolkit.py

@@ -225,6 +225,3 @@ class LinkedInToolkit(BaseToolkit):
         if not token:
             return "Access token not found. Please set LINKEDIN_ACCESS_TOKEN."
         return token
-
-
-LINKEDIN_FUNCS: List[OpenAIFunction] = LinkedInToolkit().get_tools()

camel/toolkits/open_api_toolkit.py

@@ -542,6 +542,3 @@ class OpenAPIToolkit:
             OpenAIFunction(a_func, a_schema)
             for a_func, a_schema in zip(all_funcs_lst, all_schemas_lst)
         ]
-
-
-OPENAPI_FUNCS: List[OpenAIFunction] = OpenAPIToolkit().get_tools()

camel/toolkits/reddit_toolkit.py

@@ -232,6 +232,3 @@ class RedditToolkit(BaseToolkit):
             OpenAIFunction(self.perform_sentiment_analysis),
             OpenAIFunction(self.track_keyword_discussions),
         ]
-
-
-REDDIT_FUNCS: List[OpenAIFunction] = RedditToolkit().get_tools()

camel/toolkits/retrieval_toolkit.py

@@ -86,7 +86,3 @@ class RetrievalToolkit(BaseToolkit):
         return [
             OpenAIFunction(self.information_retrieval),
         ]
-
-
-# add the function to OpenAIFunction list
-RETRIEVAL_FUNCS: List[OpenAIFunction] = RetrievalToolkit().get_tools()

camel/toolkits/slack_toolkit.py

@@ -303,6 +303,3 @@ class SlackToolkit(BaseToolkit):
             OpenAIFunction(self.send_slack_message),
             OpenAIFunction(self.delete_slack_message),
         ]
-
-
-SLACK_FUNCS: List[OpenAIFunction] = SlackToolkit().get_tools()

camel/toolkits/twitter_toolkit.py

@@ -410,7 +410,7 @@ class TwitterToolkit(BaseToolkit):
         return TWITTER_CONSUMER_KEY, TWITTER_CONSUMER_SECRET
 
     def _get_oauth_session(self) -> requests.Session:
-        r'''Initiates an OAuth1Session with Twitter's API and returns it.
+        r"""Initiates an OAuth1Session with Twitter's API and returns it.
 
         The function first fetches a request token, then prompts the user to
         authorize the application. After the user has authorized the
@@ -431,7 +431,7 @@ class TwitterToolkit(BaseToolkit):
             Manage-Tweets/create_tweet.py
             https://github.com/twitterdev/Twitter-API-v2-sample-code/blob/main/
             User-Lookup/get_users_me_user_context.py
-        '''
+        """
         try:
             from requests_oauthlib import OAuth1Session
         except ImportError:
@@ -517,6 +517,3 @@ class TwitterToolkit(BaseToolkit):
             return "HTTP Exception"
         else:
             return "Unexpected Exception"
-
-
-TWITTER_FUNCS: List[OpenAIFunction] = TwitterToolkit().get_tools()

camel/utils/commons.py

@@ -381,10 +381,17 @@ def json_to_function_code(json_obj: Dict) -> str:
     docstring_args = []
     return_keys = []
 
+    prop_to_python = {
+        'string': 'str',
+        'number': 'float',
+        'integer': 'int',
+        'boolean': 'bool',
+    }
+
     for prop in required:
         description = properties[prop]['description']
         prop_type = properties[prop]['type']
-        python_type = 'str' if prop_type == 'string' else prop_type
+        python_type = prop_to_python.get(prop_type, prop_type)
         args.append(f"{prop}: {python_type}")
         docstring_args.append(
             f"        {prop} ({python_type}): {description}."

camel/utils/token_counting.py

@@ -193,8 +193,14 @@ def get_model_encoding(value_for_tiktoken: str):
     try:
         encoding = tiktoken.encoding_for_model(value_for_tiktoken)
     except KeyError:
-        print("Model not found. Using cl100k_base encoding.")
-        encoding = tiktoken.get_encoding("cl100k_base")
+        if value_for_tiktoken in [
+            ModelType.O1_MINI.value,
+            ModelType.O1_PREVIEW.value,
+        ]:
+            encoding = tiktoken.get_encoding("o200k_base")
+        else:
+            print("Model not found. Using cl100k_base encoding.")
+            encoding = tiktoken.get_encoding("cl100k_base")
     return encoding
 
 

camel/workforce/__init__.py

@@ -12,12 +12,12 @@
 # limitations under the License.
 # =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
 
-from .base import BaseNode
-from .manager_node import ManagerNode
-from .worker_node import WorkerNode
+from .role_playing_worker import RolePlayingWorker
+from .single_agent_worker import SingleAgentWorker
+from .workforce import Workforce
 
 __all__ = [
-    "BaseNode",
-    "WorkerNode",
-    "ManagerNode",
+    "Workforce",
+    "SingleAgentWorker",
+    "RolePlayingWorker",
 ]

camel/workforce/base.py

@@ -15,36 +15,40 @@ from abc import ABC, abstractmethod
 from typing import Any
 
 from camel.workforce.task_channel import TaskChannel
+from camel.workforce.utils import check_if_running
 
 
 class BaseNode(ABC):
     def __init__(self, description: str) -> None:
         self.node_id = str(id(self))
         self.description = description
-        # every node is initialized to use its own channel
         self._channel: TaskChannel = TaskChannel()
         self._running = False
 
+    @check_if_running(False)
     def reset(self, *args: Any, **kwargs: Any) -> Any:
         """Resets the node to its initial state."""
-        raise NotImplementedError()
+        self._channel = TaskChannel()
+        self._running = False
 
     @abstractmethod
     def set_channel(self, channel: TaskChannel):
         r"""Sets the channel for the node."""
+        pass
 
     @abstractmethod
     async def _listen_to_channel(self):
         r"""Listens to the channel and handle tasks. This method should be
         the main loop for the node.
         """
+        pass
 
     @abstractmethod
     async def start(self):
         r"""Start the node."""
+        pass
 
     @abstractmethod
     def stop(self):
-        r"""
-        Stop the node.
-        """
+        r"""Stop the node."""
+        pass

camel/workforce/prompts.py

@@ -0,0 +1,175 @@
+# =========== Copyright 2023 @ 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 @ CAMEL-AI.org. All Rights Reserved. ===========
+from camel.prompts import TextPrompt
+
+# ruff: noqa: E501
+CREATE_NODE_PROMPT = TextPrompt(
+    """You need to use the given information to create a new worker node that contains a single agent for solving the category of tasks of the given one.
+The content of the given task is:
+
+==============================
+{content}
+==============================
+
+Here are some additional information about the task:
+
+==============================
+{additional_info}
+==============================
+
+Following is the information of the existing worker nodes. The format is <ID>:<description>:<additional_info>.
+
+==============================
+{child_nodes_info}
+==============================
+
+You must return the following information:
+1. The role of the agent working in the worker node, e.g. "programmer", "researcher", "product owner".
+2. The system message that will be sent to the agent in the node.
+3. The description of the new worker node itself.
+
+You should ensure that the node created is capable of solving all the tasks in the same category as the given one, don't make it too specific.
+Also, there should be no big overlap between the new work node and the existing ones.
+The information returned should be concise and clear.
+"""
+)
+
+ASSIGN_TASK_PROMPT = TextPrompt(
+    """You need to assign the task to a worker node.
+The content of the task is:
+
+==============================
+{content}
+==============================
+
+Here are some additional information about the task:
+
+==============================
+{additional_info}
+==============================
+
+Following is the information of the existing worker nodes. The format is <ID>:<description>:<additional_info>.
+
+==============================
+{child_nodes_info}
+==============================
+
+You must return the ID of the worker node that you think is most capable of doing the task.
+"""
+)
+
+PROCESS_TASK_PROMPT = TextPrompt(
+    """You need to process one given task.
+Here are results of some prerequisite tasks that you can refer to:
+
+==============================
+{dependency_tasks_info}
+==============================
+
+The content of the task that you need to do is:
+
+==============================
+{content}
+==============================
+
+Here are some additional information about the task:
+
+==============================
+{additional_info}
+==============================
+
+You are asked to return the result of the given task.
+However, if you think you can't finish the task, you MUST set the fail flag and leave the result empty.
+"""
+)
+
+
+ROLEPLAY_PROCESS_TASK_PROMPT = TextPrompt(
+    """You need to process the task. It is recommended that tools be actively called when needed.
+Here are results of some prerequisite tasks that you can refer to:
+
+==============================
+{dependency_task_info}
+==============================
+
+The content of the task that you need to do is:
+
+==============================
+{content}
+==============================
+
+Here are some additional information about the task:
+
+==============================
+{additional_info}
+==============================
+
+You must return the result of the given task.
+"""
+)
+
+ROLEPLAY_SUMMARIZE_PROMPT = TextPrompt(
+    """For this scenario, the roles of the user is {user_role} and role of the assistant is {assistant_role}.
+Here is the content of the task they are trying to solve:
+
+==============================
+{task_content}
+==============================
+
+Here are some additional information about the task:
+
+==============================
+{additional_info}
+==============================
+
+Here is their chat history on the task:
+
+==============================
+{chat_history}
+==============================
+
+Now you should summarize the scenario and return the result of the task.
+However, if you think they didn't finish the task, you MUST set the fail flag and leave the result empty.
+"""
+)
+
+WF_TASK_DECOMPOSE_PROMPT = r"""You need to split the given task into 
+subtasks according to the workers available in the group.
+The content of the task is:
+
+==============================
+{content}
+==============================
+
+There are some additional information about the task:
+
+==============================
+{additional_info}
+==============================
+
+Following are the available workers, given in the format <ID>: <description>.
+
+==============================
+{child_nodes_info}
+==============================
+
+You must return the subtasks in the format of a numbered list within <tasks> tags, as shown below:
+
+<tasks>
+<task>Subtask 1</task>
+<task>Subtask 2</task>
+</tasks>
+
+Though it's not a must, you should try your best effort to make each subtask achievable for a worker. The tasks should be clear and concise.
+"""