-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Add Fleet Computer use documentation page #4182
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
langsmith-fleet
wants to merge
6
commits into
main
Choose a base branch
from
docs/add-fleet-computer-use-page
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+103
−1
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
198d559
Add Fleet Computer use documentation page
178f3c7
Incorporated feedback from Brace.
fjmorris 3965089
Merge remote-tracking branch 'origin/main' into docs/add-fleet-comput…
fjmorris cae8b70
Modified computer-use.mdx to match actual Fleet UI.
fjmorris 363f8bf
Incorporated feedback from Lauren.
fjmorris 77691a2
Merge remote-tracking branch 'origin/main' into docs/add-fleet-comput…
fjmorris File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| --- | ||
| title: Computer use | ||
| description: Run code, manage files, and call authenticated APIs from a persistent virtual computer attached to your Fleet agent. | ||
| --- | ||
|
|
||
| Computer use gives your Fleet agent access to an isolated virtual computer. The agent can write and execute code, manage files, install packages, and call authenticated external APIs without exposing credentials to the language model. | ||
|
|
||
| <Note> | ||
| Computer use is available on the [Plus and Enterprise plans](https://langchain.com/pricing). | ||
| </Note> | ||
|
|
||
| ## Computer modes | ||
|
|
||
| Choose how the virtual computer is shared across an agent's conversation threads. | ||
|
|
||
| | Mode | Description | | ||
| |------|-------------| | ||
| | **Shared computer** | All threads share a single computer. The filesystem, installed packages, and running processes persist across threads. Choose this mode when you want files, dependencies, or environment setup to accumulate across conversations. Shared computers are not deleted automatically. | | ||
| | **Computer per thread** | Each thread gets its own isolated computer that starts fresh and is archived when it goes idle. Choose this mode for software-engineering agents and other workloads that run many parallel, write-heavy tasks, or for any case where threads should not see each other's state. | | ||
|
|
||
| ## Configure computer use | ||
|
|
||
| <Warning> | ||
| The computer mode is set when the agent is created and cannot be changed afterward. To switch modes, create a new agent. | ||
| </Warning> | ||
|
|
||
| <Steps> | ||
| <Step title="Open the Create agent dialog"> | ||
| In the [Fleet](https://smith.langchain.com/agents) left navigation, under **My Agents**, click <Icon icon="plus" /> and select either **Create with AI** or **Blank agent**. Enter a name for your agent. | ||
| </Step> | ||
| <Step title="Enable computer use"> | ||
| Under **Should your agent use a computer?**, select **Yes**, then choose **Shared computer** or **Computer per thread**. If you select **No** (the default), the agent is created with no computer access. | ||
| </Step> | ||
| <Step title="Set the base snapshot (optional)"> | ||
| Expand **Advanced** to choose a **Snapshot** for new computers. | ||
| </Step> | ||
| <Step title="Create the agent"> | ||
| Click **Create Agent**. | ||
| </Step> | ||
| </Steps> | ||
|
|
||
| ## Access profiles | ||
|
|
||
| Use access profiles to let your agent call authenticated external APIs without putting credentials in the prompt or exposing them to the language model. Outbound HTTP requests to matching hosts are routed through a proxy that injects the configured headers before forwarding. | ||
|
|
||
| A profile contains one or more **Custom rules**. Each rule specifies: | ||
|
|
||
| - **Match Hosts**: The target hostnames the rule applies to. Use `*` as a wildcard (for example, `*.example.com` matches `api.example.com`). | ||
| - **Source Type and Provider**: The credential source. Choose **Connection** for user-delegated OAuth, or **Workspace Secret** for static API keys. | ||
| - **Inject Headers**: The HTTP headers the proxy adds to matched requests. Use template values such as `{access_token}` to reference the credential (for example, `Authorization: Bearer {access_token}`). | ||
|
|
||
| A profile also has a **Network scope** that controls outbound traffic for the agent's computer. The default is **None (all traffic allowed)**. | ||
|
|
||
| ### Add an access profile | ||
|
|
||
| <Steps> | ||
| <Step title="Create the access profile"> | ||
| Go to the [Fleet Integrations tab](https://smith.langchain.com/agents/tools) and navigate to the **Computer** section. Click **+ Create profile** and follow the prompts to configure the host patterns and credentials. | ||
| </Step> | ||
| <Step title="Attach the profile to an agent"> | ||
| In the agent editor, click the **Computer** node. Click **+ Add** next to **Access profiles** and select the profile you created. | ||
| </Step> | ||
| <Step title="Save changes"> | ||
| Click **Save changes**. | ||
| </Step> | ||
| </Steps> | ||
|
|
||
| ## Computer lifecycle | ||
|
|
||
| Each agent has two lifecycle settings that control how long a computer stays active and how long it is kept after it stops. [Configure both in the settings popover](#configure-lifecycle-and-snapshot). | ||
|
|
||
| - **Idle timeout**: When the computer has not received any commands for this duration, it pauses and the disk is archived. The agent can resume the same computer later without losing data. Default: **15 minutes**. | ||
| - **Stopped computer cleanup**: After a computer has been stopped for this duration, it is permanently deleted along with all disk data. Default: **14 days**. | ||
|
|
||
| <Note> | ||
| **Stopped computer cleanup** applies only to **Computer per thread** mode. Shared computers are not deleted automatically. | ||
| </Note> | ||
|
|
||
| ## Base snapshot | ||
|
|
||
| A snapshot is the disk image used to boot the computer. By default, all Fleet agents use the workspace default snapshot. To build, capture, or configure custom snapshots, see [Sandbox snapshots](/langsmith/sandbox-snapshots). [Change the snapshot for an agent](#configure-lifecycle-and-snapshot) in the settings popover. | ||
|
|
||
| <Note> | ||
| Snapshot changes apply only to new computers for the agent. The single shared computer in **Shared computer** mode keeps its original snapshot for its lifetime. | ||
| </Note> | ||
|
|
||
| ## Configure lifecycle and snapshot | ||
|
|
||
| The snapshot, idle timeout, and stopped computer cleanup for an agent are all set in the **Computer lifecycle** section of the settings popover. | ||
|
|
||
| <Steps> | ||
| <Step title="Open the settings popover"> | ||
| In [Fleet](https://smith.langchain.com/agents), open the agent and click the <Icon icon="settings" /> settings icon in the agent editor. | ||
| </Step> | ||
| <Step title="Set the lifecycle fields"> | ||
| Scroll to the **Computer lifecycle** section. Set the **Snapshot**, **Idle timeout**, and, for **Computer per thread** mode, **Stopped computer cleanup**. | ||
| </Step> | ||
| <Step title="Save changes"> | ||
| Click **Save changes**. | ||
| </Step> | ||
| </Steps> | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.