OpenAI Agents SDK icon

OpenAI Agents SDK

OpenAI Agents SDK 是一款轻量级 JavaScript/TypeScript 框架,用于构建多智能体工作流和语音代理,支持沙箱代理、handoff、工具、tracing 和实时代理模式。

OpenAI Agents SDK

概述

OpenAI Agents SDK(JavaScript/TypeScript)是一款用于在 JavaScript 和 TypeScript 中构建多智能体工作流的轻量级框架。仓库将其描述为与提供方无关,支持 OpenAI API 等更多服务。

该 SDK 围绕 agents、tools、guardrails、handoffs、sessions、tracing、sandbox agents 和 realtime agents 组织。README 还指向示例和文档,帮助学习 API 并运行不同工作流,包括可检查文件、运行命令和应用补丁的沙箱工作。

核心能力

代理构建模块

使用指令、工具、guardrails 和 handoffs 配置代理,以支持 JavaScript 或 TypeScript 中的多步骤工作流。

沙箱工作流支持

为需要文件访问或命令执行的长时间运行任务使用带有文件系统工作区和沙箱环境的沙箱代理。

代理委派

当任务需要拆分为专业化步骤时,可通过将代理作为工具或使用 handoffs 在代理之间委派工作。

基于工具的操作

添加工具,让代理执行操作,包括函数、MCP 和托管工具。

Tracing 与调试

使用内置 tracing 跟踪代理运行,以便查看、调试和优化工作流。

实时语音代理

使用 Realtime Agents 构建语音代理,README 将其描述为具备完整功能。

实际用例

  • 多智能体任务编排

    构建一个使用指令、工具和 handoffs 完成跨多个步骤结构化任务的代理。

  • 仓库感知自动化

    为需要仓库访问、命令执行或补丁应用的工作流使用沙箱代理,同时在运行期间保留工作区状态。

  • 语音代理开发

    当工作流需要实时交互而不是纯文本交流时,使用 Realtime Agents 创建支持语音的代理。

  • 工作流调试与优化

    添加 tracing 来检查代理行为,然后利用这些可见性持续调试和优化工作流。

Pros and Cons

Pros

  • 用于 JavaScript/TypeScript 多智能体工作流的轻量级框架。
  • 与提供方无关,支持 OpenAI API 等更多服务。
  • 包含用于需要文件和命令访问的长时间运行任务的沙箱代理。
  • 内置 tracing 有助于调试和优化。
  • 同时覆盖标准代理和实时语音代理。

Cons

  • 沙箱代理在 README 中标记为 beta。
  • Cloudflare Workers 支持处于实验性状态,并需要启用 `nodejs_compat`。

FAQ

如何开始使用这个 SDK?

README 说明可使用 `npm install @openai/agents zod` 安装 SDK。它还指出,要运行 README 中展示的示例,需要设置 `OPENAI_API_KEY` 环境变量。

它面向哪类工作流?

README 将该包描述为一个用于多智能体工作流的 JavaScript/TypeScript SDK,并支持常规代理和沙箱代理。它还说明该 SDK 与提供方无关,支持 OpenAI API 等更多服务。

它支持哪些运行时?

README 中列出的支持环境包括 Node.js 22 或更高版本、Deno 和 Bun。Cloudflare Workers 标注为实验性,并启用 `nodejs_compat`。

它支持语音或实时使用场景吗?

支持。README 突出介绍了 Realtime Agents,可用于构建具有完整功能的语音代理,仓库主题也包含 `realtime-api` 和 `openai-api`。

这个 SDK 有单独的产品价格吗?

该仓库是一个采用 MIT 许可证的开源项目。GitHub 定价页面显示 GitHub 本身有免费套餐和付费计划,但并未为这个 SDK 提供单独定价。

Quick Facts

类别
开发者工具
语言
JavaScript / TypeScript
来源域名
github.com
许可证
MIT
支持的运行时
Node.js 22+、Deno、Bun;Cloudflare Workers 为实验性
定价
开源;来源中未列出单独产品定价