@ hatchet-dev/ sandbox (中文(简体) )
运行沙盒从 标签 任务,用于您选择的沙盒供应商.
沙盒是带有外壳的工作空间. 在其中运行命令并读取并撰写其文件. 每次通话都是哈切特任务,与快照相对应. 你可以从任何快照中开始一个新的沙盒,你可以稍后通过它的ID返回到沙盒. 如果你在耐用任务中使用它, 坠机会捡起它留下的地方.
你的密码只跟哈切特说话 沙盒本身运行在一个供应商 你连接你的房客.
安装
pnpm add @hatchet-dev/sandbox @hatchet-dev/typescript-sdk
npm install @hatchet-dev/sandbox @hatchet-dev/typescript-sdk
yarn add @hatchet-dev/sandbox @hatchet-dev/typescript-sdk
惠璶 @hatchet-dev/typescript-sdk 1.3.3.1或较新.
快开始
导入软件包一次 。 它又说 hatchet.sandbox 给哈切特客户端.
import { HatchetClient } from '@hatchet-dev/typescript-sdk/v1';
import '@hatchet-dev/sandbox';
const hatchet = HatchetClient.init();
const session = hatchet.durableTask({
name: 'agent-session',
executionTimeout: '1h',
fn: async (input: { conversationId: string }) => {
const sandbox = await hatchet.sandbox.create({ id: input.conversationId });
await sandbox.files.write('haiku.txt', 'an old silent pond');
const haiku = await sandbox.exec('cat haiku.txt');
await sandbox.kill();
return { haiku: haiku.stdout };
},
});
// later, from anywhere with a Hatchet client
const again = await hatchet.sandbox.connect('conv-42');
await again.exec('cat haiku.txt');
设定 HATCHET_CLIENT_TOKEN 就像你对哈切特客户一样.
供应商
提供商是一个沙盒供应商 与你的哈切特租户相连 曾经配置在仪表板下 Sandboxes 带有供应商的 API 密钥和可选配置值.
目前我们支持下列供应商:
const sandbox = await hatchet.sandbox.create({ provider: 'e2b' });
API 密码
hatchet.sandbox
| 打电话 | 回返 | 它会做什么 |
|---|---|---|
create(opts?) | Sandbox | 开一沙盒. |
connect(id, { template? }) | Sandbox | 从最新的快照中取出一个沙盒. 停止后再开始 如果ID不存在则丢出. |
list({ sandboxId?, metadata? }) | SandboxInfo[] | 通过ID或元数据查找沙盒. 所有给定的配对必须匹配. |
delete({ sandboxId?, metadata? }) | string[] | 删除每个匹配的沙盒及其所有快照和文件,并返回其ID。 需要一个过滤器. |
备选方案 create数字 :
| 选项 | 它会做什么 |
|---|---|
provider | 哪个沙盒供应商可以创建, 名称。 当房客有几分钱的时候需要,叉子总是用它的快照. |
id | 自己选个沙盒身份证 小写字母 数字和连字符 它决不能存在. |
template | 图像或模板,以提供者自己的说法. 默认提供者的默认 . |
from | 从这个快照开始 从同一个快照创建出两个沙盒,你有一个叉子. |
metadata | 您可以搜索的标记 list。 。 。 . |
inheritParentMetadata | 与 from,复制沙盒的标签 使快照在新的。 给定的标记 metadata 优先发言. |
idleTimeoutMs | 这么长时间没打电话就把沙盒停了 供养者设出最上. |
resources | 机器大小为 { vcpu, memory, disk }。 。 。 . memory 财务报告和审定财务报表 disk 取若干个MIB或数量,单位如下: '4Gi'。无法遵守字段的提供者会用自己的信息使创建失败. |
Sandbox
| 打电话 | 回返 | 它会做什么 |
|---|---|---|
exec(cmd, { timeoutMs? }) | { stdout, stderr, exitCode, snapshotId?, timings? } | 运行 sh -c cmd 在工作区拍个快照 非零退出代码是正常结果,而不是出错. 超时时出站码为124. |
kill() | void | 止取沙盒来. 镜头留下,所以 connect 还行. |
delete() | void | 停止沙盒并删除每个快照和文件. connect 之后失败 . |
sandboxId | string | 要使用的标识 connect 等会. |
files | Files | 下面的文件 API . |
每一个结果都有 timings 以毫秒计 claim, (中文(简体) ), restore, (中文(简体) ), exec,以及 checkpoint,则 snapshotId 电话打来的.
sandbox.files
路径与工作空间相对. 指向外面的路径 扔出一个 FilesystemError 有代码 invalid_path。 。 。 .
| 打电话 | 它会做什么 |
|---|---|
read(path, { format? }) | 读取文件. format 实值 'text' (违约), 'bytes' (单位:千美元) Uint8Array,或 'blob'。 。 。 . |
write(path, data) 或者说 write([{ path, data }, ...]) | 写一个或多个文件. data 可以是弦, ArrayBuffer, (中文(简体) ), Uint8Array,或 Blob。 。 。 . |
list(path?, { depth? }) | 列出有名称、路径、类型、大小、模式、权限和修改时间的条目. |
exists(path), (中文(简体) ), getInfo(path) | 检查路径或获得信息. |
makeDir(path), (中文(简体) ), rename(from, to), (中文(简体) ), copy(from, to), (中文(简体) ), remove(path) | 通常的文件操作. |
download(url, path, { timeoutMs? }) | 提供者将 https URL 获取到工作空间 。 私人地址和回路地址被拒绝. |
upload(path, url, { timeoutMs? }) | 提供者用 HTTP PUT 向 https URL 发送文件. 指定 URL 运行良好 . |
read 财务报告和审定财务报表 write 通过Hatchet携带最多2个米B. 提供商拥有一个对象存储台上更大的文件,并且从未通过Hatchet传送过它们;无论用哪种方式,都使用同样的方法.
错误
FilesystemError有一个code其中:not_found, (中文(简体) ),invalid_path, (中文(简体) ),invalid_url, (中文(简体) ),invalid_content, (中文(简体) ),invalid, (中文(简体) ),is_a_directory, (中文(简体) ),not_a_directory, (中文(简体) ),too_large, (中文(简体) ),staging_failed, (中文(简体) ),transfer_failed。 。 。 .- 失败的命令不会丢出 。 看着
exitCode。 。 。 . connect身份不明,身份不明.create带有id已经存在 扔。 使用connect给那个 或者选个新的身份证.hatchet.sandbox.delete无sandboxId或无空metadata过滤器在触摸任何东西之前抛出. 元数据匹配是一个子集匹配, 和list: 过滤器{ a, b }匹配贴有标签的沙盒{ a, b, c }。 。 。 .
遥测
首先使用SDK打开了Hatchet OpenTeleometry仪器. 如果您已经设置了 OpenTeleometry, 沙盒呼叫会在您的任务跟踪中显示 。 设定 HATCHET_SANDBOX_OTEL=false 把它关掉.
你需要的东西
- 装有沙盒的Hatchet Cloud租户已启用.
- 至少有一个沙盒供应商与租户连接, 在仪表板的沙盒下配置了您的 Daytona, E2B, Archil, 或 Freestyle API 键.
更改日志
见 变动情况。 。 。 .
许可证
麻省理工学院. 见 自由主义。 。 。 .