✨ 前往 cookbook.openai.com 浏览

使用 OpenAI API 完成常见任务的示例代码和指南。要运行这些示例，您需要一个 OpenAI 账户及相应的 API 密钥（在此创建免费账户）。请设置名为 OPENAI_API_KEY 的环境变量，并将其值设为您的 API 密钥。或者，在大多数 IDE（如 Visual Studio Code）中，您可以在仓库根目录下创建一个 .env 文件，内容为 OPENAI_API_KEY=<您的API密钥>，这样笔记本就会自动读取该密钥。

大多数代码示例使用 Python 编写，但相关概念适用于任何编程语言。

如需其他实用工具、指南和课程，请查看这些来自网络的相关资源。

许可证

MIT 许可证

OpenAI Cookbook 快速上手指南

OpenAI Cookbook 是一个开源仓库，提供了使用 OpenAI API 完成常见任务的示例代码和指南。大多数示例使用 Python 编写，但核心概念适用于任何编程语言。

环境准备

在开始之前，请确保满足以下条件：

• 系统要求：支持 Python 的操作系统（Windows, macOS, Linux）。
• 前置依赖：
  • 已安装 Python (推荐 3.8 及以上版本)。
  • 拥有 OpenAI 账户 并获取了 API Key。
• 网络环境：由于 OpenAI 服务在中国大陆地区无法直接访问，请确保您的开发环境已配置好可靠的网络代理或加速方案。

安装步骤

1. 克隆仓库 将项目代码下载到本地：

   git clone https://github.com/openai/openai-cookbook.git
   cd openai-cookbook
   

2. 安装 Python 依赖 建议使用虚拟环境，然后安装所需的库（主要是 openai 和 jupyter）：

   pip install -r requirements.txt
   

   (注：如果 requirements.txt 下载缓慢，可尝试指定国内镜像源，例如：pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple)

3. 配置 API Key 您需要将 API Key 设置为环境变量，以便示例代码能够读取。

   • 方法一：临时设置（终端会话有效）

     • macOS/Linux:

       export OPENAI_API_KEY="sk-..."
       

     • Windows (PowerShell):

       $env:OPENAI_API_KEY="sk-..."
       

   • 方法二：创建 .env 文件（推荐，适用于 Jupyter Notebook） 在项目根目录下创建一个名为 .env 的文件，内容如下：

     OPENAI_API_KEY=sk-你的实际_API_Key_在此处
     

基本使用

Cookbook 中的示例主要以 Jupyter Notebook (.ipynb) 形式提供。以下是运行第一个示例的步骤：

1. 启动 Jupyter Notebook 在项目根目录执行：

   jupyter notebook
   

   浏览器会自动打开界面。

2. 选择示例 在文件列表中导航至 examples 目录，选择一个感兴趣的笔记本，例如 How_to_count_tokens_with_tiktoken.ipynb 或 How_to_call_functions_with_chat_models.ipynb。

3. 运行代码

   • 打开笔记本后，依次点击单元格（Cell）并按 Shift + Enter 运行。
   • 代码会自动读取您配置的 OPENAI_API_KEY 并调用 API。
   • 观察输出结果，理解如何构建请求、处理响应以及管理 Token。

提示：虽然示例多为 Python，但您可以参考其逻辑（如 Prompt 构建、参数设置、错误处理），将其迁移到您熟悉的编程语言中。