项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
技术标签
使用教程
—
环境要求
- 已安装 Node.js 与 npm(README 未给出具体版本要求)
- 可用的 OpenAI API 密钥(用于实际调用模型)
- 一个用于初始化项目的空目录
- 网络可访问 npm 源以下载依赖
安装与启动步骤
-
1检查 Node 环境
README 未规定 Node 版本,先确认本机已装好 Node.js 和 npm,能正常输出版本号再继续。
node -v npm -v -
2初始化项目
在空目录里生成 package.json,作为安装 SDK 的项目基础;已有项目可跳过这一步。
npm init -y -
3安装 SDK 依赖
这是 README 给出的官方安装命令,同时装上 Agents SDK 和 zod,zod 用于工具参数校验。
npm install @openai/agents zod -
4配置模型密钥
调用 OpenAI 模型需要提供 API 密钥,请按官方文档设置对应的环境变量后再运行 Agent。
-
5编写并运行 Agent
参照官方指南用 Agent 与 Runner 编写脚本,然后用 Node 运行;具体示例代码见官网文档。
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
OPENAI_API_KEY | 是 | 调用 OpenAI 模型所需的 API 密钥,README 未显式列出,为官方 SDK 通用约定 | sk-xxxxxxxx |
如何确认成功
依赖安装无报错,且运行示例 Agent 脚本能正常输出模型回复结果。
常见问题
Q:必须同时安装 zod 吗?
A:README 的安装命令就是 npm install @openai/agents zod,两者一起安装,zod 用于函数工具的参数校验,建议照抄该命令。
Q:支持在浏览器里用吗?
A:支持。该项目面向 Node.js 与浏览器环境,可在两端构建多 Agent 工作流。
Q:能接入非 OpenAI 的模型吗?
A:可以。README 说明该 SDK 是 provider-agnostic,除 OpenAI API 外还支持其他提供方。
Q:语音 Agent 怎么写?
A:使用 Realtime Agents,官方提供 voice-agents 快速开始指南,支持工具、护栏、交接与会话历史。
注意事项
- 安装命令中的包名是 @openai/agents,注意带 @openai 作用域前缀,不要写成其他名字。
- README 节选未给出端口、示例文件路径和模型名,具体调用方式请以官网文档为准。
- 核心概念包括 Agents、Tools、Handoffs、Guardrails、Sessions、Realtime Agents 等,建议先读官方指南再动手。
核心亮点
- 官方维护,与 OpenAI API 及 Realtime 语音能力同步更新,兼容性有保障
- 内置 Agent 循环、工具调用、Handoffs 和 Tracing,省去大量编排样板代码
- TypeScript 类型完整,支持流式事件,Node 与浏览器均可运行
不足之处
- 与 OpenAI 生态强绑定,切换其他模型供应商需要额外适配
- 项目较新,版本迭代快,API 可能发生破坏性变更
适用场景
- 搭建带函数调用和任务转接的客服多 Agent 系统
- 开发基于 Realtime API 的实时语音助手
- 在 Web 前端集成可流式输出的智能体交互界面
替代项目
LangChain.js、Mastra、Vercel AI SDK
上一篇:agent-native
下一篇:eve
同类项目推荐
dsh-our-free-model
开源
装个插件就能免密钥白嫖前沿大模型,不限量
在 dsh 里装上这个插件即可,无需登录、注册或填 API Key,就能使用包括 DeepSeek V4.1 Fl···
langchain
开源
组装 AI 应用的乐高积木,从想法到上线不换工具
The agent engineering platform.
transformers
开源
全球最大的模型仓库全家桶,想用的模型一把抓
Transformers: the model-definition framework for state-of-the-art machine learning m···
ComfyUI-sol-attn
开源
在 ComfyUI 中让视频生成注意力更快更省显存
NVIDIA Sol-Attn for ComfyUI / Triton kernel on SM89 - SM121, with zero-copy MiniMax ···
