OpenAI 使用政策

在继续之前，请查看OpenAI 使用政策，如果您还没有，请在OpenAI 主页上创建一个帐户。您还可以查看条款和政策页面上的其他法律文件。

基本 OpenAI 概念

第 1 章中介绍的概念对于使用 OpenAI API 和库也是必不可少的。

图 2-1  OpenAI Playground界面 - 文本完成模式

警告

从现在开始请小心，它并没有那么贵，但每次点击“提交”时，您都会使用您的信用额度。

图 2-2  OpenAI playground 界面——聊天模式

图 2-3  OpenAI playground界面 - 插入模式

图 2-4  OpenAI playground界面 - 编辑模式

图 2-5  示例下拉列表

图 2-6  “语法标准英语”的示例提示

import openai 
openai.api_key = os.getenv("OPENAI_API_KEY") 
response = openai.Completion.create( model="text-DaVinci-003", prompt="As Descartes said, I think therefore", temperature=0.7, max_tokens= 3, top_p=1, frequency_penalty=0, presence_penalty=0 
)

本节介绍了 OpenAI Playground，它是一个方便、用户友好的平台，无需编码即可测试 OpenAI 语言模型。探索了 Playground 中的不同模式和选项，突出了它在处理不同任务和生成所需输出方面的多功能性。本节还讨论了如何保存自定义预设、查看集成代码示例以及将预设示例用于特定任务。

OpenAI 访问和 API 密钥

OpenAI 要求您拥有 API 密钥才能使用其服务。此密钥有两个用途：首先，它授予调用 API 方法的权利，其次，它将您的 API 调用链接到您的帐户以用于计费目的。只有使用此密钥才能从您的应用程序调用 OpenAI 服务。

要获取 OpenAI API 密钥，请导航至OpenAI 平台页面。在右上角，单击您的帐户名末尾，然后单击“查看 API 密钥”，如图2-7所示。

当您在“ API keys ”页面上时，单击“ Create new secret key ”并复制您的密钥。这个密钥是以'sk-'开头的一长串字符。

获得密钥后，最佳做法是将其导出为环境变量。这将允许您的应用程序访问 API 密钥，而无需直接在您的代码中写入它。

在 Linux 环境下：

// set environment variable OPENAI_API_KEY for current sessionexport OPENAI_API_KEY=sk-(...)
// check that environment variable was set
echo $OPENAI_API_KEY

在 Windows 环境中：

// set environment variable OPENAI_API_KEY for current sessionset OPENAI_API_KEY=sk-(...)
// check that environment variable was set
echo %OPENAI_API_KEY%

此代码片段将设置一个环境变量，并使您的密钥可用于从同一 shell 会话启动的其他进程。对于 Linux 系统，也可以将此行直接添加到您的 .batchrc 文件中。这将允许在所有 shell 会话中访问您的环境变量。

要在 Windows 11 中永久添加/更改环境变量，请同时按“Windows+R”。它将打开“运行程序或文件”窗口。在此窗口中，键入“sysdm.cpl”直接转到“系统属性”面板，然后单击“高级”选项卡，然后单击“环境变量”按钮。在那里，您可以使用您的 OpenAI 密钥添加一个新的环境变量。

现在您已经有了密钥，是时候使用 OpenAI API 编写您的第一个 Hello World 了。

使用 OpenAI 的 Hello World

本节将展示 OpenAI Python 库的第一行代码。我们将从一个经典的 Hello World 示例开始，以了解 OpenAI 如何提供其服务。

可以使用 pip 轻松安装此 Python 库：

pip install openai

接下来，可以在 Python 中直接访问 OpenAI API：

import openai
# call the openai ChatCompletion endpoint
response = openai.ChatCompletion.create(model="gpt-3.5-turbo",messages=[{"role": "user", "content": "Hello World!"}]
)
# extract the response
print(response['choices'][0]['message']['content'])

恭喜！您刚刚使用 OpenAI Python 库编写了您的第一个程序。

我们将在接下来的段落中详细介绍使用该库的细节。

您会注意到此代码段中未引用 OpenAI API 密钥。

实际上，OpenAI 库默认会查找“OPENAI_API_KEY”环境变量。另一种选择是直接使用以下代码片段进行设置：

# 加载你的 API 密钥
openai.api_key = os.getenv("OPENAI_API_KEY")

openai api chat_completions.create -m gpt-3.5-turbo -g user "Hello world"

import openai# For GPT 3.5 Turbo, the endpoint is ChatCompletionopenai.ChatCompletion.create(# For GPT 3.5 Turbo, the model is “gpt-3.5-turbo”model="gpt-3.5-turbo",# Conversation as a list of messages. messages=[{"role": "system", "content": "You are a helpful teacher."},{"role": "user", "content": "Is there other measures than time complexity for an algorithm?"},{"role": "assistant", "content": "Yes, there are other measures besides time complexity for an algorithm, such as space complexity."},{"role": "user", "content": "What is it?"}])

