Python与OpenAI API基础

开始使用 Python 和 OpenAI

将 OpenAI 的强大功能集成到您自己的应用程序中比您想象的要容易。只需几行 Python 代码，您就可以开始与世界上最先进的语言模型进行交互。本指南将引导您完成设置过程，并进行您的第一个 API 调用。

第一步：安装库

首先，您需要在您的 Python 环境中安装 OpenAI 官方库。这个库简化了与 OpenAI API 的通信。打开您的终端或命令提示符，然后运行以下命令：

pip install openai

这个命令会使用 Python 的包管理器 pip 来下载并安装最新版本的 openai 库，为您的代码与 OpenAI 服务对话做好准备。

第二步：设置您的 API 密钥

您的 API 密钥是独一无二的凭证，用于验证您对 OpenAI 服务的请求。把它想象成您代码的密码。保护好它是至关重要的。

将密钥直接写在代码中是一种不好的做法。更好的方法是将其设置为环境变量。这样，您的代码可以访问它，而无需将其暴露在脚本文件中。

您可以在您的 OpenAI 帐户设置页面找到您的 API 密钥。获得密钥后，请根据您的操作系统在终端中设置环境变量：

对于 macOS 或 Linux：

export OPENAI_API_KEY='你的密钥'

对于 Windows：

set OPENAI_API_KEY='你的密钥'

请将 '你的密钥' 替换为您自己的实际 API 密钥。请注意，这种设置方法只在当前的终端会话中有效。要使其永久生效，您需要将其添加到您终端的启动配置文件中（例如 .zshrc 或 .bash_profile）。

第三步：编写您的第一个脚本

一切准备就绪，现在让我们来编写一些 Python 代码。我们将初始化 OpenAI 客户端，并向模型发送一个简单的消息。

创建一个名为 test_openai.py 的新文件，并将以下代码粘贴进去。

# 导入 openai 库
from openai import OpenAI

# 初始化客户端
# 它会自动从名为 OPENAI_API_KEY 的环境变量中读取密钥
client = OpenAI()

# 发送请求到 API
response = client.chat.completions.create(
  model="gpt-3.5-turbo",
  messages=[
    {"role": "user", "content": "用中文讲一个关于编程的笑话。"}
  ]
)

# 打印模型的回复
print(response.choices[0].message.content)

让我们分解一下这段代码：

from openai import OpenAI：我们从库中导入 OpenAI 类。
client = OpenAI()：我们创建了 OpenAI 类的一个实例。如果您已经正确设置了环境变量，库会自动找到并使用您的 API 密钥。
client.chat.completions.create(...)：这是执行 API 调用的核心部分。我们正在使用“聊天补全”功能。
model="gpt-3.5-turbo"：我们指定要使用的模型。
messages=[...]：我们以列表的形式提供对话历史。在这里，我们只发送了一条来自 "user" 的消息，内容是 "用中文讲一个关于编程的笑话。"。
print(response.choices[0].message.content)：API 的响应是一个复杂的对象。我们深入其中，提取出模型生成的实际文本并打印出来。

在您的终端中运行此脚本：

python test_openai.py

如果一切顺利，您应该会看到 AI 对您的请求做出的回应。恭喜，您已经成功地在 Python 中使用了 OpenAI API！这是构建更复杂、更有趣应用程序的基础。

Python Function Calling 快速入门