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-bot6d904e95fd58
diff --git a/docs/mintlify/reference/camel.toolkits.base.mdx b/docs/mintlify/reference/camel.toolkits.base.mdx
index a04e0e32a..e9119fc56 100644
--- a/docs/mintlify/reference/camel.toolkits.base.mdx
+++ b/docs/mintlify/reference/camel.toolkits.base.mdx
@@ -1,5 +1,28 @@
<a id="camel.toolkits.base"></a>
+<a id="camel.toolkits.base.manual_timeout"></a>
+
+## manual_timeout
+
+```python
+def manual_timeout(func: F):
+```
+
+Decorator to mark a function as having manual timeout handling.
+
+Use this decorator on toolkit methods that manage their own timeout logic
+internally but don't have a `timeout` parameter in their signature.
+This prevents the automatic `with_timeout` wrapper from being applied
+by `BaseToolkit`.
+
+**Parameters:**
+
+- **func** (F): The function to mark as having manual timeout handling.
+
+**Returns:**
+
+ F: The same function with `_manual_timeout` attribute set to True.
+
<a id="camel.toolkits.base.BaseToolkit"></a>
## BaseToolkit
diff --git a/docs/mintlify/reference/camel.toolkits.terminal_toolkit.terminal_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.terminal_toolkit.terminal_toolkit.mdx
index b989fd8ef..c6cf847b6 100644
--- a/docs/mintlify/reference/camel.toolkits.terminal_toolkit.terminal_toolkit.mdx
+++ b/docs/mintlify/reference/camel.toolkits.terminal_toolkit.terminal_toolkit.mdx
@@ -164,7 +164,8 @@ def shell_exec(
self,
id: str,
command: str,
- block: bool = True
+ block: bool = True,
+ timeout: float = 20.0
):
```
@@ -174,7 +175,8 @@ Executes a shell command in blocking or non-blocking mode.
- **id** (str): A unique identifier for the command's session. This ID is used to interact with non-blocking processes.
- **command** (str): The shell command to execute.
-- **block** (bool, optional): Determines the execution mode. Defaults to True. If `True` (blocking mode), the function waits for the command to complete and returns the full output. Use this for most commands . If `False` (non-blocking mode), the function starts the command in the background. Use this only for interactive sessions or long-running tasks, or servers.
+- **block** (bool, optional): Determines the execution mode. Defaults to True. If `True` (blocking mode), the function waits for the command to complete and returns the full output. Use this for most commands. If `False` (non-blocking mode), the function starts the command in the background. Use this only for interactive sessions or long-running tasks, or servers.
+- **timeout** (float, optional): The maximum time in seconds to wait for the command to complete in blocking mode. If the command does not complete within the timeout, it will be restarted automatically as a non-blocking background session. You can then use `shell_view(id)` to check output, or `shell_kill_process(id)` to terminate it. This parameter is ignored in non-blocking mode. (default: :obj:`20`)
**Returns:**