openai-python

OpenAI Python 项目介绍

OpenAI Python 项目旨在通过简单明晰的方式，让开发者能够在Python应用中轻松访问OpenAI的REST API。该库支持Python 3.8及以上版本，能与各类Python应用无缝结合，提高开发效率。

功能概述

OpenAI Python库为Python开发者提供了对OpenAI REST API的便捷访问方式。其主要功能包括：

• 同步和异步支持：利用httpx这一强大的库，该项目支持同步和异步方式访问API，方便不同需求的开发者选择适合自己的方式。
• 详细的类型定义：所有请求参数和响应字段均有详尽的类型定义，增强了代码的可读性和与编辑器的自动补全功能。
• 自动生成：该库基于OpenAI的OpenAPI规范生成，充分确保与API的兼容性和文档的一致性。

使用文档

完整的REST API文档可以在platform.openai.com找到。有关OpenAI Python库中API的详细说明则记录在api.md中。

安装方式

要使用OpenAI Python库，你可以通过以下命令直接从PyPI下载安装：

pip install openai

注意，自2023年11月6日发布的v1版本起，SDK进行了重写。参阅v1迁移指南，以快速适应新版本的变更。

基本用法

使用此库时，推荐通过环境变量来设置API密钥以确保安全，例如将OPENAI_API_KEY存储在.env文件中：

import os
from openai import OpenAI

client = OpenAI(api_key=os.environ.get("OPENAI_API_KEY"))

chat_completion = client.chat.completions.create(
    messages=[
        {"role": "user", "content": "这是一个测试"}
    ],
    model="gpt-3.5-turbo",
)

专为视觉和异步用例设计

该库支持包括图像在内的多模态输入，并支持异步API调用，通过异步客户端AsyncOpenAI与await实现异步请求，以提高应用的响应速度。

异常处理

OpenAI Python项目提供了全面的错误处理机制。如果发生网络连接失败或者API返回非成功状态码，即可通过相应的错误类捕获异常，例如连接错误将引发openai.APIConnectionError，而429状态码将引发openai.RateLimitError。

版本与贡献

OpenAI Python项目严格遵循SemVer版本管理规范。开发团队认真对待向前兼容问题，以保证平滑的升级体验。对项目有任何疑问、建议或反馈，欢迎在GitHub上提交问题。

系统要求

要求运行环境安装有Python 3.8或以上版本。

通过以上功能特性，OpenAI Python项目为开发者提供了强大的工具集，让AI模型的融合变得更加便捷高效。