camel-ai 0.2.0__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.2.0'
+__version__ = '0.2.1'
 
 __all__ = [
     '__version__',

camel/agents/chat_agent.py

@@ -622,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/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/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/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.
+"""

camel/workforce/role_playing_worker.py

@@ -0,0 +1,181 @@
+# =========== 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 __future__ import annotations
+
+import ast
+from typing import Dict, List, Optional
+
+from colorama import Fore
+
+from camel.agents.chat_agent import ChatAgent
+from camel.messages.base import BaseMessage
+from camel.societies import RolePlaying
+from camel.tasks.task import Task, TaskState
+from camel.utils import print_text_animated
+from camel.workforce.prompts import (
+    ROLEPLAY_PROCESS_TASK_PROMPT,
+    ROLEPLAY_SUMMARIZE_PROMPT,
+)
+from camel.workforce.utils import TaskResult
+from camel.workforce.worker import Worker
+
+
+class RolePlayingWorker(Worker):
+    r"""A worker node that contains a role playing.
+
+    Args:
+        description (str): Description of the node.
+        assistant_role_name (str): The role name of the assistant agent.
+        user_role_name (str): The role name of the user agent.
+        assistant_agent_kwargs (Optional[Dict], optional): The keyword
+            arguments to initialize the assistant agent in the role playing,
+            like the model name, etc. Defaults to None.
+        user_agent_kwargs (Optional[Dict], optional): The keyword arguments to
+            initialize the user agent in the role playing, like the model name,
+            etc. Defaults to None.
+        chat_turn_limit (int, optional): The maximum number of chat turns in
+            the role playing. Defaults to 3.
+    """
+
+    def __init__(
+        self,
+        description: str,
+        assistant_role_name: str,
+        user_role_name: str,
+        assistant_agent_kwargs: Optional[Dict] = None,
+        user_agent_kwargs: Optional[Dict] = None,
+        chat_turn_limit: int = 3,
+    ) -> None:
+        super().__init__(description)
+        summ_sys_msg = BaseMessage.make_assistant_message(
+            role_name="Summarizer",
+            content="You are a good summarizer. You will be presented with "
+            "scenarios where an assistant and a user with specific roles "
+            "are trying to solve a task. Your job is summarizing the result "
+            "of the task based on the chat history.",
+        )
+        self.summarize_agent = ChatAgent(summ_sys_msg)
+        self.chat_turn_limit = chat_turn_limit
+        self.assistant_role_name = assistant_role_name
+        self.user_role_name = user_role_name
+        self.assistant_agent_kwargs = assistant_agent_kwargs
+        self.user_agent_kwargs = user_agent_kwargs
+
+    async def _process_task(
+        self, task: Task, dependencies: List[Task]
+    ) -> TaskState:
+        r"""Processes a task leveraging its dependencies through role-playing.
+
+        This method orchestrates a role-playing session between an AI
+        assistant and an AI user to process a given task. It initiates with a
+        generated prompt based on the task and its dependencies, conducts a
+        dialogue up to a specified chat turn limit, and then summarizes the
+        dialogue to determine the task's outcome.
+
+        Args:
+            task (Task): The task object to be processed, containing necessary
+                details like content and type.
+            dependencies (List[Task]): A list of task objects that the current
+                task depends on.
+
+        Returns:
+            TaskState: `TaskState.DONE` if processed successfully, otherwise
+                `TaskState.FAILED`.
+        """
+        dependency_tasks_info = self._get_dep_tasks_info(dependencies)
+        prompt = ROLEPLAY_PROCESS_TASK_PROMPT.format(
+            content=task.content,
+            dependency_task_info=dependency_tasks_info,
+            additional_info=task.additional_info,
+        )
+        role_play_session = RolePlaying(
+            assistant_role_name=self.assistant_role_name,
+            user_role_name=self.user_role_name,
+            assistant_agent_kwargs=self.assistant_agent_kwargs,
+            user_agent_kwargs=self.user_agent_kwargs,
+            task_prompt=prompt,
+            with_task_specify=False,
+        )
+        n = 0
+        input_msg = role_play_session.init_chat()
+        chat_history = []
+        while n < self.chat_turn_limit:
+            n += 1
+            assistant_response, user_response = role_play_session.step(
+                input_msg
+            )
+
+            if assistant_response.terminated:
+                reason = assistant_response.info['termination_reasons']
+                print(
+                    f"{Fore.GREEN}AI Assistant terminated. Reason: "
+                    f"{reason}.{Fore.RESET}"
+                )
+                break
+
+            if user_response.terminated:
+                reason = user_response.info['termination_reasons']
+                print(
+                    f"{Fore.GREEN}AI User terminated. Reason: {reason}."
+                    f"{Fore.RESET}"
+                )
+                break
+
+            print_text_animated(
+                f"{Fore.BLUE}AI User:\n\n{user_response.msg.content}"
+                f"{Fore.RESET}\n",
+                delay=0.005,
+            )
+            chat_history.append(f"AI User: {user_response.msg.content}")
+
+            print_text_animated(
+                f"{Fore.GREEN}AI Assistant:{Fore.RESET}", delay=0.005
+            )
+
+            for func_record in assistant_response.info['tool_calls']:
+                print(func_record)
+
+            print_text_animated(
+                f"\n{Fore.GREEN}{assistant_response.msg.content}"
+                f"{Fore.RESET}\n",
+                delay=0.005,
+            )
+            chat_history.append(
+                f"AI Assistant: {assistant_response.msg.content}"
+            )
+
+            if "CAMEL_TASK_DONE" in user_response.msg.content:
+                break
+
+            input_msg = assistant_response.msg
+
+        chat_history_str = "\n".join(chat_history)
+        prompt = ROLEPLAY_SUMMARIZE_PROMPT.format(
+            user_role=self.user_role_name,
+            assistant_role=self.assistant_role_name,
+            content=task.content,
+            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(req, output_schema=TaskResult)
+        result_dict = ast.literal_eval(response.msg.content)
+        task_result = TaskResult(**result_dict)
+        task.result = task_result.content
+
+        print(f"Task result: {task.result}\n")
+        return TaskState.DONE