示例
在 仓库的示例部分,可以查看 SDK 的各种示例实现。这些示例按多个类别组织,展示了不同的模式和功能。
类别
-
agent_patterns: 此类别中的示例说明了常见的代理设计模式,例如
- 确定性工作流
- 代理作为工具
- 并行代理执行
- 条件工具使用
- 输入/输出护栏
- LLM 作为裁判
- 路由
- 流式护栏
-
basic: 这些示例展示了 SDK 的基础功能,例如
- Hello world 示例(默认模型、GPT-5、开源模型)
- 代理生命周期管理
- 动态系统提示
- 流式输出(文本、条目、函数调用参数)
- 提示模板
- 文件处理(本地和远程、图像和 PDF)
- 使用情况跟踪
- 非严格输出类型
- 先前响应 ID 的使用
-
customer_service: 航空公司示例客户服务系统。
-
financial_research_agent: 一个金融研究代理,展示了使用代理和工具进行金融数据分析的结构化研究工作流。
-
handoffs: 查看带有消息过滤的代理交接的实际示例。
-
hosted_mcp: 示例演示如何使用托管 MCP(模型上下文协议)连接器和审批。
-
mcp: 了解如何使用 MCP(模型上下文协议)构建代理,包括
- 文件系统示例
- Git 示例
- MCP 提示服务器示例
- SSE(服务器发送事件)示例
- 可流式传输的 HTTP 示例
-
memory: 代理的不同内存实现示例,包括
- SQLite 会话存储
- 高级 SQLite 会话存储
- Redis 会话存储
- SQLAlchemy 会话存储
- 加密会话存储
- OpenAI 会话存储
-
model_providers: 探索如何使用非 OpenAI 模型与 SDK,包括自定义提供程序和 LiteLLM 集成。
-
realtime: 示例展示了如何使用 SDK 构建实时体验,包括
- Web 应用程序
- 命令行界面
- Twilio 集成
-
reasoning_content: 示例演示如何使用推理内容和结构化输出。
-
research_bot: 简单的深度研究克隆,展示了复杂的跨代理研究工作流。
-
tools: 了解如何实现 OAI 托管工具,例如
- Web 搜索和带有过滤器的 Web 搜索
- 文件搜索
- 代码解释器
- 计算机使用
- 图像生成
-
voice: 查看语音代理的示例,使用我们的 TTS 和 STT 模型,包括流式语音示例。