介绍

翻译更新 3 几周前

OpenAI API 允许开发者轻松地将 AI 驱动的语言模型集成到他们的应用程序中。作为 OpenAI 套件的一部分，ChatGPT 是一个可以理解和生成自然语言响应的对话代理。本指南将引导您完成在应用程序中设置 OpenAI API 以使用 ChatGPT 的全面过程。这些说明用简单的英语书写，以适应可能对 API 集成没有高级理解的受众。

先决条件

在开始之前，您需要确保拥有以下几项：

OpenAI API 密钥。要获取此密钥，您需要在 OpenAI 的网站上注册并创建您的第一个项目。
编程的基本知识和在您的计算机上设置的首选编程环境或 IDE。
安装了 HTTP 客户端工具，如 cURL 或 Postman，或知道如何用您选择的编程语言进行 HTTP 请求。

获取您的 OpenAI API 密钥

要使用 OpenAI 的 API 服务，您需要一个 API 密钥，它作为访问服务的通行证。以下是获取 API 密钥的方法：

访问 OpenAI 网站，如果尚未注册，请注册一个帐户。
登录后，转到账户仪表板中的 API 部分。
点击"创建 API 密钥"，按照提示创建新的 API 密钥。
安全存储您的 API 密钥。您将使用此密钥对应用程序中的 API 调用进行身份验证。

选择合适的编程语言

OpenAI 的 API 可以从任何能够进行 HTTP 请求的编程语言访问。流行的集成选择包括 Python、JavaScript 和 Ruby 等。在本指南中，我们将提供 Python 的示例，因为它广泛用于 Web 和 AI 开发。

设置环境

要开始使用 API 编程，请确保您的开发环境已正确设置：

Python 设置

确保您的计算机上安装了 Python。如果没有安装，可以从官方 Python 网站下载。
为您的项目创建一个虚拟环境。这有助于管理依赖项。在项目目录中运行以下命令：
```
python -m venv venv
```
激活虚拟环境：
- 在 Windows 上：
```
.\venv\Scripts\activate
```
- 在 MacOS 和 Linux 上：
```
source venv/bin/activate
```
安装需要的用于 API 请求的包。常用的库是requests。用以下命令安装：
```
pip install requests
```

进行您的第一个 API 调用

要与 OpenAI 的 API 互动，您需要进行 HTTP 请求。以下是使用 Python 中的requests库来入门的简单示例：

import requests
# 定义端点 URL 和您的 API 密钥
url = "https://api.openai.com/v1/engines/davinci/completions"
api_key = "YOUR_API_KEY_HERE"

# 设置带有 API 密钥的标头
headers = {
    "Authorization": f"Bearer {api_key}",
    "Content-Type": "application/json"
}

# 定义 API 调用的负载
data = {
    "prompt": "Hello, how can I help you today?",
    "max_tokens": 150
}

# 发出 API 请求
response = requests.post(url, headers=headers, json=data)

# 打印响应
print(response.json())

在上述脚本中：

用您的实际 API 密钥替换"YOUR_API_KEY_HERE"。
负载中的prompt字段是您发送给 ChatGPT 的文本。
max_tokens决定 API 将返回的最大标记数。
response.json()方法接收到 JSON 格式的响应，允许您进一步处理输出。

理解响应

当您向 OpenAI API 发出请求时，您将收到一个包含重要信息的 JSON 响应。通常包含的是：

id：您 API 请求的唯一标识符。
object：返回对象的类型，通常是text_completion。
created：生成响应时的时间戳。
model：用于生成响应的 AI 模型。
choices：提示的结果列表。每个选项包括：
- text：生成的文本完成。
- index：批次中此完成的索引位置。
- logprobs：如果启用，提供诸如每个标记的日志概率之类的附加信息。
- finish_reason：解释完成为何结束的原因。常见原因包括“长度”或“停止”。

错误处理

在使用 API 时，处理错误是很重要的。以下是您可能会遇到的一些 OpenAI API 常见问题以及如何处理这些问题：

身份验证错误（401 未授权）：这表示您的 API 密钥无效或丢失。确保正确输入 API 密钥，然后重试。
速率限制错误（429 请求太多）：发生在您超出 API 请求的配额时。要么减少请求的频率，要么等待配额重置。
验证错误（400 错误请求）：如果请求负载格式错误就会发生这种情况。仔细检查数据类型、参数名称和值。
服务器错误（500 内部服务器错误）：这表明服务器端存在问题。请稍后重试请求，如果问题仍然存在，请联系 OpenAI 支持。

使用 OpenAI API 的最佳实践

为了优化您对 OpenAI API 的使用，请考虑这些最佳实践：

自定义请求参数：根据应用程序需求自定义参数，例如温度、最大标记数和出席惩罚。
缓存响应：对于频繁执行的查询，保存结果而不是多次检索，以减少成本和延迟。
监控使用情况：监控您 API 的使用情况，以在用户群增长时保持配额，并预测扩展需求。
保持信息更新：定期查看 OpenAI 的更新，以利用 API 的改进和更改。

循环处理多个提示

如果您有许多提示要处理，您可以遍历每个提示并迭代 API 请求。以下是一个示例：

multiple_prompts = [
    "What's the weather like today?",
    "Tell me a joke.",
    "How do I cook pasta?"
]
for prompt in multiple_prompts:
    data['prompt'] = prompt
    response = requests.post(url, headers=headers, json=data)
    print('Response for prompt:', prompt)
    print(response.json()['choices'][0]['text'])

结论

将 OpenAI 的 API 设置为 ChatGPT 变得简单，只要将其分解为简单的步骤即可。通过获得 API 密钥、设置环境以及了解如何进行请求和处理请求，您可以高效地将智能对话式 AI 集成到应用程序中。请记住处理错误，并通过遵循最佳实践来优化您的 API 使用。有了这些见解，您现在可以使用 ChatGPT 创建交互式的 AI 驱动体验。

如果你发现文章内容有误, 您可以

介绍