这是一个由社区维护的 OpenAI API 中文文档项目,帮助中文读者更轻松地阅读和理解 OpenAI API 文档。
你可以在这里阅读中文译文,也可以随时对照英文原文。无论你是第一次接触 OpenAI API,还是只想快速查找某项功能的说明,都可以直接从在线文档开始。
本项目不是 OpenAI 官方网站。涉及接口行为、价格、使用限制和安全要求时,请以 OpenAI 官方文档 为准。
- 日常阅读:打开在线中文文档,从页面目录中选择需要的内容。
- 对照原文:阅读中文时遇到疑问,可以切换到相应的英文内容核对。
- 查看官方信息:需要确认最新的接口行为、价格或使用限制时,请访问 OpenAI 官方文档。
如果习惯直接在 GitHub 中阅读,也可以进入中文文档目录或英文文档目录。两个目录采用相近的结构,方便相互对照。
这个项目通过 GitHub Actions 持续维护文档:
- 定期检查 OpenAI 官方英文文档是否发生变化;
- 发现变化后,通过自动创建或更新的 PR 同步英文内容;
- 英文更新后继续更新对应的中文翻译,并定期补充尚未完成的内容;
- 如果已有翻译 PR 等待审核,会先等待当前内容处理完毕,避免同时产生多批改动;
- 自动生成的改动不会直接进入主分支,需要通过项目检查并由维护者审核。
这些规则让文档可以持续跟进官方变化,同时保留必要的检查和人工确认。
中文翻译会逐步完善,因此部分内容可能暂时只有英文版本,也可能与刚更新的官方文档存在时间差。
遇到这种情况时,可以先切换到英文内容或查看 OpenAI 官方文档。之后再次访问时,对应的中文内容可能已经补充或更新。
如果你发现错译、漏译、表述不清或链接失效,欢迎提交 Issue。
反馈时请尽量说明:
- 问题出现在哪个文件;
- 哪句话不容易理解或可能有误;
- 如果方便,你建议怎样表达。
这些信息能帮助维护者更快地找到并处理问题。
与文档同步、翻译和网站有关的维护说明,分别放在以下目录中:
普通读者不需要安装或运行任何维护工具,直接阅读文档即可。
英文文档内容来自 OpenAI 官方文档,其内容及相关商标权利归各自权利人所有。本项目提供的代码遵循仓库所附许可证。