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

GitHub Action0da409a2a937
diff --git a/docs/mintlify/reference/camel.interpreters.base.mdx b/docs/mintlify/reference/camel.interpreters.base.mdx
index abbe97589..7d45a8875 100644
--- a/docs/mintlify/reference/camel.interpreters.base.mdx
+++ b/docs/mintlify/reference/camel.interpreters.base.mdx
@@ -60,3 +60,12 @@ def execute_command(self, command: str):
```
Executes a command in the interpreter.
+
+**Parameters:**
+
+- **command** (str): The command to execute.
+
+**Returns:**
+
+ Tuple[str, str]: A tuple containing the stdout and stderr of the
+command execution.
diff --git a/docs/mintlify/reference/camel.interpreters.docker_interpreter.mdx b/docs/mintlify/reference/camel.interpreters.docker_interpreter.mdx
index 721524270..9ca9fdd6a 100644
--- a/docs/mintlify/reference/camel.interpreters.docker_interpreter.mdx
+++ b/docs/mintlify/reference/camel.interpreters.docker_interpreter.mdx
@@ -89,7 +89,7 @@ to ensure proper cleanup of Docker resources.
### run
```python
-def run(self, code: str, code_type: str):
+def run(self, code: str, code_type: str = 'python'):
```
Executes the given code in the container attached to the
@@ -98,7 +98,7 @@ interpreter, and captures the stdout and stderr streams.
**Parameters:**
- **code** (str): The code string to execute.
-- **code_type** (str): The type of code to execute (e.g., 'python', 'bash').
+- **code_type** (str): The type of code to execute (e.g., 'python', 'bash'). (default: obj:`python`)
**Returns:**
diff --git a/docs/mintlify/reference/camel.interpreters.e2b_interpreter.mdx b/docs/mintlify/reference/camel.interpreters.e2b_interpreter.mdx
index 6f6962652..ef95f6974 100644
--- a/docs/mintlify/reference/camel.interpreters.e2b_interpreter.mdx
+++ b/docs/mintlify/reference/camel.interpreters.e2b_interpreter.mdx
@@ -40,7 +40,7 @@ interpreter is deleted.
### run
```python
-def run(self, code: str, code_type: str):
+def run(self, code: str, code_type: str = 'python'):
```
Executes the given code in the e2b sandbox.
@@ -48,7 +48,7 @@ Executes the given code in the e2b sandbox.
**Parameters:**
- **code** (str): The code string to execute.
-- **code_type** (str): The type of code to execute (e.g., 'python', 'bash').
+- **code_type** (str): The type of code to execute (e.g., 'python', 'bash'). (default: obj:`python`)
**Returns:**
@@ -82,4 +82,13 @@ Updates action space for *python* interpreter
def execute_command(self, command: str):
```
-Execute a command can be used to resolve the dependency of the code.
+Execute a command can be used to resolve the dependency of the
+code.
+
+**Parameters:**
+
+- **command** (str): The command to execute.
+
+**Returns:**
+
+ str: The output of the command.
diff --git a/docs/mintlify/reference/camel.interpreters.internal_python_interpreter.mdx b/docs/mintlify/reference/camel.interpreters.internal_python_interpreter.mdx
index 35c8bc7f3..6eed40980 100644
--- a/docs/mintlify/reference/camel.interpreters.internal_python_interpreter.mdx
+++ b/docs/mintlify/reference/camel.interpreters.internal_python_interpreter.mdx
@@ -70,7 +70,7 @@ def __init__(
### run
```python
-def run(self, code: str, code_type: str):
+def run(self, code: str, code_type: str = 'python'):
```
Executes the given code with specified code type in the
@@ -87,7 +87,7 @@ any runtime error occurs during execution.
**Parameters:**
- **code** (str): The python code to be executed.
-- **code_type** (str): The type of the code, which should be one of the supported code types (`python`, `py`, `python3`, `python2`).
+- **code_type** (str): The type of the code, which should be one of the supported code types (`python`, `py`, `python3`, `python2`). (default: obj:`python`)
**Returns:**
@@ -281,3 +281,13 @@ def _get_value_from_state(self, key: str):
```python
def execute_command(self, command: str):
```
+
+Execute a command in the internal python interpreter.
+
+**Parameters:**
+
+- **command** (str): The command to execute.
+
+**Returns:**
+
+ tuple: A tuple containing the stdout and stderr of the command.
diff --git a/docs/mintlify/reference/camel.interpreters.ipython_interpreter.mdx b/docs/mintlify/reference/camel.interpreters.ipython_interpreter.mdx
index 4d759e908..6ca165c19 100644
--- a/docs/mintlify/reference/camel.interpreters.ipython_interpreter.mdx
+++ b/docs/mintlify/reference/camel.interpreters.ipython_interpreter.mdx
@@ -75,7 +75,7 @@ Execute the code in the Jupyter kernel and return the result.
### run
```python
-def run(self, code: str, code_type: str):
+def run(self, code: str, code_type: str = 'python'):
```
Executes the given code in the Jupyter kernel.
@@ -83,7 +83,7 @@ Executes the given code in the Jupyter kernel.
**Parameters:**
- **code** (str): The code string to execute.
-- **code_type** (str): The type of code to execute (e.g., 'python', 'bash').
+- **code_type** (str): The type of code to execute (e.g., 'python', 'bash'). (default: obj:`python`)
**Returns:**
diff --git a/docs/mintlify/reference/camel.interpreters.subprocess_interpreter.mdx b/docs/mintlify/reference/camel.interpreters.subprocess_interpreter.mdx
index 60014ba42..0659c754f 100644
--- a/docs/mintlify/reference/camel.interpreters.subprocess_interpreter.mdx
+++ b/docs/mintlify/reference/camel.interpreters.subprocess_interpreter.mdx
@@ -42,7 +42,7 @@ def __init__(
### run_file
```python
-def run_file(self, file: Path, code_type: str):
+def run_file(self, file: Path, code_type: str = 'python'):
```
Executes a code file in a subprocess and captures its output.
@@ -50,7 +50,7 @@ Executes a code file in a subprocess and captures its output.
**Parameters:**
- **file** (Path): The path object of the file to run.
-- **code_type** (str): The type of code to execute (e.g., 'python', 'bash').
+- **code_type** (str): The type of code to execute (e.g., 'python', 'bash'). (default: obj:`python`)
**Returns:**
@@ -159,5 +159,5 @@ Executes a shell command in a subprocess and captures its output.
**Returns:**
- str: A string containing the captured stdout and stderr of the
+ tuple: A tuple containing the captured stdout and stderr of the
executed command.
diff --git a/docs/mintlify/reference/camel.toolkits.code_execution.mdx b/docs/mintlify/reference/camel.toolkits.code_execution.mdx
index dfe4a1f9c..91544e5b1 100644
--- a/docs/mintlify/reference/camel.toolkits.code_execution.mdx
+++ b/docs/mintlify/reference/camel.toolkits.code_execution.mdx
@@ -39,7 +39,7 @@ def __init__(
### execute_code
```python
-def execute_code(self, code: str, code_type: str):
+def execute_code(self, code: str, code_type: str = 'python'):
```
Execute a given code snippet.
@@ -47,7 +47,7 @@ Execute a given code snippet.
**Parameters:**
- **code** (str): The input code to the Code Interpreter tool call.
-- **code_type** (str): The type of the code to be executed type node.js, python, etc.
+- **code_type** (str): The type of the code to be executed (e.g. node.js, python, etc). (default: obj:`python`)
**Returns:**
@@ -61,7 +61,16 @@ Execute a given code snippet.
def execute_command(self, command: str):
```
-Execute a command can be used to resolve the dependency of the code.
+Execute a command can be used to resolve the dependency of the
+code.
+
+**Parameters:**
+
+- **command** (str): The command to execute.
+
+**Returns:**
+
+ Union[str, tuple[str, str]]: The output of the command.
<a id="camel.toolkits.code_execution.CodeExecutionToolkit.get_tools"></a>