OpenAI Agents SDK icon

OpenAI Agents SDK

OpenAI Agents SDK 是一款輕量級的 JavaScript/TypeScript 框架,可用於建立多代理工作流程與語音代理,支援 sandboxed agents、handoffs、tools、tracing 與 realtime agent 模式。

OpenAI Agents SDK

總覽

OpenAI Agents SDK(JavaScript/TypeScript)是一款輕量級框架,可用於在 JavaScript 與 TypeScript 中建立多代理工作流程。該 repository 將其描述為不限定供應商,並支援 OpenAI APIs 以及更多內容。

此 SDK 以 agents、tools、guardrails、handoffs、sessions、tracing、sandbox agents 與 realtime agents 為核心組織。README 也提供範例與文件,協助學習 API 並執行不同工作流程,包括可檢視檔案、執行命令與套用補丁的 sandbox 作業。

核心能力

Agent 基礎元件

使用指令、工具、guardrails 與 handoffs 來設定 agents,支援 JavaScript 或 TypeScript 中的多步驟工作流程。

Sandbox 工作流程支援

在需要檔案存取或命令執行的較長任務中,使用具備檔案系統工作區與 sandbox 環境的 sandbox agents。

Agent 委派

當任務需要拆分成專門步驟時,透過將 agents 作為工具或使用 handoffs,在 agents 之間委派工作。

以工具為基礎的動作

加入可讓 agents 採取動作的 tools,包括 functions、MCP 與 hosted tools。

Tracing 與除錯

透過內建 tracing 追蹤 agent 執行,以便檢視、除錯與最佳化工作流程。

Realtime 語音代理

使用 Realtime Agents 建立語音代理,README 將其描述為具備完整功能。

實際使用情境

  • 多代理任務協調

    建立一個使用指令、工具與 handoffs 來跨多個步驟完成結構化任務的 agent。

  • 了解 repository 的自動化

    使用 sandbox agents 來處理需要 repository 存取、命令執行或套用補丁的工作流程,同時在整個執行過程中保留工作區狀態。

  • 語音 agent 開發

    當工作流程需要 realtime 互動而非純文字交流時,使用 Realtime Agents 建立支援語音的 agent。

  • 工作流程除錯與最佳化

    加入 tracing 來檢視 agent 行為,接著利用這些可見性來持續除錯並精煉工作流程。

Pros and Cons

Pros

  • 適用於 JavaScript/TypeScript 多代理工作流程的輕量級框架。
  • 不限定供應商,支援 OpenAI APIs 與更多功能。
  • 包含可存取檔案與命令的 sandbox agents,適合較長時間的任務。
  • 內建 tracing 有助於除錯與最佳化。
  • 同時涵蓋標準 agents 與 realtime 語音 agents。

Cons

  • README 將 sandbox agents 標示為 beta。
  • Cloudflare Workers 支援屬於實驗性質,且需要 `nodejs_compat`。

FAQ

如何開始使用這個 SDK?

README 說明此 SDK 以 `npm install @openai/agents zod` 安裝。它也指出,若要執行 README 中展示的範例,需要設定 `OPENAI_API_KEY` 環境變數。

它是為哪類工作流程而設計的?

README 將此套件描述為適用於多代理工作流程的 JavaScript/TypeScript SDK,並支援一般代理與 sandbox agents。它也表示這個 SDK 不限定特定供應商,並支援 OpenAI APIs 與更多功能。

它支援哪些執行環境?

README 列出的支援環境包括 Node.js 22 以上、Deno 與 Bun。Cloudflare Workers 則註明為實驗性功能,且需啟用 `nodejs_compat`。

它支援語音或 realtime 使用情境嗎?

可以。README 強調 Realtime Agents 可用於建立具完整功能的語音代理,而 repository 主題也包含 `realtime-api` 與 `openai-api`。

這個 SDK 有另外的產品價格嗎?

此 repo 是採用 MIT 授權的開源專案。GitHub 定價頁面顯示 GitHub 本身有免費方案與付費方案,但並未為這個 SDK 提供單獨定價。

Quick Facts

類別
開發者工具
語言
JavaScript / TypeScript
來源網域
github.com
授權
MIT
支援的執行環境
Node.js 22+、Deno、Bun;Cloudflare Workers 為實驗性質
定價
開源;來源中未列出單獨的產品定價