快速了解OpenAI API

OpenAI 提供了一个强大的 API，允许开发者通过简单的 HTTP 请求调用其预训练的大型语言模型，如 GPT-3 和 GPT-4。以下是使用 OpenAI API 的基本步骤：

1. 注册并获取 API 密钥

首先，你需要注册一个 OpenAI 账户并获取 API 密钥。访问 https://platform.openai.com/ 并按照指引完成注册和密钥的获取。

2. 安装官方库

为了方便地使用 OpenAI API，你可以安装官方提供的 Python 库 openai：

pip install openai

3. 导入库并设置 API 密钥

在你的 Python 脚本中导入 openai 库，并设置你的 API 密钥：

import os
import openai

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

确保将 OPENAI_API_KEY 环境变量设置为你的 API 密钥。

4. 发送请求

接下来，你可以使用 openai.Completion.create() 或 openai.ChatCompletion.create() 方法来与 API 交互。这里有两个示例，分别展示了如何使用 GPT-3 和 GPT-4 模型生成文本。

示例 1: 使用 GPT-3 (GPT-3.5 Turbo)

response = openai.Completion.create(
    model="text-davinci-003",  # 使用 GPT-3.5 Turbo 的一个版本
    prompt="Write a short story about a robot who learns to love.",
    max_tokens=100,  # 生成的文本的最大长度
    n=1,  # 返回的结果数量
    stop=None,  # 结束生成的条件
    temperature=0.7,  # 控制输出的随机性
)

print(response.choices[0].text.strip())

示例 2: 使用 GPT-4

response = openai.ChatCompletion.create(
    model="gpt-4",  # 使用 GPT-4
    messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "What's the weather like today in San Francisco?"}
    ],
    max_tokens=100,
    n=1,
    stop=None,
    temperature=0.7,
)

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

5. 处理响应

API 响应包含生成的文本。你可以根据需要处理这些文本。

6. 错误处理

确保处理可能发生的错误，比如 API 调用失败或配额不足的情况：

try:
    response = openai.Completion.create(...)
except openai.error.OpenAIError as e:
    print(f"An error occurred: {e}")

7. 更多高级选项

除了基本的文本生成外，你还可以利用更多高级功能，如：

• 编辑和翻译：使用 openai.Edit.create() 和 openai.Translate.create() 方法。
• 图像生成：使用 openai.Image.create() 方法生成图像。
• 嵌入（Embeddings）：使用 openai.Embedding.create() 方法生成文本嵌入，这对于相似度计算很有用。

8. 使用官方文档

OpenAI 提供了详细的文档，你可以访问 https://platform.openai.com/docs/api-reference 来了解更多关于 API 的信息和可用的参数。

9. 遵守使用政策

确保遵守 OpenAI 的使用政策，不要滥用 API，特别是不要生成有害或不适当的内容。