请参阅 OpenAI Cookbook 中的由应用程序管理沙盒和通过 webhook 管理沙盒示例。
有关执行器的设置方法和连接要求,请参阅自托管沙盒。
选择沙盒预配模式:
- 由应用程序管理: 按照本指南在您的应用程序中启动和停止沙盒。
- 通过 webhook 管理: 部署一个处理程序,在收到 OpenAI webhook 事件时启动或重新连接沙盒。
有关这两种模式的比较,请参阅沙盒生命周期。
开始之前
您需要准备 OpenAI 项目 API 密钥、Blaxel API 密钥和工作空间,以及 Codex CLI 软件包。
设置 BL_API_KEY 和 BL_WORKSPACE,并使用 OPENAI_API_KEY 发送应用程序请求。将 OPENAI_EXECUTOR_API_KEY 设置为环境密钥。向沙盒传入密钥时,只传入该环境密钥,并将其赋给 CODEX_API_KEY。
在预配代码中选择沙盒所在的区域。如果您需要使用下文介绍的 Agent Drive 文件持久化功能,请选择 us-was-1。
1. 设置 Blaxel 环境
创建自托管会话并保存其环境 ID。使用 Blaxel SDK 或 API 创建一个隔离的沙盒,让沙盒使用已配置的工作目录。在沙盒中安装 Codex CLI,然后使用该环境 ID 和环境密钥启动沙盒中的执行器。
Blaxel 的 Node 镜像基于 Alpine Linux,因此安装 ripgrep 时请使用 apk。仅向执行器进程传入环境密钥,并将其赋给 CODEX_API_KEY。设置 keep_alive=True,防止沙盒在执行器运行期间缩容至零。为设置过程、执行器和沙盒分别设置超时时间,避免不再使用的资源无限期运行。
如果您经常使用沙盒,请构建一个预装了 Codex 和 ripgrep 的 Blaxel 镜像,让沙盒更快建立连接。
2. 运行会话
Blaxel 执行器建立连接后,请参照运行和继续会话中的 HTTP 示例发送输入,并以流式方式接收结果。使用完毕后,请删除会话,并单独停止 Blaxel 沙盒。
请先启动沙盒,再提交输入。当前轮次会等待环境建立连接。连接建立后,会话会在事件流中发送 agent.session.environment.connected 事件。
请通过 agent.session.turn.completed 事件确认当前轮次已成功完成。轮次失败或取消后,也可能出现 agent.session.idle 事件,因此不能仅凭会话处于空闲状态就判定该轮次已成功完成。
可选:跨会话保留文件
使用 Blaxel Agent Drive 可以在不同沙盒和会话之间保留文件。在每个沙盒中挂载同一个驱动器即可共享文件。使用 Agent Drive 必须选择 us-was-1 区域,且 Agent Drive 不会传输对话历史记录或会话状态。