快速开始

本指南将引导你完成你的第一个 OpenAI API 请求，让你快速体验强大的文本生成能力。

1. 准备工作

• 获取 API 密钥： 访问 阴天api 并注册账号 或 申请附加免费密钥，获取你的 API 密钥 (Secret API Key)。请妥善保管你的密钥！

2. 发送请求 (含代理设置)

以下 curl 命令可以用于发送你的第一个 API 请求。 请务必进行以下替换：

• YOUR_API_KEY: 替换为你自己的 API 密钥。
• https://api.openai.com/v1/chat/completions: (可选) 替换为你的代理地址，如果需要的话。

curl https://api.openai.com/v1/chat/completions \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -d '{
  "model": "gpt-3.5-turbo",
  "messages": [{"role": "user", "content": "Say this is a test!"}],
  "temperature": 0.7
}'

代码解释：

• curl: 一个命令行工具，用于发送 HTTP 请求。
• https://api.openai.com/v1/chat/completions: OpenAI Chat Completion API 的端点。 你可以将其替换为本项目的代理服务器地址。
• -H 'Content-Type: application/json': 设置请求头，表明发送的是 JSON 格式的数据。
• -H 'Authorization: Bearer YOUR_API_KEY': 设置授权头，使用你的 API 密钥进行身份验证。
• -d '{...}': 指定请求体，包含以下参数：
  • model: 使用的模型，这里是 gpt-3.5-turbo，一个针对聊天应用优化的模型。
  • messages: 一个消息列表，包含角色 (role) 和内容 (content)。这里我们发送一条用户消息，要求模型说 "Say this is a test!"。
  • temperature: 控制生成文本的随机性，值越高，结果越随机。

2.1 代理服务器地址示例

以下是本项目的代理api:

• https://yuanplus.chat/v1/chat/completions
• https://yuanpluss.online:3000/v1/chat/completions
• https://yuanplus.deno.dev/api/v1/chat/completions
• https://yuanplus.deno.dev/vip/v1/chat/completions

请注意：

• 你需要根据你使用的代理服务器的配置来修改地址。
• 确保你的代理服务器支持 OpenAI API 的请求方式。

3. 响应结果

如果一切顺利，你将收到类似以下的 JSON 响应：

{
  "id": "chatcmpl-abc123",
  "object": "chat.completion",
  "created": 1677858242,
  "model": "gpt-3.5-turbo-0301",
  "usage": {
    "prompt_tokens": 13,
    "completion_tokens": 7,
    "total_tokens": 20
  },
  "choices": [
    {
      "message": {
        "role": "assistant",
        "content": "\n\nThis is a test!"
      },
      "finish_reason": "stop",
      "index": 0
    }
  ]
}

响应解释：

• id: 请求的唯一 ID。
• object: 响应对象的类型。
• created: 请求创建的时间戳。
• model: 实际使用的模型版本。
• usage: token 使用情况，包括 prompt tokens (输入) 和 completion tokens (输出)。
• choices: 模型生成的文本结果列表。
  • message: 包含角色 (assistant) 和内容 (模型生成的文本)。
  • finish_reason: 完成原因，stop 表示 API 返回了模型生成的完整完成。
  • index: 结果在列表中的索引。

4. 进阶使用

• 生成多条消息： 设置 n 参数可以生成多条消息选择。
• 探索更多模型： OpenAI 提供了多种模型，可以根据你的需求选择合适的模型。
• 优化聊天体验： gpt-3.5-turbo 针对聊天应用进行了优化，可以用于构建更自然的对话。

5. 注意事项

• 保护你的 API 密钥： 不要将 API 密钥泄露给他人，避免不必要的损失。
• 了解计费规则： OpenAI API 按照 token 数量计费，请注意控制你的使用量。