解读API请求的格式

请求解读

1. 请求头 (Headers)

请求头包含以下信息：

• Content-Type: application/json
  指定请求体的格式为 JSON 数据。

• Authorization: Bearer <YOUR_API_KEY>
  用于身份验证，<YOUR_API_KEY> 是用户的 API 密钥，需替换为实际值。

• ``Bearer 是一种 HTTP 认证机制，用于在请求头中传递身份验证令牌（如 API 密钥或访问令牌）。它的核心思想是：“持有者（Bearer）” 是指任何拥有该令牌的实体（人或程序），都可以使用该令牌进行身份验证。

  Bearer 是一种简单而灵活的认证机制，适合现代的无状态应用（如 RESTful API）。它的核心是通过令牌证明“持有者”的身份，而无需存储额外的状态信息。

  用途：
  身份验证：用于证明请求的发送者是合法的。
  授权：用于限制对特定资源的访问权限。
  无状态：服务器不存储令牌的状态，完全依赖令牌本身来验证请求。

2. 请求体 (Body)

请求体是一个 JSON 对象，包含以下字段：

• model: string
  指定使用的模型名称（例如 "gpt-3.5-turbo" 或 "gpt-4"）。

• messages: object[]
  消息列表，每个消息对象包含：

  • role: 消息角色（如 "user"、"system" 或 "assistant"）。

  • content: 消息内容（文本字符串）。

• stream: boolean
  是否启用流式响应（true 表示逐块返回结果，false 表示一次性返回完整结果）。

示例解读

示例请求

curl --request POST \
     --url http://{address}/api/v1/chats_openai/{chat_id}/chat/completions \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer <YOUR_API_KEY>' \
     --data '{
        "model": "model",
        "messages": [{"role": "user", "content": "Say this is a test!"}],
        "stream": true
      }'

关键点

1. URL 替换

   • {address}：API 服务的地址（如 localhost:8000 或 api.example.com）。

   • {chat_id}：聊天会话的唯一标识符。

2. 请求体字段说明

   • "model": "model"：需替换为具体模型名称（如 "gpt-3.5-turbo"）。

   • "messages"：包含用户输入的消息（示例中用户发送了 "Say this is a test!"）。

   • "stream": true：启用流式响应（逐块返回结果）。

注意事项

• API 密钥安全：确保 <YOUR_API_KEY> 不泄露，避免硬编码在代码中。

• 模型名称：需使用支持的模型名称（如 gpt-3.5-turbo 或 gpt-4）。

• 流式响应处理：若 stream=true，需逐块解析响应数据。