From e2ebcc1e538f4698d1720354924365fff1db0a84 Mon Sep 17 00:00:00 2001 From: Haystack Bot <73523382+HaystackBot@users.noreply.github.com> Date: Fri, 9 Oct 2026 10:28:23 +0200 Subject: [PATCH] docs: sync Core Integrations API reference (e2b) on Docusaurus (#13192) Co-authored-by: anakin87 <44616784+anakin87@users.noreply.github.com> --- .../reference/integrations-api/e2b.md | 73 ++++++++++++++++--- .../version-2.18/integrations-api/e2b.md | 73 ++++++++++++++++--- .../version-2.19/integrations-api/e2b.md | 73 ++++++++++++++++--- .../version-2.20/integrations-api/e2b.md | 73 ++++++++++++++++--- .../version-2.21/integrations-api/e2b.md | 73 ++++++++++++++++--- .../version-2.22/integrations-api/e2b.md | 73 ++++++++++++++++--- .../version-2.23/integrations-api/e2b.md | 73 ++++++++++++++++--- .../version-2.24/integrations-api/e2b.md | 73 ++++++++++++++++--- .../version-2.25/integrations-api/e2b.md | 73 ++++++++++++++++--- .../version-2.26/integrations-api/e2b.md | 73 ++++++++++++++++--- .../version-2.27/integrations-api/e2b.md | 73 ++++++++++++++++--- .../version-2.28/integrations-api/e2b.md | 73 ++++++++++++++++--- .../version-2.29/integrations-api/e2b.md | 73 ++++++++++++++++--- .../version-2.30/integrations-api/e2b.md | 73 ++++++++++++++++--- .../version-2.31/integrations-api/e2b.md | 73 ++++++++++++++++--- .../version-3.0/integrations-api/e2b.md | 73 ++++++++++++++++--- .../version-3.1/integrations-api/e2b.md | 73 ++++++++++++++++--- .../version-3.2/integrations-api/e2b.md | 73 ++++++++++++++++--- .../version-3.3/integrations-api/e2b.md | 73 ++++++++++++++++--- 19 files changed, 1216 insertions(+), 171 deletions(-) diff --git a/docs-website/reference/integrations-api/e2b.md b/docs-website/reference/integrations-api/e2b.md index 88af83f295..16b0833617 100644 --- a/docs-website/reference/integrations-api/e2b.md +++ b/docs-website/reference/integrations-api/e2b.md @@ -44,6 +44,22 @@ Create a RunBashCommandTool. - **sandbox** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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 diff --git a/docs-website/reference_versioned_docs/version-2.18/integrations-api/e2b.md b/docs-website/reference_versioned_docs/version-2.18/integrations-api/e2b.md index 88af83f295..16b0833617 100644 --- a/docs-website/reference_versioned_docs/version-2.18/integrations-api/e2b.md +++ b/docs-website/reference_versioned_docs/version-2.18/integrations-api/e2b.md @@ -44,6 +44,22 @@ Create a RunBashCommandTool. - **sandbox** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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 diff --git a/docs-website/reference_versioned_docs/version-2.19/integrations-api/e2b.md b/docs-website/reference_versioned_docs/version-2.19/integrations-api/e2b.md index 88af83f295..16b0833617 100644 --- a/docs-website/reference_versioned_docs/version-2.19/integrations-api/e2b.md +++ b/docs-website/reference_versioned_docs/version-2.19/integrations-api/e2b.md @@ -44,6 +44,22 @@ Create a RunBashCommandTool. - **sandbox** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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 diff --git a/docs-website/reference_versioned_docs/version-2.20/integrations-api/e2b.md b/docs-website/reference_versioned_docs/version-2.20/integrations-api/e2b.md index 88af83f295..16b0833617 100644 --- a/docs-website/reference_versioned_docs/version-2.20/integrations-api/e2b.md +++ b/docs-website/reference_versioned_docs/version-2.20/integrations-api/e2b.md @@ -44,6 +44,22 @@ Create a RunBashCommandTool. - **sandbox** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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 diff --git a/docs-website/reference_versioned_docs/version-2.21/integrations-api/e2b.md b/docs-website/reference_versioned_docs/version-2.21/integrations-api/e2b.md index 88af83f295..16b0833617 100644 --- a/docs-website/reference_versioned_docs/version-2.21/integrations-api/e2b.md +++ b/docs-website/reference_versioned_docs/version-2.21/integrations-api/e2b.md @@ -44,6 +44,22 @@ Create a RunBashCommandTool. - **sandbox** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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 diff --git a/docs-website/reference_versioned_docs/version-2.22/integrations-api/e2b.md b/docs-website/reference_versioned_docs/version-2.22/integrations-api/e2b.md index 88af83f295..16b0833617 100644 --- a/docs-website/reference_versioned_docs/version-2.22/integrations-api/e2b.md +++ b/docs-website/reference_versioned_docs/version-2.22/integrations-api/e2b.md @@ -44,6 +44,22 @@ Create a RunBashCommandTool. - **sandbox** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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 diff --git a/docs-website/reference_versioned_docs/version-2.23/integrations-api/e2b.md b/docs-website/reference_versioned_docs/version-2.23/integrations-api/e2b.md index 88af83f295..16b0833617 100644 --- a/docs-website/reference_versioned_docs/version-2.23/integrations-api/e2b.md +++ b/docs-website/reference_versioned_docs/version-2.23/integrations-api/e2b.md @@ -44,6 +44,22 @@ Create a RunBashCommandTool. - **sandbox** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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 diff --git a/docs-website/reference_versioned_docs/version-2.24/integrations-api/e2b.md b/docs-website/reference_versioned_docs/version-2.24/integrations-api/e2b.md index 88af83f295..16b0833617 100644 --- a/docs-website/reference_versioned_docs/version-2.24/integrations-api/e2b.md +++ b/docs-website/reference_versioned_docs/version-2.24/integrations-api/e2b.md @@ -44,6 +44,22 @@ Create a RunBashCommandTool. - **sandbox** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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 diff --git a/docs-website/reference_versioned_docs/version-2.25/integrations-api/e2b.md b/docs-website/reference_versioned_docs/version-2.25/integrations-api/e2b.md index 88af83f295..16b0833617 100644 --- a/docs-website/reference_versioned_docs/version-2.25/integrations-api/e2b.md +++ b/docs-website/reference_versioned_docs/version-2.25/integrations-api/e2b.md @@ -44,6 +44,22 @@ Create a RunBashCommandTool. - **sandbox** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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 diff --git a/docs-website/reference_versioned_docs/version-2.26/integrations-api/e2b.md b/docs-website/reference_versioned_docs/version-2.26/integrations-api/e2b.md index 88af83f295..16b0833617 100644 --- a/docs-website/reference_versioned_docs/version-2.26/integrations-api/e2b.md +++ b/docs-website/reference_versioned_docs/version-2.26/integrations-api/e2b.md @@ -44,6 +44,22 @@ Create a RunBashCommandTool. - **sandbox** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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 diff --git a/docs-website/reference_versioned_docs/version-2.27/integrations-api/e2b.md b/docs-website/reference_versioned_docs/version-2.27/integrations-api/e2b.md index 88af83f295..16b0833617 100644 --- a/docs-website/reference_versioned_docs/version-2.27/integrations-api/e2b.md +++ b/docs-website/reference_versioned_docs/version-2.27/integrations-api/e2b.md @@ -44,6 +44,22 @@ Create a RunBashCommandTool. - **sandbox** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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 diff --git a/docs-website/reference_versioned_docs/version-2.28/integrations-api/e2b.md b/docs-website/reference_versioned_docs/version-2.28/integrations-api/e2b.md index 88af83f295..16b0833617 100644 --- a/docs-website/reference_versioned_docs/version-2.28/integrations-api/e2b.md +++ b/docs-website/reference_versioned_docs/version-2.28/integrations-api/e2b.md @@ -44,6 +44,22 @@ Create a RunBashCommandTool. - **sandbox** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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 diff --git a/docs-website/reference_versioned_docs/version-2.29/integrations-api/e2b.md b/docs-website/reference_versioned_docs/version-2.29/integrations-api/e2b.md index 88af83f295..16b0833617 100644 --- a/docs-website/reference_versioned_docs/version-2.29/integrations-api/e2b.md +++ b/docs-website/reference_versioned_docs/version-2.29/integrations-api/e2b.md @@ -44,6 +44,22 @@ Create a RunBashCommandTool. - **sandbox** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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 diff --git a/docs-website/reference_versioned_docs/version-2.30/integrations-api/e2b.md b/docs-website/reference_versioned_docs/version-2.30/integrations-api/e2b.md index 88af83f295..16b0833617 100644 --- a/docs-website/reference_versioned_docs/version-2.30/integrations-api/e2b.md +++ b/docs-website/reference_versioned_docs/version-2.30/integrations-api/e2b.md @@ -44,6 +44,22 @@ Create a RunBashCommandTool. - **sandbox** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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 diff --git a/docs-website/reference_versioned_docs/version-2.31/integrations-api/e2b.md b/docs-website/reference_versioned_docs/version-2.31/integrations-api/e2b.md index 88af83f295..16b0833617 100644 --- a/docs-website/reference_versioned_docs/version-2.31/integrations-api/e2b.md +++ b/docs-website/reference_versioned_docs/version-2.31/integrations-api/e2b.md @@ -44,6 +44,22 @@ Create a RunBashCommandTool. - **sandbox** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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 diff --git a/docs-website/reference_versioned_docs/version-3.0/integrations-api/e2b.md b/docs-website/reference_versioned_docs/version-3.0/integrations-api/e2b.md index 88af83f295..16b0833617 100644 --- a/docs-website/reference_versioned_docs/version-3.0/integrations-api/e2b.md +++ b/docs-website/reference_versioned_docs/version-3.0/integrations-api/e2b.md @@ -44,6 +44,22 @@ Create a RunBashCommandTool. - **sandbox** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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 diff --git a/docs-website/reference_versioned_docs/version-3.1/integrations-api/e2b.md b/docs-website/reference_versioned_docs/version-3.1/integrations-api/e2b.md index 88af83f295..16b0833617 100644 --- a/docs-website/reference_versioned_docs/version-3.1/integrations-api/e2b.md +++ b/docs-website/reference_versioned_docs/version-3.1/integrations-api/e2b.md @@ -44,6 +44,22 @@ Create a RunBashCommandTool. - **sandbox** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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 diff --git a/docs-website/reference_versioned_docs/version-3.2/integrations-api/e2b.md b/docs-website/reference_versioned_docs/version-3.2/integrations-api/e2b.md index 88af83f295..16b0833617 100644 --- a/docs-website/reference_versioned_docs/version-3.2/integrations-api/e2b.md +++ b/docs-website/reference_versioned_docs/version-3.2/integrations-api/e2b.md @@ -44,6 +44,22 @@ Create a RunBashCommandTool. - **sandbox** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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 diff --git a/docs-website/reference_versioned_docs/version-3.3/integrations-api/e2b.md b/docs-website/reference_versioned_docs/version-3.3/integrations-api/e2b.md index 88af83f295..16b0833617 100644 --- a/docs-website/reference_versioned_docs/version-3.3/integrations-api/e2b.md +++ b/docs-website/reference_versioned_docs/version-3.3/integrations-api/e2b.md @@ -44,6 +44,22 @@ Create a RunBashCommandTool. - **sandbox** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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** (E2BSandbox) – 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