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

camel-docs-bot3cb43b2a5e57
diff --git a/docs/mintlify/reference/camel.societies.workforce.utils.mdx b/docs/mintlify/reference/camel.societies.workforce.utils.mdx
index 6a57697f6..7fcd3639f 100644
--- a/docs/mintlify/reference/camel.societies.workforce.utils.mdx
+++ b/docs/mintlify/reference/camel.societies.workforce.utils.mdx
@@ -45,9 +45,26 @@ The result of task assignment for both single and batch assignments.
## check_if_running
```python
-def check_if_running(running: bool):
+def check_if_running(
+ running: bool,
+ max_retries: int = 3,
+ retry_delay: float = 1.0,
+ handle_exceptions: bool = False
+):
```
+Check if the workforce is (not) running, specified by the boolean
+value. Provides fault tolerance through automatic retries and exception
+handling.
+
+**Parameters:**
+
+- **running** (bool): Expected running state (True or False).
+- **max_retries** (int, optional): Maximum number of retry attempts if the operation fails. Set to 0 to disable retries. (default: :obj:`3`)
+- **retry_delay** (float, optional): Delay in seconds between retry attempts. (default: :obj:`1.0`)
+- **handle_exceptions** (bool, optional): If True, catch and log exceptions instead of propagating them. (default: :obj:`False`)
+
**Raises:**
-- **RuntimeError**: If the workforce is not in the expected status.
+- **RuntimeError**: If the workforce is not in the expected status and
+- **Exception**: Any exception raised by the decorated function if
diff --git a/docs/mintlify/reference/camel.societies.workforce.workforce.mdx b/docs/mintlify/reference/camel.societies.workforce.workforce.mdx
index 66d82c682..327d01972 100644
--- a/docs/mintlify/reference/camel.societies.workforce.workforce.mdx
+++ b/docs/mintlify/reference/camel.societies.workforce.workforce.mdx
@@ -105,26 +105,6 @@ def _decompose_task(self, task: Task):
List[Task]: The subtasks.
-<a id="camel.societies.workforce.workforce.Workforce.process_task"></a>
-
-### process_task
-
-```python
-def process_task(self, task: Task):
-```
-
-The main entry point for the workforce to process a task. It will
-start the workforce and all the child nodes under it, process the
-task provided and return the updated task.
-
-**Parameters:**
-
-- **task** (Task): The task to be processed.
-
-**Returns:**
-
- Task: The updated task.
-
<a id="camel.societies.workforce.workforce.Workforce.add_single_agent_worker"></a>
### add_single_agent_worker
diff --git a/docs/mintlify/reference/camel.tasks.task.mdx b/docs/mintlify/reference/camel.tasks.task.mdx
index 0ddd042a3..f5a3e0e2a 100644
--- a/docs/mintlify/reference/camel.tasks.task.mdx
+++ b/docs/mintlify/reference/camel.tasks.task.mdx
@@ -251,7 +251,7 @@ Get task result to a string.
```python
def decompose(
self,
- agent: ChatAgent,
+ agent: 'ChatAgent',
prompt: Optional[str] = None,
task_parser: Callable[[str, str], List['Task']] = parse_response
):
@@ -277,7 +277,7 @@ generation and planner of agent.
```python
def compose(
self,
- agent: ChatAgent,
+ agent: 'ChatAgent',
template: TextPrompt = TASK_COMPOSE_PROMPT,
result_parser: Optional[Callable[[str], str]] = None
):
@@ -412,7 +412,7 @@ self.tasks and self.task_map will be updated by the input tasks.
def evolve(
self,
task: Task,
- agent: ChatAgent,
+ agent: 'ChatAgent',
template: Optional[TextPrompt] = None,
task_parser: Optional[Callable[[str, str], List[Task]]] = None
):
diff --git a/docs/mintlify/reference/camel.toolkits.code_execution.mdx b/docs/mintlify/reference/camel.toolkits.code_execution.mdx
index 91544e5b1..e60cda8b9 100644
--- a/docs/mintlify/reference/camel.toolkits.code_execution.mdx
+++ b/docs/mintlify/reference/camel.toolkits.code_execution.mdx
@@ -62,7 +62,7 @@ def execute_command(self, command: str):
```
Execute a command can be used to resolve the dependency of the
-code.
+code. Useful if there's dependency issues when you try to execute code.
**Parameters:**