OpenAI Python SDK 简介
OpenAI Python SDK是OpenAI官方提供的Python库,用于方便地访问OpenAI的REST API。该SDK支持Python 3.7及以上版本,提供了同步和异步两种客户端,并包含了所有请求参数和响应字段的类型定义。
OpenAI Python SDK基于httpx库构建,提供了便捷的API访问方式。它是根据OpenAI的OpenAPI规范使用Stainless自动生成的。
安装
要安装OpenAI Python SDK,只需使用pip执行以下命令:
pip install openai
值得注意的是,SDK在v1版本(2023年11月6日发布)进行了重写。如果你正在从旧版本升级,可以参考v1迁移指南,其中包含了自动更新代码的脚本。
基本用法
使用OpenAI Python SDK的基本流程如下:
- 导入OpenAI类
- 创建客户端实例
- 调用API方法
以下是一个简单的示例:
import os
fro