import openai openai.api_key的进一步展开说明

## OpenAI Python库

OpenAI Python库允许使用Python语言编写的利用程序方便地访问OpenAI API。它包括一组预定义的API资源类，这些类可以根据API响应动态初始化自己，使其与各种版本的OpenAI API兼容。

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

## 安装

首先，请确保您已安装了Python 3.7.1或更新的版本。如果你只想使用这个包，运行以下命令进行安装：

“`
pip install –upgrade openai
“`

安装完包后，在文件的顶部导入它：

“`
import 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设置为其值：

“`
openai.api_key = “sk-…”
“`

在OpenAI Cookbook中可以找到使用此库完成各种任务的示例。其中包括了以下任务的代码示例：使用微调进行分类、聚类、代码搜索、自定义嵌入、从文档语料库中回答问题、推荐、嵌入可视化等等。

大多数终端支持request_timeout参数。此参数接受一个Union[float, Tuple[float, float]]，如果要求的时间超过指定的秒数将引发openai.error.Timeout毛病（参见： https://requests.readthedocs.io/en/latest/user/quickstart/#timeouts）。

### 对话完成

可使用聊天完成端点调用gpt⑶.5-turbo和gpt⑷等聊天模型。

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

您可以在我们的聊天完成指南中了解更多信息。

### 完成

可使用babbage-002或davinci-002等文本模型（和我们的传统完成模型）调用完成端点。

“`
completion = openai.Completion.create(model=”davinci-002″, prompt=”Hello world”)
print(completion.choices[0].text)
“`

您可以在我们的完成指南中了解更多信息。

### 嵌入

嵌入旨在衡量文本字符串之间的类似性或相关性。要为文本字符串获得嵌入，可使用以下代码：

“`
text_string = “sample text”
model_id = “text-embedding-ada-002″
embedding = openai.Embedding.create(input=text_string, model=model_id)[‘data’][0][’embedding’]
“`

您可以在我们的嵌入指南中了解更多信息。

## 微调

通过使用训练数据对模型进行微调，可以改良结果（通过向模型提供更多示例来使其学习）并下降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:gpt⑶.5-turbo:acemeco:suffix:abc123″)
“`

您可以在我们的微调指南中了解更多信息。

要将微调的训练结果记录到Weights & Biases中，请使用以下命令：

“`
openai wandb sync
“`

有关更多信息，请浏览Weights & Biases上的wandb文档。

## 过滤

OpenAI提供了一个不要钱的过滤端点，可用于检查内容会不会符合OpenAI的内容政策。

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

您可以在我们的过滤指南中了解更多信息。

图象生成（DALL·E）

DALL·E是一个生成图象模型，可以根据提示创建新图象。

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

您可以在我们的图象生成指南中了解更多信息。

语音（Whisper）

语音到文本API基于我们的最新开源大型v2 Whisper模型，提供了两个端点，即转录和翻译。

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

您可以在我们的语音转文本指南中了解更多信息。

Async API

通过在网络绑定方法前添加“a”前缀，API中提供了异步支持的功能。

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

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

“` python
from aiohttp import ClientSession
openai.aiosession.set(ClientSession())

# 在程序结束时关闭http会话
await openai.aiosession.get().close()
“`

命令行界面

该库还提供了一个`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
“`

## Microsoft Azure端点

要将该库与Microsoft Azure端点一起使用，除设置api_key，还需要设置api_type、api_base和api_version参数。api_type一定要设置为’azure’，而其他参数对应于您的端点属性。另外，一定要将部署名称作为engine参数传递。

“` python
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)
“`

请注意，目前Microsoft Azure端点只能用于完成、嵌入和微调操作。有关怎样使用Azure端点进行微调和其他操作的详细示例，请查看以下Jupyter笔记本：
Microsoft Azure Active Directory身份验证

要使用Microsoft Active Directory进行身份验证Azure端点，需要将api_type设置为”azure_ad”，并将获得的凭据令牌传递给api_key。其余参数需要依照上一节中的说明设置。

“` python
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”
“`

## 致谢

该库是从Stripe Python Library中分支出来的。

我是一位专业的文案撰稿人，能写出详细而有思想的博客文章。

import openai openai.api_key的常见问答Q&A

import openai

# 身份验证
openai.api_key = "YOUR_API_KEY"

# 发起API要求
response = openai.Completion.create(
  engine="davinci",
  prompt="Once upon a time",
  max_tokens=100
)

# 处理API响应
result = response.choices[0].text.strip()
print(result)
    

import openai

# 身份验证
openai.api_key = "YOUR_API_KEY"

# 发起API要求
response = openai.Completion.create(
  engine="davinci",
  prompt="Once upon a time",
  max_tokens=100
)

# 处理API响应
result = response.choices[0].text.strip()
print(result)