Skip to content

armgit / camel

Public Imported from GitHub
0

🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org

Auto-update documentation after merge [skip ci]

camel-docs-bot982543e5d892
diff --git a/docs/mintlify/reference/camel.messages.base.mdx b/docs/mintlify/reference/camel.messages.base.mdx
index 4d31de117..f5e71431d 100644
--- a/docs/mintlify/reference/camel.messages.base.mdx
+++ b/docs/mintlify/reference/camel.messages.base.mdx
@@ -17,7 +17,7 @@ Base class for message objects used in CAMEL chat system.
- **meta_dict** (Optional[Dict[str, Any]]): Additional metadata dictionary for the message.
- **content** (str): The content of the message.
- **video_bytes** (Optional[bytes]): Optional bytes of a video associated with the message. (default: :obj:`None`)
-- **image_list** (Optional[List[Image.Image]]): Optional list of PIL Image objects associated with the message. (default: :obj:`None`)
+- **image_list** (Optional[List[Union[Image.Image, str]]]): Optional list of PIL Image objects or image URLs (strings) associated with the message. (default: :obj:`None`)
- **image_detail** (`Literal["auto", "low", "high"]`): Detail level of the images associated with the message. (default: :obj:`auto`)
- **video_detail** (`Literal["auto", "low", "high"]`): Detail level of the videos associated with the message. (default: :obj:`auto`)
- **parsed**: Optional[Union[Type[BaseModel], dict]]: Optional object which is parsed from the content. (default: :obj:`None`)
@@ -33,7 +33,7 @@ def make_user_message(
content: str,
meta_dict: Optional[Dict[str, str]] = None,
video_bytes: Optional[bytes] = None,
- image_list: Optional[List[Image.Image]] = None,
+ image_list: Optional[List[Union[Image.Image, str]]] = None,
image_detail: Union[OpenAIVisionDetailType, str] = OpenAIVisionDetailType.AUTO,
video_detail: Union[OpenAIVisionDetailType, str] = OpenAIVisionDetailType.LOW
):
@@ -47,7 +47,7 @@ Create a new user message.
- **content** (str): The content of the message.
- **meta_dict** (Optional[Dict[str, str]]): Additional metadata dictionary for the message.
- **video_bytes** (Optional[bytes]): Optional bytes of a video associated with the message.
-- **image_list** (Optional[List[Image.Image]]): Optional list of PIL Image objects associated with the message.
+- **image_list** (Optional[List[Union[Image.Image, str]]]): Optional list of PIL Image objects or image URLs (strings) associated with the message.
- **image_detail** (Union[OpenAIVisionDetailType, str]): Detail level of the images associated with the message.
- **video_detail** (Union[OpenAIVisionDetailType, str]): Detail level of the videos associated with the message.
@@ -66,7 +66,7 @@ def make_assistant_message(
content: str,
meta_dict: Optional[Dict[str, str]] = None,
video_bytes: Optional[bytes] = None,
- image_list: Optional[List[Image.Image]] = None,
+ image_list: Optional[List[Union[Image.Image, str]]] = None,
image_detail: Union[OpenAIVisionDetailType, str] = OpenAIVisionDetailType.AUTO,
video_detail: Union[OpenAIVisionDetailType, str] = OpenAIVisionDetailType.LOW
):
@@ -80,7 +80,7 @@ Create a new assistant message.
- **content** (str): The content of the message.
- **meta_dict** (Optional[Dict[str, str]]): Additional metadata dictionary for the message.
- **video_bytes** (Optional[bytes]): Optional bytes of a video associated with the message.
-- **image_list** (Optional[List[Image.Image]]): Optional list of PIL Image objects associated with the message.
+- **image_list** (Optional[List[Union[Image.Image, str]]]): Optional list of PIL Image objects or image URLs (strings) associated with the message.
- **image_detail** (Union[OpenAIVisionDetailType, str]): Detail level of the images associated with the message.
- **video_detail** (Union[OpenAIVisionDetailType, str]): Detail level of the videos associated with the message.
diff --git a/docs/mintlify/reference/camel.societies.workforce.workforce.mdx b/docs/mintlify/reference/camel.societies.workforce.workforce.mdx
index 3a7e3efe2..22a28def8 100644
--- a/docs/mintlify/reference/camel.societies.workforce.workforce.mdx
+++ b/docs/mintlify/reference/camel.societies.workforce.workforce.mdx
@@ -301,6 +301,22 @@ yet been started. In the latter case we simply mark the stop flag so
that the loop (when it eventually starts) will exit immediately after
initialisation.
+<a id="camel.societies.workforce.workforce.Workforce.skip_gracefully"></a>
+
+### skip_gracefully
+
+```python
+def skip_gracefully(self):
+```
+
+Request workforce to skip current pending tasks and move to next
+main task from the queue. If no main tasks exist, acts like
+stop_gracefully.
+
+This method clears the current pending subtasks and moves to the next
+main task in the queue if available. Works both when the internal
+event-loop is alive and when it has not yet been started.
+
<a id="camel.societies.workforce.workforce.Workforce.save_snapshot"></a>
### save_snapshot
@@ -357,6 +373,66 @@ Modify the content of a pending task.
```python
def add_task(
+ self,
+ content: str,
+ task_id: Optional[str] = None,
+ additional_info: Optional[Dict[str, Any]] = None,
+ as_subtask: bool = False,
+ insert_position: int = -1
+):
+```
+
+Add a new task to the workforce.
+
+By default, this method adds a main task that will be decomposed into
+subtasks. Set `as_subtask=True` to add a task directly to the pending
+subtask queue without decomposition.
+
+**Parameters:**
+
+- **content** (str): The content of the task.
+- **task_id** (Optional[str], optional): Optional ID for the task. If not provided, a unique ID will be generated.
+- **additional_info** (Optional[Dict[str, Any]], optional): Optional additional metadata for the task.
+- **as_subtask** (bool, optional): If True, adds the task directly to the pending subtask queue. If False, adds as a main task that will be decomposed. Defaults to False.
+- **insert_position** (int, optional): Position to insert the task in the pending queue. Only applies when as_subtask=True. Defaults to -1 (append to end).
+
+**Returns:**
+
+ Task: The created task object.
+
+<a id="camel.societies.workforce.workforce.Workforce.add_main_task"></a>
+
+### add_main_task
+
+```python
+def add_main_task(
+ self,
+ content: str,
+ task_id: Optional[str] = None,
+ additional_info: Optional[Dict[str, Any]] = None
+):
+```
+
+Add a new main task that will be decomposed into subtasks.
+
+This is an alias for :meth:`add_task` with `as_subtask=False`.
+
+**Parameters:**
+
+- **content** (str): The content of the main task.
+- **task_id** (Optional[str], optional): Optional ID for the task.
+- **additional_info** (Optional[Dict[str, Any]], optional): Optional additional metadata.
+
+**Returns:**
+
+ Task: The created main task object.
+
+<a id="camel.societies.workforce.workforce.Workforce.add_subtask"></a>
+
+### add_subtask
+
+```python
+def add_subtask(
self,
content: str,
task_id: Optional[str] = None,
@@ -365,7 +441,20 @@ def add_task(
):
```
-Add a new task to the pending queue.
+Add a new subtask to the current pending queue.
+
+This is an alias for :meth:`add_task` with `as_subtask=True`.
+
+**Parameters:**
+
+- **content** (str): The content of the subtask.
+- **task_id** (Optional[str], optional): Optional ID for the task.
+- **additional_info** (Optional[Dict[str, Any]], optional): Optional additional metadata.
+- **insert_position** (int, optional): Position to insert the task. Defaults to -1 (append to end).
+
+**Returns:**
+
+ Task: The created subtask object.
<a id="camel.societies.workforce.workforce.Workforce.remove_task"></a>
@@ -375,7 +464,15 @@ Add a new task to the pending queue.
def remove_task(self, task_id: str):
```
-Remove a task from the pending queue.
+Remove a task from the pending queue or main task queue.
+
+**Parameters:**
+
+- **task_id** (str): The ID of the task to remove.
+
+**Returns:**
+
+ bool: True if task was found and removed, False otherwise.
<a id="camel.societies.workforce.workforce.Workforce.reorder_tasks"></a>
diff --git a/docs/mintlify/reference/camel.tasks.task.mdx b/docs/mintlify/reference/camel.tasks.task.mdx
index 749e0ff82..1f339eb61 100644
--- a/docs/mintlify/reference/camel.tasks.task.mdx
+++ b/docs/mintlify/reference/camel.tasks.task.mdx
@@ -119,7 +119,7 @@ Task is specific assignment that can be passed to a agent.
- **assigned_worker_id** (Optional[str]): The ID of the worker assigned to this task. (default: :obj:`None`)
- **dependencies** (List[Task]): The dependencies for the task. (default: :obj:`[]`)
- **additional_info** (Optional[Dict[str, Any]]): Additional information for the task. (default: :obj:`None`)
-- **image_list** (Optional[List[Image.Image]]): Optional list of PIL Image objects associated with the task. (default: :obj:`None`)
+- **image_list** (Optional[List[Union[Image.Image, str]]]): Optional list of PIL Image objects or image URLs (strings) associated with the task. (default: :obj:`None`)
- **image_detail** (`Literal["auto", "low", "high"]`): Detail level of the images associated with the task. (default: :obj:`auto`)
- **video_bytes** (Optional[bytes]): Optional bytes of a video associated with the task. (default: :obj:`None`)
- **video_detail** (`Literal["auto", "low", "high"]`): Detail level of the videos associated with the task. (default: :obj:`auto`)