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-bot22e195a332df
diff --git a/docs/reference/camel.agents.chat_agent.md b/docs/reference/camel.agents.chat_agent.md
index 6bb096f5b..186d0f2c1 100644
--- a/docs/reference/camel.agents.chat_agent.md
+++ b/docs/reference/camel.agents.chat_agent.md
@@ -24,6 +24,7 @@ Class for managing conversations of CAMEL Chat Agents.
- **agent_id** (str, optional): The ID of the agent. If not provided, a random UUID will be generated. (default: :obj:`None`)
- **stop_event** (Optional[threading.Event], optional): Event to signal termination of the agent's operation. When set, the agent will terminate its execution. (default: :obj:`None`)
- **mask_tool_output** (Optional[bool]): Whether to return a sanitized placeholder instead of the raw tool output. (default: :obj:`False`)
+- **pause_event** (Optional[asyncio.Event]): Event to signal pause of the agent's operation. When clear, the agent will pause its execution. (default: :obj:`None`)
<a id="camel.agents.chat_agent.ChatAgent.__init__"></a>
@@ -45,7 +46,8 @@ def __init__(
max_iteration: Optional[int] = None,
agent_id: Optional[str] = None,
stop_event: Optional[threading.Event] = None,
- mask_tool_output: bool = False
+ mask_tool_output: bool = False,
+ pause_event: Optional[asyncio.Event] = None
):
```
diff --git a/docs/reference/camel.societies.workforce.workforce.md b/docs/reference/camel.societies.workforce.workforce.md
index ef16e1b5b..d4229571f 100644
--- a/docs/reference/camel.societies.workforce.workforce.md
+++ b/docs/reference/camel.societies.workforce.workforce.md
@@ -92,6 +92,30 @@ def __init__(
):
```
+<a id="camel.societies.workforce.workforce.Workforce._attach_pause_event_to_agent"></a>
+
+### _attach_pause_event_to_agent
+
+```python
+def _attach_pause_event_to_agent(self, agent: ChatAgent):
+```
+
+Ensure the given ChatAgent shares this workforce's pause_event.
+
+If the agent already has a different pause_event we overwrite it and
+emit a debug log (it is unlikely an agent needs multiple independent
+pause controls once managed by this workforce).
+
+<a id="camel.societies.workforce.workforce.Workforce._ensure_pause_event_in_kwargs"></a>
+
+### _ensure_pause_event_in_kwargs
+
+```python
+def _ensure_pause_event_in_kwargs(self, kwargs: Optional[Dict]):
+```
+
+Insert pause_event into kwargs dict for ChatAgent construction.
+
<a id="camel.societies.workforce.workforce.Workforce.__repr__"></a>
### __repr__