教程1：你的第一个OpenAI代理

教程 1：你的第一个 OpenAI 代理

欢迎来到 OpenAI Agents SDK 之旅的第一步！本教程将向你介绍使用 OpenAI 的 Agents SDK 创建一个简单 AI 代理的基本概念。

你将学到的内容

• 基本代理创建：如何创建你的第一个 OpenAI 代理
• OpenAI SDK 工作流程：理解代理的生命周期
• 简单的文本处理：基本的输入/输出处理
• 代理配置：必要的参数和设置

核心概念：什么是 OpenAI 代理？

OpenAI 代理是一种可编程的 AI 助手，它可以：

• 处理用户输入（文本、语音等）
• 使用 AI 模型（如 GPT-4o）来理解和回应
• 根据你的指令执行特定任务
• 返回结构化或非结构化的响应

把它想象成一个利用 AI 来处理复杂任务的智能函数。

关键组件

1. 代理类

OpenAI SDK 中创建 AI 代理的主要构建模块：

from agents import Agent
​

2. 必要参数

• name: Unique identifier for your agent
• instructions: How your agent should behave
• model: The AI model to use (defaults to "gpt-4o")

3. Basic Workflow

1. Input: User sends a message
2. Processing: Agent uses AI model to understand and respond
3. Output: Agent returns a response

Tutorial Overview

This tutorial includes two focused agent examples:

1. Personal Assistant Agent (personal_assistant_agent/)

• Basic agent creation and configuration
• Simple instructions and role definition
• Core Agent class usage

2. Execution Demo Agent (execution_demo_agent/)

• 展示不同的执行方式
• 同步、异步和流式处理模式
• 运行器类的使用示例

项目结构

1_starter_agent/
├── README.md                    # This file - concept explanation
├── requirements.txt             # Dependencies
├── personal_assistant_agent/    # Basic agent creation
│   ├── __init__.py
│   └── agent.py                # Simple agent definition (20 lines)
├── execution_demo_agent/        # Execution methods demonstration
│   ├── __init__.py
│   └── agent.py                # Sync, async, streaming examples
├── app.py                      # Streamlit web interface (optional)
└── env.example                 # Environment variables template
​

学习目标

完成本教程后，你将掌握：

• ✅ 如何创建一个基本的 OpenAI 代理
• ✅ 必要的代理参数及其用途
• ✅ 如何同步和异步运行代理
• ✅ 基本的 OpenAI SDK 工作流程和生命周期
• ✅ 如何使用流式响应

开始使用

1. 设置你的环境：

   # Make sure you have your OpenAI API key
   # Get your API key from: https://platform.openai.com/api-keys
   ​

2. 安装 OpenAI Agents SDK：

   pip install openai-agents
   ​

3. 安装依赖项：

   # Install required packages
   pip install -r requirements.txt
   ​

4. 设置环境变量：

   # Copy the example environment file
   cp .env.example .env
   
   # Edit .env and add your OpenAI API key
   # OPENAI_API_KEY=sk-your_openai_key_here
   ​

5. 测试代理：

   # Run the agent directly
   python agent.py
   
   # Or run the Streamlit web interface
   streamlit run app.py
   ​

6. 尝试不同的执行方式：

   • 测试同步执行：“今天天气怎么样？”
   • 测试异步执行：“给我讲个关于 AI 的故事”
   • 测试流式响应：“详细解释一下机器学习”

示例提示供你尝试

• 一般问题：“法国的首都是什么？”
• 创意任务：“写一首关于科技的小诗”
• 解决问题：“我怎样才能提高我的工作效率？”
• 解释说明：“用简单的话解释量子计算”

下一步

完成本教程后，你将准备好：

• 教程 2：结构化输出代理 —— 学习创建类型安全的结构化响应
• 教程 3：使用工具的代理 —— 为你的代理添加自定义工具和功能
• 教程 4：运行器执行方法 —— 熟练掌握不同的执行模式

专业小贴士

• 从简单开始：先从基础功能入手，逐步增加复杂性
• 多加测试：尝试不同的提示，以了解代理的行为
• 阅读说明：清晰的说明能带来更好的代理表现
• 大胆实验：尝试不同的执行方式，感受其中的差异

排除故障

• API 密钥问题：确保你的 .env file contains a valid OPENAI_API_KEY
• Import Errors: Ensure all dependencies are installed with pip install -r requirements.txt
• 速率限制：如果你遇到速率限制，请稍等片刻再试。

免责声明：
本文档采用基于机器的 AI 翻译服务进行翻译。尽管我们力求准确，但请注意，自动翻译可能存在错误或不准确之处。应以原文语言版本的文档作为权威依据。如需获取关键信息，建议使用专业的人工翻译。对于因使用本翻译而产生的任何误解或误读，我们概不负责。