deepset-ai/haystack
1
0
Fork 0
mirror of https://github.com/deepset-ai/haystack.git synced 2026-10-12 02:12:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: sync Core Integrations API reference (e2b) on Docusaurus (#13192)

Browse Source 
Co-authored-by: anakin87 <[email protected]>
This commit is contained in:
Haystack Bot
2026-10-09 08:28:23 +00:00
committed by GitHub
co-authored by anakin87
parent ccc08e85c7
commit e2ebcc1e53
19 changed files with 1216 additions and 171 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs-website/reference/integrations-api/e2b.md
+64 -9
View File
@@ -44,6 +44,22 @@ Create a RunBashCommandTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance that will execute commands.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -98,15 +114,6 @@ agent = Agent(
)
```
Lifecycle is handled automatically by the Agent's pipeline. If you use the
tools standalone, call :meth:`warm_up` before the first tool invocation:
```python
sandbox.warm_up()
# ... use tools ...
sandbox.close()
```
#### __init__
```python
@@ -226,6 +233,22 @@ Create a ListDirectoryTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to list directories from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -274,6 +297,22 @@ Create a ReadFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to read files from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -401,6 +440,22 @@ Create a WriteFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to write files to.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
docs-website/reference_versioned_docs/version-2.18/integrations-api/e2b.md
+64 -9
View File
@@ -44,6 +44,22 @@ Create a RunBashCommandTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance that will execute commands.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -98,15 +114,6 @@ agent = Agent(
)
```
Lifecycle is handled automatically by the Agent's pipeline. If you use the
tools standalone, call :meth:`warm_up` before the first tool invocation:
```python
sandbox.warm_up()
# ... use tools ...
sandbox.close()
```
#### __init__
```python
@@ -226,6 +233,22 @@ Create a ListDirectoryTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to list directories from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -274,6 +297,22 @@ Create a ReadFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to read files from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -401,6 +440,22 @@ Create a WriteFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to write files to.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
docs-website/reference_versioned_docs/version-2.19/integrations-api/e2b.md
+64 -9
View File
@@ -44,6 +44,22 @@ Create a RunBashCommandTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance that will execute commands.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -98,15 +114,6 @@ agent = Agent(
)
```
Lifecycle is handled automatically by the Agent's pipeline. If you use the
tools standalone, call :meth:`warm_up` before the first tool invocation:
```python
sandbox.warm_up()
# ... use tools ...
sandbox.close()
```
#### __init__
```python
@@ -226,6 +233,22 @@ Create a ListDirectoryTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to list directories from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -274,6 +297,22 @@ Create a ReadFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to read files from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -401,6 +440,22 @@ Create a WriteFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to write files to.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
docs-website/reference_versioned_docs/version-2.20/integrations-api/e2b.md
+64 -9
View File
@@ -44,6 +44,22 @@ Create a RunBashCommandTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance that will execute commands.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -98,15 +114,6 @@ agent = Agent(
)
```
Lifecycle is handled automatically by the Agent's pipeline. If you use the
tools standalone, call :meth:`warm_up` before the first tool invocation:
```python
sandbox.warm_up()
# ... use tools ...
sandbox.close()
```
#### __init__
```python
@@ -226,6 +233,22 @@ Create a ListDirectoryTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to list directories from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -274,6 +297,22 @@ Create a ReadFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to read files from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -401,6 +440,22 @@ Create a WriteFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to write files to.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
docs-website/reference_versioned_docs/version-2.21/integrations-api/e2b.md
+64 -9
View File
@@ -44,6 +44,22 @@ Create a RunBashCommandTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance that will execute commands.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -98,15 +114,6 @@ agent = Agent(
)
```
Lifecycle is handled automatically by the Agent's pipeline. If you use the
tools standalone, call :meth:`warm_up` before the first tool invocation:
```python
sandbox.warm_up()
# ... use tools ...
sandbox.close()
```
#### __init__
```python
@@ -226,6 +233,22 @@ Create a ListDirectoryTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to list directories from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -274,6 +297,22 @@ Create a ReadFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to read files from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -401,6 +440,22 @@ Create a WriteFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to write files to.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
docs-website/reference_versioned_docs/version-2.22/integrations-api/e2b.md
+64 -9
View File
@@ -44,6 +44,22 @@ Create a RunBashCommandTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance that will execute commands.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -98,15 +114,6 @@ agent = Agent(
)
```
Lifecycle is handled automatically by the Agent's pipeline. If you use the
tools standalone, call :meth:`warm_up` before the first tool invocation:
```python
sandbox.warm_up()
# ... use tools ...
sandbox.close()
```
#### __init__
```python
@@ -226,6 +233,22 @@ Create a ListDirectoryTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to list directories from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -274,6 +297,22 @@ Create a ReadFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to read files from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -401,6 +440,22 @@ Create a WriteFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to write files to.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
docs-website/reference_versioned_docs/version-2.23/integrations-api/e2b.md
+64 -9
View File
@@ -44,6 +44,22 @@ Create a RunBashCommandTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance that will execute commands.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -98,15 +114,6 @@ agent = Agent(
)
```
Lifecycle is handled automatically by the Agent's pipeline. If you use the
tools standalone, call :meth:`warm_up` before the first tool invocation:
```python
sandbox.warm_up()
# ... use tools ...
sandbox.close()
```
#### __init__
```python
@@ -226,6 +233,22 @@ Create a ListDirectoryTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to list directories from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -274,6 +297,22 @@ Create a ReadFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to read files from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -401,6 +440,22 @@ Create a WriteFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to write files to.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
docs-website/reference_versioned_docs/version-2.24/integrations-api/e2b.md
+64 -9
View File
@@ -44,6 +44,22 @@ Create a RunBashCommandTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance that will execute commands.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -98,15 +114,6 @@ agent = Agent(
)
```
Lifecycle is handled automatically by the Agent's pipeline. If you use the
tools standalone, call :meth:`warm_up` before the first tool invocation:
```python
sandbox.warm_up()
# ... use tools ...
sandbox.close()
```
#### __init__
```python
@@ -226,6 +233,22 @@ Create a ListDirectoryTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to list directories from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -274,6 +297,22 @@ Create a ReadFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to read files from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -401,6 +440,22 @@ Create a WriteFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to write files to.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
docs-website/reference_versioned_docs/version-2.25/integrations-api/e2b.md
+64 -9
View File
@@ -44,6 +44,22 @@ Create a RunBashCommandTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance that will execute commands.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -98,15 +114,6 @@ agent = Agent(
)
```
Lifecycle is handled automatically by the Agent's pipeline. If you use the
tools standalone, call :meth:`warm_up` before the first tool invocation:
```python
sandbox.warm_up()
# ... use tools ...
sandbox.close()
```
#### __init__
```python
@@ -226,6 +233,22 @@ Create a ListDirectoryTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to list directories from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -274,6 +297,22 @@ Create a ReadFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to read files from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -401,6 +440,22 @@ Create a WriteFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to write files to.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
docs-website/reference_versioned_docs/version-2.26/integrations-api/e2b.md
+64 -9
View File
@@ -44,6 +44,22 @@ Create a RunBashCommandTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance that will execute commands.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -98,15 +114,6 @@ agent = Agent(
)
```
Lifecycle is handled automatically by the Agent's pipeline. If you use the
tools standalone, call :meth:`warm_up` before the first tool invocation:
```python
sandbox.warm_up()
# ... use tools ...
sandbox.close()
```
#### __init__
```python
@@ -226,6 +233,22 @@ Create a ListDirectoryTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to list directories from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -274,6 +297,22 @@ Create a ReadFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to read files from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -401,6 +440,22 @@ Create a WriteFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to write files to.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
docs-website/reference_versioned_docs/version-2.27/integrations-api/e2b.md
+64 -9
View File
@@ -44,6 +44,22 @@ Create a RunBashCommandTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance that will execute commands.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -98,15 +114,6 @@ agent = Agent(
)
```
Lifecycle is handled automatically by the Agent's pipeline. If you use the
tools standalone, call :meth:`warm_up` before the first tool invocation:
```python
sandbox.warm_up()
# ... use tools ...
sandbox.close()
```
#### __init__
```python
@@ -226,6 +233,22 @@ Create a ListDirectoryTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to list directories from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -274,6 +297,22 @@ Create a ReadFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to read files from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -401,6 +440,22 @@ Create a WriteFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to write files to.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
docs-website/reference_versioned_docs/version-2.28/integrations-api/e2b.md
+64 -9
View File
@@ -44,6 +44,22 @@ Create a RunBashCommandTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance that will execute commands.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -98,15 +114,6 @@ agent = Agent(
)
```
Lifecycle is handled automatically by the Agent's pipeline. If you use the
tools standalone, call :meth:`warm_up` before the first tool invocation:
```python
sandbox.warm_up()
# ... use tools ...
sandbox.close()
```
#### __init__
```python
@@ -226,6 +233,22 @@ Create a ListDirectoryTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to list directories from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -274,6 +297,22 @@ Create a ReadFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to read files from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -401,6 +440,22 @@ Create a WriteFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to write files to.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
docs-website/reference_versioned_docs/version-2.29/integrations-api/e2b.md
+64 -9
View File
@@ -44,6 +44,22 @@ Create a RunBashCommandTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance that will execute commands.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -98,15 +114,6 @@ agent = Agent(
)
```
Lifecycle is handled automatically by the Agent's pipeline. If you use the
tools standalone, call :meth:`warm_up` before the first tool invocation:
```python
sandbox.warm_up()
# ... use tools ...
sandbox.close()
```
#### __init__
```python
@@ -226,6 +233,22 @@ Create a ListDirectoryTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to list directories from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -274,6 +297,22 @@ Create a ReadFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to read files from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -401,6 +440,22 @@ Create a WriteFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to write files to.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
docs-website/reference_versioned_docs/version-2.30/integrations-api/e2b.md
+64 -9
View File
@@ -44,6 +44,22 @@ Create a RunBashCommandTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance that will execute commands.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -98,15 +114,6 @@ agent = Agent(
)
```
Lifecycle is handled automatically by the Agent's pipeline. If you use the
tools standalone, call :meth:`warm_up` before the first tool invocation:
```python
sandbox.warm_up()
# ... use tools ...
sandbox.close()
```
#### __init__
```python
@@ -226,6 +233,22 @@ Create a ListDirectoryTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to list directories from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -274,6 +297,22 @@ Create a ReadFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to read files from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -401,6 +440,22 @@ Create a WriteFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to write files to.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
docs-website/reference_versioned_docs/version-2.31/integrations-api/e2b.md
+64 -9
View File
@@ -44,6 +44,22 @@ Create a RunBashCommandTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance that will execute commands.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -98,15 +114,6 @@ agent = Agent(
)
```
Lifecycle is handled automatically by the Agent's pipeline. If you use the
tools standalone, call :meth:`warm_up` before the first tool invocation:
```python
sandbox.warm_up()
# ... use tools ...
sandbox.close()
```
#### __init__
```python
@@ -226,6 +233,22 @@ Create a ListDirectoryTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to list directories from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -274,6 +297,22 @@ Create a ReadFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to read files from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -401,6 +440,22 @@ Create a WriteFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to write files to.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
docs-website/reference_versioned_docs/version-3.0/integrations-api/e2b.md
+64 -9
View File
@@ -44,6 +44,22 @@ Create a RunBashCommandTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance that will execute commands.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -98,15 +114,6 @@ agent = Agent(
)
```
Lifecycle is handled automatically by the Agent's pipeline. If you use the
tools standalone, call :meth:`warm_up` before the first tool invocation:
```python
sandbox.warm_up()
# ... use tools ...
sandbox.close()
```
#### __init__
```python
@@ -226,6 +233,22 @@ Create a ListDirectoryTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to list directories from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -274,6 +297,22 @@ Create a ReadFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to read files from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -401,6 +440,22 @@ Create a WriteFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to write files to.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
docs-website/reference_versioned_docs/version-3.1/integrations-api/e2b.md
+64 -9
View File
@@ -44,6 +44,22 @@ Create a RunBashCommandTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance that will execute commands.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -98,15 +114,6 @@ agent = Agent(
)
```
Lifecycle is handled automatically by the Agent's pipeline. If you use the
tools standalone, call :meth:`warm_up` before the first tool invocation:
```python
sandbox.warm_up()
# ... use tools ...
sandbox.close()
```
#### __init__
```python
@@ -226,6 +233,22 @@ Create a ListDirectoryTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to list directories from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -274,6 +297,22 @@ Create a ReadFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to read files from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -401,6 +440,22 @@ Create a WriteFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to write files to.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
docs-website/reference_versioned_docs/version-3.2/integrations-api/e2b.md
+64 -9
View File
@@ -44,6 +44,22 @@ Create a RunBashCommandTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance that will execute commands.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -98,15 +114,6 @@ agent = Agent(
)
```
Lifecycle is handled automatically by the Agent's pipeline. If you use the
tools standalone, call :meth:`warm_up` before the first tool invocation:
```python
sandbox.warm_up()
# ... use tools ...
sandbox.close()
```
#### __init__
```python
@@ -226,6 +233,22 @@ Create a ListDirectoryTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to list directories from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -274,6 +297,22 @@ Create a ReadFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to read files from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -401,6 +440,22 @@ Create a WriteFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to write files to.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
docs-website/reference_versioned_docs/version-3.3/integrations-api/e2b.md
+64 -9
View File
@@ -44,6 +44,22 @@ Create a RunBashCommandTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance that will execute commands.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -98,15 +114,6 @@ agent = Agent(
)
```
Lifecycle is handled automatically by the Agent's pipeline. If you use the
tools standalone, call :meth:`warm_up` before the first tool invocation:
```python
sandbox.warm_up()
# ... use tools ...
sandbox.close()
```
#### __init__
```python
@@ -226,6 +233,22 @@ Create a ListDirectoryTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to list directories from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -274,6 +297,22 @@ Create a ReadFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to read files from.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python
@@ -401,6 +440,22 @@ Create a WriteFileTool.
- **sandbox** (<code>E2BSandbox</code>) – The :class:`E2BSandbox` instance to write files to.
#### warm_up
```python
warm_up() -> None
```
Start the sandbox if needed.
#### close
```python
close() -> None
```
Close the sandbox.
#### to_dict
```python