how to download openai的进一步展开说明

# OpenAI Python库

OpenAI Python库提供了方便的访问OpenAI API的功能，适用于使用Python语言编写的利用程序。它包括一组预定义的API资源类，这些类能够从API响应中动态地初始化自己，使其与多个版本的OpenAI API兼容。

你可以在我们的API参考和OpenAI Cookbook中找到OpenAI Python库的使用示例。

## 安装

如果你只是想使用该软件包，不需要下载源代码。只需运行以下命令便可：

“`
pip install –upgrade openai
“`

从源代码安装：

“`
python setup.py install
“`

## 可选依赖

安装openai.embeddings_utils的依赖：

“`
pip install openai[embeddings]
“`

安装Weights & Biases的支持：

“`
pip install openai[wandb]
“`

由于其体积较大，numpy和pandas等数据库不会默许安装。它们是该库的某些功能所需的，但通常不需要与API交互。如果遇到MissingDependencyError毛病，请使用以下命令安装它们：

“`
pip install openai[datalib]
“`

## 使用方法

该库需要使用你的账户的密钥进行配置，你可以在网站上找到密钥。在使用该库之前，可以将密钥设置为OPENAI_API_KEY环境变量：

“`
export OPENAI_API_KEY=’sk-…’
“`

或设置openai.api_key的值：

“`
import openai
openai.api_key = ‘sk-…’
“`

## 参数

所有终端点都有一个.create方法，该方法支持request_timeout参数。request_timeout参数接受Union[float, Tuple[float, float]]类型的数据，如果要求超过了指定的时间（以秒为单位），则会引发openai.error.Timeout毛病（参见：https://requests.readthedocs.io/en/latest/user/quickstart/#timeouts）。

## 微软Azure终端点

要使用微软Azure终端点，您需要设置api_type、api_base和api_version，和api_key。api_type一定要设置为’azure’，其他参数对应于终端点的属性。另外，部署名称一定要作为engine参数传递。

“`
import openai
openai.api_type = “azure”
openai.api_key = “…”
openai.api_base = “https://example-endpoint.openai.azure.com”
openai.api_version = “2023-05⑴5″

# 创建一个聊天完成
chat_completion = openai.ChatCompletion.create(
deployment_id=”deployment-name”,
model=”gpt⑶.5-turbo”,
messages=[{“role”: “user”, “content”: “Hello world”}]
)

# 打印聊天完成
print(chat_completion.choices[0].message.content)
“`

需要注意的是，目前微软Azure终端点仅用于完成、嵌入和微调操作。有关怎样使用Azure终端点进行微调和其他操作的详细示例，请查看以下Jupyter笔记本：

## 微软Azure Active Directory身份验证

要使用Microsoft Active Directory对Azure终端点进行身份验证，您需要将api_type设置为”azure_ad”，并将获得的凭据令牌传递给api_key。其余参数需要依照前脸部分的唆使进行设置。

“`
from azure.identity import DefaultAzureCredential
import openai

# 要求凭据
default_credential = DefaultAzureCredential()
token = default_credential.get_token(“https://cognitiveservices.azure.com/.default”)

# 设置参数
openai.api_type = “azure_ad”
openai.api_key = token.token
openai.api_base = “https://example-endpoint.openai.azure.com/”
openai.api_version = “2023-05⑴5”
“`

## 命令行界面

该库还提供了一个openai命令行实用程序，可以方便地从终端与API进行交互。运行openai api -h获得用法说明。

“`
# 列出模型
openai api models.list

# 创建一个聊天完成（gpt⑶.5-turbo、gpt⑷等）
openai api chat_completions.create -m gpt⑶.5-turbo -g “user” “Hello world”

# 创建一个完成（text-davinci-003、text-davinci-002、ada、babbage、curie、davinci等）
openai api completions.create -m ada -p “Hello world”

# 通过DALL·E API生成图象
openai api image.create -p “two dogs playing chess, cartoon” -n 1

# 通过代理使用openai
openai –proxy=http://proxy.com api models.list
“`

## 示例代码

怎样使用该Python库完成各种任务的示例代码可以在OpenAI Cookbook中找到。其中包括以下任务的代码示例：

– 使用微调进行分类
– 聚类
– 代码搜索
– 自定义嵌入
– 从文档语料库中回答问题
– 推荐
– 嵌入的可视化
– 等等

在2023年7月之前，这个OpenAI Python库在它的examples文件夹中托管了代码示例，但从那时起，所有示例都已迁移到OpenAI Cookbook中。

