OpenAI Python 库文档:客户端用法与工作负载身份认证
该文档介绍 OpenAI Python 库的接入方式、同步与异步客户端、Responses 与 Chat Completions API、流式响应、Realtime API、分页、文件上传、Webhook 校验、错误与重试,以及基于云身份的工作负载身份认证。
用途与接入
该文档说明 OpenAI Python 库用于在 Python 3.10+ 应用中访问 OpenAI REST API,请求参数和响应字段均有类型定义,并提供同步与异步客户端;库由 OpenAPI 规范生成。文档给出的安装命令为 pip install openai,并建议用环境变量或 python-dotenv 管理 API 密钥。
主要用法
文档称 Responses API 是调用模型的主要接口,Chat Completions API 仍作为此前标准继续支持。示例覆盖文本生成、同步与异步调用、SSE 流式输出、通过 aiohttp 作为异步传输、音频与文本的 Realtime WebSocket 连接、自动分页、嵌套参数、文件上传以及 Webhook 签名校验。
认证方式
文档介绍工作负载身份认证:可使用 Kubernetes 服务账号令牌、Azure 托管身份、GCP 元数据令牌或自定义令牌提供器,并可设置令牌刷新缓冲时间。X.509 工作负载身份基于双向 TLS,默认地址为固定 mTLS 端点;文档同时列出该模式对 HTTPS、同一 API 源、请求头以及 Azure 客户端的限制。
错误与重试
连接失败或超时抛出 APIConnectionError,非成功状态码抛出 APIStatusError 子类;默认对连接错误、408、409、429 和 5xx 重试 2 次,且只在请求体可安全重发时重试。流式读取不自动重试。
限制与待核实
来源页面内容被截断,正文末尾的重试示例不完整,文档其余细节需查看完整 api.md 与迁移指南;本文未进行安装或运行验证,示例模型名称与端点行为以官方文档为准。
来源与核对说明
- API 与 SDK 文档 · openai/openai-python ↗https://github.com/openai/openai-python/blob/HEAD/README.md
本文经 AI 整理及独立自动校对,未做运行验证;自动校对仍可能遗漏问题,请以原始资料为准。
这篇内容对你有帮助吗?
点赞人数由服务器记录,收藏保存在当前浏览器。