openai-cookbook

openaiMIT活跃维护 有专家点评

OpenAI API 的官方示例与实战指南合集,用 Jupyter Notebook 演示对话、嵌入、微调等常见用法,帮你快速上手并解决实际调用中的问题。

Examples and guides for using the OpenAI API

暂无版本77,033star +45 / 7 天13,053fork同步于 2026-11-10 23:19 UTC

专家点评

上手难度:入门更新于 2026-11-11

OpenAI API 的官方示例库,用来抄调用范式和参数组合,不是能装进依赖里的库

适用场景

  • 第一次接 OpenAI API、要确认某个端点(function calling、structured output、embedding 批处理)的正确请求体长什么样:直接抄 notebook 比翻 API reference 快,因为示例里带了完整的 messages 结构和参数组合。
  • 设计 RAG 或评测流水线前做技术选型:cookbook 里有分块、embedding、rerank、eval 的端到端 notebook,能先跑通再决定自己写还是上框架,省掉从零搭 demo 的时间。
  • 团队内部做 API 用法对齐:把相关 notebook 当规范文档引用,比口头约定参数默认值可靠,新人照着跑一遍就知道边界在哪。
  • 需要 token 计数、限流重试、流式解析这类边角逻辑的参考实现:这些代码短,抄进自己代码库比引一个 SDK 包装层更可控。

踩坑

  • 所有示例都依赖联网调用 OpenAI API 和有效的 API key,没有本地推理路径;离线环境或没有账号额度时整个仓库跑不动,只能当静态文档读。
  • notebook 是按写作时的 API 版本固化的,参数名和默认值会随 API 演进漂移;直接复制到生产代码前要对照当前 API reference 核一遍,issue 里 token counting 示例未覆盖 function calling 就是这类滞后被提出的。
  • 仓库是示例集合不是包,没有版本号也没有 CI 保证每个 notebook 可执行;issue 里出现过 setup.py / setuptools 缺失这类环境问题,说明部分 notebook 的依赖声明不完整,需要自己补环境。

同类对比

要可编程调用的封装选官方 openai-python SDK;要成体系的 RAG/agent 框架选 LangChain 或 LlamaIndex,cookbook 的定位是参考实现而非运行时依赖。

怎么上手

由 README 提炼,执行前请确认
export OPENAI_API_KEY=<your API key>
硬件要求按 README 说明

README 未说明

下载:源码 zip·GitHub Releases(安装包)本站不镜像安装包

项目说明

由 README 自动翻译提炼

OpenAI API 的示例代码与实战指南合集,帮你快速上手常见任务

OpenAI API 的官方示例与实战指南合集,用 Jupyter Notebook 演示对话、嵌入、微调等常见用法,帮你快速上手并解决实际调用中的问题。

核心能力

  • 提供用 OpenAI API 完成常见任务的示例代码
  • 以 Python 为主,概念可迁移到其他语言
  • 通过环境变量 OPENAI_API_KEY 配置密钥
  • 支持在 IDE 中用 .env 文件自动加载密钥
  • 官网 cookbook.openai.com 可浏览导航

容易踩的坑

需要自行注册 OpenAI 账号并获取 API key;示例依赖 OpenAI API 联网调用,非本地推理

内容由模型根据 README 生成,可能不完整或不准确,以官方文档为准。看原文 README

最近发版

0 个版本

暂无 release 数据(可能没有发版,或尚未同步)。

用户点评

登录用户的真实使用记录,可按版本和硬件筛选
共 0 条

    还没有人点评。第一个说出真实体验的人最有价值。

    README 原文

    未翻译

    ✨ Navigate at cookbook.openai.com

    Example code and guides for accomplishing common tasks with the OpenAI API. To run these examples, you'll need an OpenAI account and associated API key (create a free account here). Set an environment variable called OPENAI_API_KEY with your API key. Alternatively, in most IDEs such as Visual Studio Code, you can create an .env file at the root of your repo containing OPENAI_API_KEY=<your API key>, which will be picked up by the notebooks.

    Most code examples are written in Python, though the concepts can be applied in any language.

    For other useful tools, guides and courses, check out these related resources from around the web.

    License

    MIT License