项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 77023
技术标签
使用教程
⚠ 本教程由 AI 依据该项目 README 整理;原始文档不完整,部分步骤为通用流程推断,实际安装请以项目官方文档为准。
⚠ 该项目 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 文档
上一篇:EngAce
下一篇:llm-paper-daily
同类项目推荐
senior-software-engineer
开源
高级工程师面试,一份资源清单帮你系统备战
Collection of articles, books, and recommendations for senior-level interviews and a···
QCode
开源
在游戏岛屿上边闯关边学会用 AI 写代码
An explorable island world to learn AI coding and build real projects with AI agents···
aws-ml-jp
开源
跟着 Notebook 学 SageMaker,快速上手云上机器学习
SageMakerで機械学習モデルを構築、学習、デプロイする方法が学べるNotebookと教材集
llmops-workshop
开源
跟着 Notebook 跑一遍,把 LLM 原型变成可部署服务
Learn how to build solutions with Large Language Models.
read-frog
开源
边读边译,沉浸式学外语,让阅读成为你的语言老师。
Read Frog - Open-source AI language learning & flashcards, an Immersive Translate al···
deepseek-local-guide-ru
开源
俄语手把手教你在本机跑起 DeepSeek 大模型
Полный гайд на русском: как установить и запус···
yu-ai-agent
开源
一套 Java 教程,带你实战 AI Agent 开发,简历竞争力拉满
编程导航 AI 开发实战新项目,基于 Spring Boot 3 + Java 21 + Spring AI 构建 AI 恋爱大师···
claude-code-mastery
开源
16阶段55模块,免费系统学会Claude Code,中英越三语覆盖
The most comprehensive free Claude Code course — 16 phases, 55 modules, EN + VI
leetcode-explained
开源
刷 LeetCode 时,看视频题解、查公司标签、问 GPT 分析代码。
Browser extension that adds video solutions, company tags, and GPT code analysis int···
