openai api使用教程的进一步展开说明

怎样使用 OpenAI ChatGPT API 开发您的第一个 Python 程序并创建聊天机器人助手

介绍

OpenAI 最近推出了具有革命性和易于使用的人工智能模型“ChatGPT”，并将其作为 API 提供给开发者使用。该模型目前与 Whisper API 一起提供，后者还用于文本到语音的解决方案。通过 ChatGPT API，您可以创建自定义的对话代理和机器人，为您编写 Python 代码，起草电子邮件或其他任何文件，并将您的产品/利用程序/服务或软件与消费者的自然语言界面集成在一起。

入门

先决条件

在开始之前，您需要确保具有以下条件：
– OpenAI 帐户：如果您没有 OpenAI 帐户，请访问 OpenAI 网站并注册一个帐户。
– API 密钥：生成您的帐户专属 API 密钥，您可以在 OpenAI 网站上生成密钥。

设置环境

首先，您需要安装 Python 和 pip，以便在您的开发环境中使用 OpenAI API 密钥。以下是在区别操作系统上安装 Python 和 pip 的步骤：
– 对 Linux：如果您的发行版是 Ubuntu 或其他现代 Linux 发行版，则已默许安装了 Python。如果未安装 pip，请使用以下命令安装：
“`
sudo apt install python3-pip
“`
– 对 Windows：如果您还没有安装 Python，请前往官方网站并下载适用于 Windows 的 Python 安装程序。Python 安装程序包括了 pip 的安装，因此无需额外安装。

接下来，将您的 OpenAI API 密钥设置为环境变量，而不是在程序中直接使用它。这样做有助于安全性和可配置性。您可以按以下方式设置环境变量：

– 对 Windows：设置一个名为“API_KEY”的环境变量，并将其值设置为您的 API 密钥。

– 对 Linux：使用 root 权限打开文件`/etc/environment`，在文件末尾添加以下内容，并将``替换为您的 API 密钥。
“`
API_KEY=””
“`

为了在程序中使用设置的密钥路径，您可以在代码中添加以下语句：
“`
openai.api_key_path =
“`

如果您使用的是基于文件的密钥访问方式，请在您的代码中使用以下语句：
“`
openai.api_key=”your key here”
“`

请确保在使用密钥时验证其准确性和有效性，以避免出现身份验证毛病。

安装 OpenAI API

最后一步是安装 OpenAI API 的 Python 库，以便在程序中使用它。您可使用以下命令安装 OpenAI API：
“`
pip install openai
“`

安装完成后，您的开发环境已准备就绪。

编写聊天助手代码

OpenAI API 提供了多种接口模式，包括“聊天补全”、“代码补全”、“图象生成”等。在本指南中，我们将使用 API 的“聊天补全”功能来创建一个简单的对话聊天机器人。

首先，请在您的 Python 程序中导入 OpenAI 库：
“`python
import openai
“`

在程序中添加以上导入语句后，确保您已启用 API 密钥。您可使用之前设置的环境变量或直接将密钥值放置在代码中。以下是两种设置密钥的方法：
“`python
openai.api_key=”your key here” # 直接在代码中使用密钥
openai.api_key=”your environment variable” # 使用设置的环境变量
openai.api_key_path = # 使用密钥路径的方法
“`

现在，让我们来看一下 OpenAI 聊天 API 的基本功能。该函数接受一个包括多个 JSON 参数的调用。其中，主要参数是`”role”`和`”content”`。

以下是使用 OpenAI API 的`create`函数来调用聊天完成服务的示例代码：
“`python
openai.ChatCompletion.create(
model=”gpt⑶.5-turbo”,
messages=[
{“role”: “system”, “content”: “You are a helpful assistant.”},
{“role”: “user”, “content”: “Who won the world series in 2023?”},
{“role”: “assistant”, “content”: “The Los Angeles Dodgers won the World Series in 2023.”},
{“role”: “user”, “content”: “Where was it played?”}
]
)
“`

在上述代码中，我们可以看到区别的角色：`system`、`user`和`assistant`。
– `system` 角色唆使 API 如何行动，可以理解为 OpenAI 的主要提示。
– `user` 角色用于向机器人发问，其内容可以是单行或多行文本。
– `assistant` 角色用于附加回复，以便 API 能够记住对话的上下文。

请注意，在一条消息中，您可以发送多个角色。上述代码片断中的系统提示、用户问题和历史记录都可以在一条消息中发送。

现在，我们可以定义一个数组来保存 OpenAI 消息的全部对话内容。然后，我们需要提示用户输入系统信息并将其添加到消息列表中：
“`python
messages = []
system_message = input(“What type of chatbot do you want me to be?”)
messages.append({“role”: “system”, “content”: system_message})
“`

完成设置后，我们再次提示用户提供关于对话的更多问题。您可使用 Python 的输入功能（或任何其他文件输入方法），并将用户的回答添加到消息列表中作为 `user` 角色：
“`python
print(“Alright! I am ready to be your friendly chatbot.” + “ ” + “You can now type your messages.”)
message = input(“”)
messages.append({“role”: “user”, “content”: message})
“`

现在，我们已准备好将数组和基本的 JSON 输入传递给 OpenAI API。您只需在代码中调用创建 JSON 的函数，并指定聊天完成服务的模型型号和消息列表：
“`python
response = openai.ChatCompletion.create(
model=”gpt⑶.5-turbo”,
messages=messages
)
“`

最后，我们可以打印 API 的响应或解析它以获得正确的格式。响应是一个 JSON 对象，其中包括一个内容为响应的消息数组。您可以通过读取该消息数组中的第一个对象，并获得其内容来输出回复：
“`python
reply = response[“choices”][0][“message”][“content”]
print(reply)
“`

现在，您的程序已具有聊天机器人的基本功能，并能输出 API 提供的回答。

运行代码

您可以在您喜欢的 Python IDE 中运行代码，或直接从命令行运行代码：
“`
python OpenAIDemo.py
“`

格式化输出

以下是正确格式化的对话输出的示例：
“`
系统：You are a helpful assistant.
用户：Who won the world series in 2023?
助手：The Los Angeles Dodgers won the World Series in 2023.
用户：Where was it played?
助手：The 2023 World Series was played in Arlington, Texas at the Globe Life Field, which is the new home stadium for the Texas Rangers.
“`

完全代码

下面是上述示例中用于创建聊天助手的完全代码：
“`python
import openai

# 设置 OpenAI API 密钥
openai.api_key = “your key here”

# 提示用户输入系统信息
messages = []
system_message = input(“What type of chatbot do you want me to be?”)
messages.append({“role”: “system”, “content”: system_message})

# 提示用户输入问题和对话的其他部份
print(“Alright! I am ready to be your friendly chatbot.” + “ ” + “You can now type your messages.”)
message = input(“”)
messages.append({“role”: “user”, “content”: message})

# 调用 OpenAI API 获得回答
response = openai.ChatCompletion.create(
model=”gpt⑶.5-turbo”,
messages=messages
)

# 输出回答
reply = response[“choices”][0][“message”][“content”]
print(reply)
“`

openai api使用教程的常见问答Q&A