在此示例中，您使用最少数量的参数，即用于进行预测的 LLM 和输入消息。正如我们在此示例中所见，输入消息中的对话格式允许将多个交换发送到模型。请注意，不会存储发送到模型 API 调用的消息。问题“What is it?"指的是以前的答案，只有在模型知道这个答案的情况下才有意义。每次都必须发送整个对话以模拟聊天会话。我们将在下一节中详细介绍输入选项。

聊天完成端点的输入选项

我们现在将更详细地介绍如何使用openai.ChatCompletion端点及其create 方法。

聊天完成端点的输出结果格式：

现在您已经掌握了查询基于聊天的模型的所有信息，让我们看看如何使用这些结果。

Hello World 示例的完整响应是以下 Python 对象：

{"choices": [{"finish_reason": "stop","index": 0,"message": {"content": "Hello there! How may I assist you today?","role": "assistant"}}],"created": 1681134595,"id": "chatcmpl-73mC3tbOlMNHGci3gyy9nAxIP2vsU","model": "gpt-3.5-turbo","object": "chat.completion","usage": {"completion_tokens": 10,"prompt_tokens": 11,"total_tokens": 21}

choices array of “choice” object

这是响应的基本部分：此数组包含模型的实际响应。默认情况下，这个数组只有一个元素，可以用参数n改变（见上一段）。这个元素包含

finish_reason string

模型回答结束的原因。在我们的“Hello World”示例中，我们可以看到finish_reason isstop 这意味着我们收到了来自模型的完整响应。如果在输出生成过程中出现错误，它将出现在该字段中。

index integer

选择数组中选择对象的索引。

message object

消息对象包含两个属性：角色和内容。角色永远是助理，内容包括模型生成的文本。通常我们要获取的是这个字符串：response['choices'][0]['message']['content']

created timestamp

生成时时间戳格式的日期。在我们的“Hello World”示例中，此时间戳转换为 2023 年 4 月 10 日星期一下午 1:49:55。

id string

OpenAI 内部使用的技术标识符。

model string

使用的模型。这与模型设置为输入相同

object string

应该始终chat.completion用于 GPT-4 和 GPT3.5 模型，因为我们正在使用 chat.completion 端点。

usage string

usage 对象很重要：它提供有关此查询中使用的令牌数量的信息，因此为您提供定价信息。表示prompt_tokens 输入中使用的标记数， 是completion_tokens 输出中的标记数，您可能已经猜到了， total_tokens = prompt_tokens + completion_tokens

如果您希望有多个选择并使用n 大于一个的参数，您会注意到该prompt_tokens 值不会改变，但该completion_tokens 值将大致乘以n。

import openai
# call the openai Completion endpoint
response = openai.Completion.create(model="text-DaVinci-003",prompt="Hello World!"
)
# extract the response
print(response['choices'][0]['message']['content'])

此代码片段将输出一个完成，例如：

"\n\nIt's a pleasure to meet you. I'm new to the world"

但是，您仍然可以以对话方式与文本完成模型进行交互。

Explain what is meant by time complexity.

您可能不会得到问题的答案，而是像这样完成：

Explain what is meant by space complexity. Explain what is meant by the big-O notation.

但是，提示：

Question: Explain what is meant by time complexity.
Answer:

会给你满意的答复：

文本完成端点的输入选项

的输入选项集openai.Completion.create 与我们之前在聊天端点中看到的非常相似。同样，我们将通过主要输入参数，考虑提示长度的影响

model string Required

prompt string or array (default: <|endoftext|>)

max_tokens integer

suffix string (default: null)

文本完成端点的输出结果格式：

现在您已拥有查询基于文本的模型所需的所有信息，您会发现结果与 Chat Endpoint 结果非常相似。

以下是我们使用达芬奇模型的 Hello World 示例的示例输出：

{"choices": [{"finish_reason": "stop","index": 0,"logprobs": null,"text": "<br />\n\nHi there! It's great to see you."}],"created": 1681883111,"id": "cmpl-76uutuZiSxOyzaFboxBnaatGINMLT","model": "text-DaVinci-003","object": "text_completion","usage": {"completion_tokens": 15,"prompt_tokens": 3,"total_tokens": 18}
}

# Call the openai Edit endpoint, with the text-DaVinci-edit-001 modelresponse = openai.Edit.create(model="text-DaVinci-edit-001",input="A young man is going on a trip. Before leaving, he said goodbye to his friend and parcked his suitcase.",instruction="Change the main character to an old woman")# extract the responseprint(response['choices'][0]['text']) 

文本编辑端点的输出结果格式与我们之前看到的类似；因此，这里没有必要对其进行详细描述。

警告

对英语以外的语言的支持是有限的。

警告

的准确度text-moderation-stable可能略低于text-moderation-latest。

response = openai.Moderation.create(model='text-moderation-latest',input="I want to kill my neighbor.",)

我们来看看审核端点的输出结果：

{"id": "modr-7AftIJg7L8jqGIsbc7NumObH4j0Ig","model": "text-moderation-004","results": [{"categories": {"hate": false,"hate/threatening": false,"self-harm": false,"sexual": false,"sexual/minors": false,"violence": true,"violence/graphic": false},"category_scores": {"hate": 0.0400671623647213,"hate/threatening": 3.671687863970874e-06,"self-harm": 1.3143378509994363e-06,"sexual": 5.508050548996835e-07,"sexual/minors": 1.1862029225540027e-07,"violence": 0.9461417198181152,"violence/graphic": 1.463699845771771e-06},"flagged": true}]}

审核端点的输出结果提供以下信息：

model string

flagged boolean

如果模型将内容识别为违反 OpenAI 的使用政策，则将其设置为 true；否则，将其设置为 false。

categories dict 

包括带有用于策略违规类别的二进制标志的字典。对于每个类别，如果模型识别出违规，则该值为 true，否则为 false。

category_scores dict 

该模型提供了一个字典，其中包含特定类别的分数，显示输入违反该类别的 OpenAI 政策的置信度。分数范围从 0 到 1，分数越高表示越有信心。这些分数不应被视为概率。

警告

OpenAI 会定期改进审核系统。因此，基于类别分数的自定义规则可能需要随着时间的推移进行调整。

定价和代币限制

如果不更仔细地研究使用 OpenAI 模型所产生的成本，我们就不能再进一步了。

OpenAI 将其模型的定价列在其定价页面上。

请注意，OpenAI 不一定会维持此定价，并且成本可能会随时间变化。

在撰写本书时，最常用的 OpenAI 模型的定价如下：

从中有几点需要注意：

• DaVinci 模型的成本是 GPT-3.5 Turbo 的 10 倍。我们建议仅在您希望进行一些微调时才使用达芬奇（目前只有达芬奇可以进行微调）。我们将在第四章中看到更多关于微调的内容。

• GPT-3.5 Turbo 也比 GPT-4 型号便宜。GPT-4 和 GPT-3.5 模型之间的差异与许多基本任务无关。然而，在复杂的推理情况下，GPT-4 的表现远远优于之前的任何模型。

• GPT-4 模型具有与 GPT-3.5 Turbo 和DaVinci 模型不同的定价系统：它们区分输入（提示）和输出（完成）

• GPT-4 允许上下文的长度是原来的两倍，甚至可以达到 32k 个标记，相当于超过 25,000 个文本单词。GPT-4 支持使用案例，例如长篇内容创建、高级对话以及文档搜索和分析……需要付费。

安全和隐私：警告！

在撰写本书时，OpenAI 声称作为输入发送到模型的数据不会用于再训练，除非您决定选择加入。但是，出于监控和使用合规性检查目的，您的输入会保留 30 天。这意味着 OpenAI 员工以及专业的第三方承包商可以访问您的 API 数据。

我们建议您查看OpenAI 的数据使用政策以获取最新信息，因为这可能会发生变化。

如果您是国际用户，请注意您的个人信息和您作为输入发送的数据可能会从您所在的位置传输到美国的 OpenAI 设施和服务器。这可能会对您的应用程序创建产生一些法律影响。

使用 DALL-E 生成图像

2021 年 1 月，OpenAI 推出了 DALL-E，这是一种能够根据自然语言描述创建逼真的图像和艺术品的人工智能系统。DALL-E 2 以更高的分辨率、更好的输入文本理解能力和新功能使技术更进一步。DALL-E 的两个版本都是通过在图像及其文本描述上训练一个转换器模型创建的。您可以通过 API 和实验室界面试用 DALL-E 2 。

嵌入

由于模型依赖于数学函数，因此它需要数值输入来处理信息。但是，许多元素（例如单词或标记）并不是天生的数字。为了克服这个问题，嵌入将这些概念转换为数值向量。嵌入允许计算机通过用数字表示它们来更有效地理解这些概念之间的关系。在某些情况下，访问嵌入可能很有用，OpenAI 提供了一个模型，可以将文本转换为数字向量。嵌入端点允许开发人员获得输入文本的矢量表示。然后可以将该向量表示用作其他 ML 模型和 NLP 算法的输入。

嵌入的原理是向量化两个文本字符串并衡量它们的相关性。

有了这个想法，您可以有各种用例：

搜索 ： 按与查询字符串的相关性对结果进行排序

建议 ：推荐包含与查询字符串相关的文本字符串的文章

聚类 ：按相似性对字符串进行分组

异常检测 ：查找与其他文本字符串无关的文本字符串

完整的文档可以在OpenAI 的参考文档中找到。

Whisper

它是一种用于语音识别的通用模型。它是在大型音频数据集上训练的，也是一个多任务模型，可以执行例如多语言语音识别、语音翻译和语言识别。OpenAI 的Whisper 项目的 GitHub 页面上提供了一个开源版本。

提示

GPT-3.5 Turbo 是大多数用例的最佳选择：比旧型号更强大，而且最便宜。

print(response['choices'][0]['message']['content'])

警告

切勿通过 OpenAI 端点发送敏感数据，例如个人信息或密码

提示

不要忘记查看定价页面，并使用tiktoken来估算使用成本。