关于 OpenAI 中文文档
我们是一群长期使用 OpenAI 的开发者 / 创作者 / 教育者。英文原文档在国内访问与阅读门槛较高(登录、网络可达性、术语理解等),因此我们维护这一份开放、准确、可验证的中文文档,帮助中文社区更高效地学习与实践。
我们在做什么
- 翻译与校对:对齐上游英文文档,保持术语一致与段落可追溯。
- 结构化整理:把零散内容按「快速上手 / API / 示例 / 最佳实践 / 常见问题」分区,便于检索。
- 示例与指北:补充最小可运行(MVP)示例、踩坑提示与版本变更记录。
- 持续更新:关注官方更新日志,及时同步重要变更并标注更新时间。
我们尽量保持逐条对应原文,必要时会添加「译者注」解释背景或差异。
适合谁
- 想快速上手的初学者
- 需要查行为边界与参数细节的工程师
- 关注教学与科普的教育工作者
- 在企业内推进 AI 应用的产品 / 运维 / 法务同学
我们如何保障质量
- 对照来源:每一处关键表述都能回溯到官方文档链接。
- 版本标注:在页面顶部或相关段落注明适用版本与更新时间。
- 术语表:统一中英术语,避免同物异名(例如 rate limit、logprobs)。
- 变更日志:记录「新增 / 变更 / 废弃」并附上迁移建议。
如何参与贡献
欢迎你一起把文档变得更好(哪怕是一个错别字 👋):
- 修订文档:对错译 / 过期内容发起 PR 或 Issue。
- 补充示例:贡献最小可运行示例(含依赖与运行步骤)。
- 术语统一:在术语表内新增或讨论翻译方案。
- 问题反馈:指出不清晰的段落与缺失页面。
常用入口
- 快速上手:从零到首个 API 调用
- API 参考:模型、参数、限流、错误码
- Cookbook:常见场景与最佳实践
- 迁移与兼容:版本升级、弃用 API 的替代方案
- 常见问题(FAQ):网络、鉴权、计费、合规
建议你把最常访问的 3–5 个页面放到左侧导航的「常用」分组中,提高到达率。
联系方式与社区
- 加入翻译 / 合作联系:微信
starkwang_ - 也欢迎通过 GitHub 讨论区参与交流与答疑。
我们会定期整理社区问题与解答,回灌到文档中提升可发现性。
版权与声明
- 文档以学习与交流为目的进行翻译与整理;如与官方不一致,请以官方英文文档为准。
- 引用的商标与名称归其权利人所有;如涉及权利问题,请与我们联系处理。
感谢每一位贡献者的时间与心力。让中文开发者更快更稳地用好 OpenAI,就是这份文档存在的意义。