Repolode
openai

openai/openai-python

OpenAI 官方 Python SDK,提供同步与异步客户端,并带有完整类型定义。

Star
31,893
Fork
8,476
未关闭 Issue
147
最近提交
3小时前

这是什么?

openai-python 是 OpenAI REST API 的官方 Python 客户端,支持 Python 3.10 及以上版本。它基于 HTTPX2 提供同步和异步两种客户端,所有请求参数和响应字段都有类型定义,代码由 OpenAI 的 OpenAPI 规范生成。

主要接口是 Responses API,同时保留对 Chat Completions API 的支持。库中还包括基于 Server-Sent Events 的流式输出、通过 WebSocket 连接的 Realtime API(支持文本和音频)、自动翻页的列表方法、文件上传、Webhook 签名校验,以及可配置超时和自动重试。响应对象为 Pydantic 模型,并提供 to_json()、to_dict() 等辅助方法。

该 SDK 还可通过 AzureOpenAI 类对接 Azure OpenAI,并可通过 Bedrock 提供方配置对接 Amazon Bedrock 的 OpenAI 兼容接口,由其处理 AWS 认证。此外还支持 Kubernetes、Azure、GCP 的工作负载身份认证以及 X.509 双向 TLS。

核心功能

  • 01同步与异步客户端接口一致
  • 02请求参数为 TypedDict,响应为 Pydantic 模型
  • 03通过 Server-Sent Events 实现流式输出
  • 04基于 WebSocket 的 Realtime API,支持文本和音频
  • 05列表方法自动翻页,并提供文件上传支持
  • 06Webhook 签名校验与负载解析
  • 07自动重试,超时时间可配置

适用场景

  • 在 Python 后端中通过 Responses 或 Chat Completions API 调用 OpenAI 模型
  • 为异步 Web 服务增加流式文本生成
  • 使用 Realtime API 构建低延迟的语音或文本对话应用
  • 借助相同的客户端代码对接 Azure OpenAI 或 Amazon Bedrock

快速上手

  1. 1

    从 PyPI 安装库

    pip install openai
  2. 2

    在 OPENAI_API_KEY 环境变量中设置你的 API 密钥

  3. 3

    按照 README 示例创建客户端并调用 Responses API

使用前须知

  • 需要 OpenAI API 密钥,并且使用请求需要付费的 OpenAI API 额度。
  • 需要 Python 3.10 或更高版本。

标签

常见问题

openai-python 是什么?
OpenAI 官方 Python SDK,提供同步与异步客户端,并带有完整类型定义。 openai-python 是 OpenAI REST API 的官方 Python 客户端,支持 Python 3.10 及以上版本。它基于 HTTPX2 提供同步和异步两种客户端,所有请求参数和响应字段都有类型定义,代码由 OpenAI 的 OpenAPI 规范生成。
openai-python 可以免费使用吗?用的什么许可证?
openai-python 以 Apache-2.0 许可证开源。用于商业产品前,请先确认许可证条款。
openai-python 还在维护吗?
活跃维护中。openai-python 最近一次提交是在 2026年10月20日。
openai-python 适合用来做什么?
在 Python 后端中通过 Responses 或 Chat Completions API 调用 OpenAI 模型 为异步 Web 服务增加流式文本生成 使用 Realtime API 构建低延迟的语音或文本对话应用 借助相同的客户端代码对接 Azure OpenAI 或 Amazon Bedrock
openai-python 怎么安装和运行?
从 PyPI 安装库: pip install openai 在 OPENAI_API_KEY 环境变量中设置你的 API 密钥 按照 README 示例创建客户端并调用 Responses API
在哪里获取 openai-python?
源代码和安装说明在 GitHub 上:https://github.com/openai/openai-python

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目