## 聊天完成

通过聊天完成终端点可以调用对话模型，例如gpt⑶.5-turbo。

“`
import openai
openai.api_key = “sk-…” # 替换为你自己的API密钥

completion = openai.ChatCompletion.create(
model=”gpt⑶.5-turbo”,
messages=[{“role”: “user”, “content”: “Hello world”}]
)

print(completion.choices[0].message.content)
“`

## 完成

通过完成终端点可以调用文本模型，例如babbage-002或davinci-002（和我们的旧完成模型）。

“`
import openai
openai.api_key = “sk-…” # 替换为你自己的API密钥

completion = openai.Completion.create(
model=”davinci-002″,
prompt=”Hello world”
)

print(completion.choices[0].text)
“`

## 嵌入

在OpenAI Python库中，嵌入表示将文本字符串表示为固定长度的浮点数向量。嵌入的设计目的是衡量文本字符串之间的类似性或相关性。

你可使用以下Python代码来获得文本字符串的嵌入：

“`
import openai
openai.api_key = “sk-…” # 替换为你自己的API密钥

text_string = “sample text” # 要嵌入的文本
model_id = “text-embedding-ada-002″ # 嵌入模型

embedding = openai.Embedding.create(
input=text_string,
model=model_id
)[‘data’][0][’embedding’]
“`

有关怎样调用嵌入方法的示例，请参阅嵌入指南。

在以下Jupyter笔记本中共享了怎样使用嵌入的示例代码：

对嵌入和OpenAI提供的嵌入类型的更多信息，请浏览OpenAI文档中的嵌入指南。

## 微调

使用训练数据对模型进行微调，可以改良结果（通过让模型学习更多示例）并下降API调用的本钱/延迟，由于不需要在提示中包括训练示例。

“`
# 创建一个已上传文件的微调作业
openai.FineTuningJob.create(
training_file=”file-abc123″,
model=”gpt⑶.5-turbo”
)

# 列出最多10个微调作业
openai.FineTuningJob.list(limit=10)

# 检索微调作业的状态
openai.FineTuningJob.retrieve(“ft-abc123”)

# 取消一个作业
openai.FineTuningJob.cancel(“ft-abc123″)

# 列出一个微调作业的最多10个事件
openai.FineTuningJob.list_events(id=”ft-abc123”, limit=10)

# 删除一个微调模型（一定要是创建该模型所在组织的所有者）
openai.Model.delete(“ft-abc123”)
“`

有关微调的更多信息，请浏览OpenAI文档中的微调指南。

## 审查

OpenAI提供了一个审查终端点，可以用于检查内容会不会符合OpenAI的内容政策。

“`
import openai
openai.api_key = “sk-…” # 替换为你自己的API密钥

moderation_resp = openai.Moderation.create(
input=”Here is some perfectly innocuous text that follows all OpenAI content policies.”
)
“`

有关详细信息，请参阅审查指南。

## 图象生成（DALL·E）

“`
import openai
openai.api_key = “sk-…” # 替换为你自己的API密钥

image_resp = openai.Image.create(
prompt=”two dogs playing chess, oil painting”,
n=4,
size=”512×512″
)
“`

## 音频转录（Whisper）

“`
import openai
openai.api_key = “sk-…” # 替换为你自己的API密钥

f = open(“path/to/file.mp3”, “rb”)
transcript = openai.Audio.transcribe(“whisper⑴”, f)
“`

## 异步API

该API支持异步调用方法，只需在网络绑定方法前加上a便可。

“`
import openai
openai.api_key = “sk-…” # 替换为你自己的API密钥

async def create_chat_completion():
chat_completion_resp = await openai.ChatCompletion.acreate(
model=”gpt⑶.5-turbo”,
messages=[{“role”: “user”, “content”: “Hello world”}]
)
“`

为了使异步要求更加高效，您可以传入自己的aiohttp.ClientSession，但是一定要在程序/事件循环结束时手动关闭客户端会话：

“`
import openai
from aiohttp import ClientSession

openai.aiosession.set(ClientSession())

# 在程序最后，关闭http会话
await openai.aiosession.get().close()
“`

更多详细信息，请参阅用法指南。

## 环境要求

Python 3.7.1+

通常，我们希望支持我们的客户在使用的Python版本。如果你在任何版本问题上遇到问题，请在我们的支持页面上提供反馈。

how to download openai的常见问答Q&A