openai-cookbook

照着跑，快速上手 OpenAI API 开发

OpenAI Cookbook 是 OpenAI 官方维护的示例与指南集合，旨在帮助开发者高效使用 OpenAI API。它解决了开发者在使用 GPT-4、ChatGPT 等模型时缺乏最佳实践和现成代码的问题，提供了从基础调用到高级应用的丰富示例。核心能力包括：详细的 API 使用指南（如文本生成、嵌入、微调）、常见任务的端到端示例（如问答、摘要、代码生成）、以及针对性能优化、成本控制和安全性的实用建议。项目以 Jupyter Notebook 形式呈现，代码可交互运行，覆盖了提示工程、函数调用、RAG 等热门技术，是学习 OpenAI API 和构建 AI 应用的权威参考。

开源 free 对话助手

访问官网 ↗ GitHub ↗ 文档 ↗

GitHub 星标 ★ 76124

维护状态活跃

是否开源是

定价模式 free

项目数据

分类对话助手

开发团队openai

所属国家

官网地址https://cookbook.openai.com

GitHubhttps://github.com/openai/openai-cookbook

定价模式free

价格说明OpenAI官方提供的API使用示例和指南，完全免费，无需付费。

访问状态

是否开源是

开源协议MIT

主要语言Jupyter Notebook

技术栈/模型chatgpt,gpt-4,openai,openai-api

GitHub 星标★ 76124

30天Star增速

HF 下载量

上线时间2022-03-11 00:00:00

最近更新2026-09-22 00:00:00

维护状态活跃

中文支持

访问方式

移动端支持

综合评分

收录时间2026-08-09

浏览次数3

使用教程

难度：入门约 10 分钟部署方式：库/依赖 4 步

⚠ 该项目 README 未提供完整安装说明，以下步骤为通用流程，请以官方文档为准。

环境要求

一个 OpenAI 账号（可在 platform.openai.com/signup 免费注册）
与账号关联的 OpenAI API Key
本地可运行 Python 与 Jupyter Notebook 的环境
能访问 cookbook.openai.com 与 platform.openai.com 的网络

安装与启动步骤

1注册并获取密钥

访问 OpenAI 注册页创建账号，然后在平台后台生成一个 API Key，注意创建后立即复制保存。
2获取示例仓库

README 主要是在线示例集合，可先克隆 GitHub 仓库到本地以便运行 Notebook。
```
git clone https://github.com/openai/openai-cookbook.git
```
3配置 API Key 环境变量

README 要求把密钥写入环境变量 OPENAI_API_KEY，或在仓库根目录用 .env 文件保存。
```
echo "OPENAI_API_KEY=sk-xxxxxxxx" > .env
```
4运行 Notebook 示例

用 Jupyter 打开本地 .ipynb，或直接访问 cookbook.openai.com 在线阅读并复制代码。
```
jupyter notebook
```

关键配置

配置项	必填	说明	示例
`OPENAI_API_KEY`	是	OpenAI API 密钥，示例代码调用接口时读取该环境变量	`sk-xxxxxxxx`

如何确认成功

在浏览器打开 cookbook.openai.com 能正常浏览示例；本地 Notebook 能成功跑通一次 API 调用并返回结果。

常见问题

Q：没有 OpenAI 账号怎么办？

A：README 给出注册入口 platform.openai.com/signup，免费注册后在平台后台创建 API Key 即可。

Q：API Key 应该写在哪里？

A：两种方式：设置名为 OPENAI_API_KEY 的环境变量；或在仓库根目录建 .env 文件写 OPENAI_API_KEY=<你的密钥>，多数 IDE（如 VS Code）的 Notebook 会自动读取。

Q：必须用 Python 吗？

A：README 说明大多数示例用 Python 编写，但其中的思路和概念可以套用到任何编程语言。

Q：不安装本地环境能看示例吗？

A：可以，直接访问 cookbook.openai.com 在线阅读全部示例与指南，本地克隆只是为了交互式运行。

注意事项

README 未给出依赖安装命令，运行具体 Notebook 时需按该 Notebook 自身说明补齐依赖。
不要把 .env 文件或 API Key 提交到 Git 仓库，避免密钥泄露。
项目采用 MIT License，可自由用于学习与二次开发。

核心亮点

官方出品，示例代码质量高且持续更新
覆盖提示工程、RAG、函数调用等热门场景
Notebook 形式可交互运行，学习成本低

不足之处

示例依赖 OpenAI 付费 API，无法本地离线运行
部分示例代码较旧，与最新 API 版本有出入

适用场景

新手学习 OpenAI API 基础调用与提示词技巧
开发者参考现成代码实现 RAG、函数调用等复杂功能
团队内部培训或技术分享的素材库

替代项目

LangChain、LlamaIndex、OpenAI Python SDK 文档

项目介绍

openai-cookbook 是学习教育领域的开源项目，由 openai 开发，2022 年首次发布。

在全站 13,090 个收录项目中，它的 GitHub 星标数（76,124）位列前 1%，在学习教育分类的 429 个项目里位列前 2%。

近 42 天，它的 GitHub 星标从 75,215 增加到 76,124，净增 909。

项目目前处于活跃维护状态，最近一次代码更新于 2026-09-22。OpenAI官方提供的API使用示例和指南，完全免费，无需付费。从国内网络环境看，当前已无法正常访问。

它主要面向的使用场景是：新手学习OpenAIAPI基础调用与提示词技巧。同类可对比的替代方案包括 LangChain、LlamaIndex、OpenAI Python SDK 文档。

上一篇：EngAce

下一篇：llm-paper-daily