Skip to content

Commit 0da409a

Browse files
committed
Auto-update documentation after merge
1 parent 1073a30 commit 0da409a

7 files changed

+52
-15
lines changed

docs/mintlify/reference/camel.interpreters.base.mdx

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,3 +60,12 @@ def execute_command(self, command: str):
6060
```
6161

6262
Executes a command in the interpreter.
63+
64+
**Parameters:**
65+
66+
- **command** (str): The command to execute.
67+
68+
**Returns:**
69+
70+
Tuple[str, str]: A tuple containing the stdout and stderr of the
71+
command execution.

docs/mintlify/reference/camel.interpreters.docker_interpreter.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ to ensure proper cleanup of Docker resources.
8989
### run
9090

9191
```python
92-
def run(self, code: str, code_type: str):
92+
def run(self, code: str, code_type: str = 'python'):
9393
```
9494

9595
Executes the given code in the container attached to the
@@ -98,7 +98,7 @@ interpreter, and captures the stdout and stderr streams.
9898
**Parameters:**
9999

100100
- **code** (str): The code string to execute.
101-
- **code_type** (str): The type of code to execute (e.g., 'python', 'bash').
101+
- **code_type** (str): The type of code to execute (e.g., 'python', 'bash'). (default: obj:`python`)
102102

103103
**Returns:**
104104

docs/mintlify/reference/camel.interpreters.e2b_interpreter.mdx

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,15 @@ interpreter is deleted.
4040
### run
4141

4242
```python
43-
def run(self, code: str, code_type: str):
43+
def run(self, code: str, code_type: str = 'python'):
4444
```
4545

4646
Executes the given code in the e2b sandbox.
4747

4848
**Parameters:**
4949

5050
- **code** (str): The code string to execute.
51-
- **code_type** (str): The type of code to execute (e.g., 'python', 'bash').
51+
- **code_type** (str): The type of code to execute (e.g., 'python', 'bash'). (default: obj:`python`)
5252

5353
**Returns:**
5454

@@ -82,4 +82,13 @@ Updates action space for *python* interpreter
8282
def execute_command(self, command: str):
8383
```
8484

85-
Execute a command can be used to resolve the dependency of the code.
85+
Execute a command can be used to resolve the dependency of the
86+
code.
87+
88+
**Parameters:**
89+
90+
- **command** (str): The command to execute.
91+
92+
**Returns:**
93+
94+
str: The output of the command.

docs/mintlify/reference/camel.interpreters.internal_python_interpreter.mdx

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ def __init__(
7070
### run
7171

7272
```python
73-
def run(self, code: str, code_type: str):
73+
def run(self, code: str, code_type: str = 'python'):
7474
```
7575

7676
Executes the given code with specified code type in the
@@ -87,7 +87,7 @@ any runtime error occurs during execution.
8787
**Parameters:**
8888

8989
- **code** (str): The python code to be executed.
90-
- **code_type** (str): The type of the code, which should be one of the supported code types (`python`, `py`, `python3`, `python2`).
90+
- **code_type** (str): The type of the code, which should be one of the supported code types (`python`, `py`, `python3`, `python2`). (default: obj:`python`)
9191

9292
**Returns:**
9393

@@ -281,3 +281,13 @@ def _get_value_from_state(self, key: str):
281281
```python
282282
def execute_command(self, command: str):
283283
```
284+
285+
Execute a command in the internal python interpreter.
286+
287+
**Parameters:**
288+
289+
- **command** (str): The command to execute.
290+
291+
**Returns:**
292+
293+
tuple: A tuple containing the stdout and stderr of the command.

docs/mintlify/reference/camel.interpreters.ipython_interpreter.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,15 +75,15 @@ Execute the code in the Jupyter kernel and return the result.
7575
### run
7676

7777
```python
78-
def run(self, code: str, code_type: str):
78+
def run(self, code: str, code_type: str = 'python'):
7979
```
8080

8181
Executes the given code in the Jupyter kernel.
8282

8383
**Parameters:**
8484

8585
- **code** (str): The code string to execute.
86-
- **code_type** (str): The type of code to execute (e.g., 'python', 'bash').
86+
- **code_type** (str): The type of code to execute (e.g., 'python', 'bash'). (default: obj:`python`)
8787

8888
**Returns:**
8989

docs/mintlify/reference/camel.interpreters.subprocess_interpreter.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,15 @@ def __init__(
4242
### run_file
4343

4444
```python
45-
def run_file(self, file: Path, code_type: str):
45+
def run_file(self, file: Path, code_type: str = 'python'):
4646
```
4747

4848
Executes a code file in a subprocess and captures its output.
4949

5050
**Parameters:**
5151

5252
- **file** (Path): The path object of the file to run.
53-
- **code_type** (str): The type of code to execute (e.g., 'python', 'bash').
53+
- **code_type** (str): The type of code to execute (e.g., 'python', 'bash'). (default: obj:`python`)
5454

5555
**Returns:**
5656

@@ -159,5 +159,5 @@ Executes a shell command in a subprocess and captures its output.
159159

160160
**Returns:**
161161

162-
str: A string containing the captured stdout and stderr of the
162+
tuple: A tuple containing the captured stdout and stderr of the
163163
executed command.

docs/mintlify/reference/camel.toolkits.code_execution.mdx

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,15 +39,15 @@ def __init__(
3939
### execute_code
4040

4141
```python
42-
def execute_code(self, code: str, code_type: str):
42+
def execute_code(self, code: str, code_type: str = 'python'):
4343
```
4444

4545
Execute a given code snippet.
4646

4747
**Parameters:**
4848

4949
- **code** (str): The input code to the Code Interpreter tool call.
50-
- **code_type** (str): The type of the code to be executed type node.js, python, etc.
50+
- **code_type** (str): The type of the code to be executed (e.g. node.js, python, etc). (default: obj:`python`)
5151

5252
**Returns:**
5353

@@ -61,7 +61,16 @@ Execute a given code snippet.
6161
def execute_command(self, command: str):
6262
```
6363

64-
Execute a command can be used to resolve the dependency of the code.
64+
Execute a command can be used to resolve the dependency of the
65+
code.
66+
67+
**Parameters:**
68+
69+
- **command** (str): The command to execute.
70+
71+
**Returns:**
72+
73+
Union[str, tuple[str, str]]: The output of the command.
6574

6675
<a id="camel.toolkits.code_execution.CodeExecutionToolkit.get_tools"></a>
6776

0 commit comments

Comments
 (0)