大模型（LLM）的若干科普之问（四）：OpenAI 的 API 接口规范与openai库

一、OpenAI 的 API 接口规范

OpenAI 的 API 接口规范是基于 RESTful API 设计的，主要用于与 OpenAI 的大型语言模型（如 GPT-3、GPT-4 等）进行交互。以下是 OpenAI API 的基本接口规范和使用方法：

---

1. API 基础信息

• API 地址: https://api.openai.com/v1
• 认证方式: 使用 API Key 进行身份验证。
  • 在请求头中添加 Authorization: Bearer <your-api-key>。
• 支持的模型: 包括 gpt-3.5-turbo、gpt-4 等。以及非OpenAI公司的号称兼容该规范的LLM（需稍作修改，如，API的地址）

---

2. 常用接口

(1) 文本生成接口

• URL: POST https://api.openai.com/v1/chat/completions

• 功能: 与模型进行对话或生成文本。

• 请求示例:

  {
       
    "model": "gpt-3.5-turbo",
    "messages": [
      {
       "role": "system", "content": "You are a helpful assistant."},
      {
       "role": "user", "content": "Hello, how are you?"}
    ],
    "max_tokens": 100,
    "temperature": 0.7
  }
  

• 参数说明:

  • model: 使用的模型名称（如 gpt-3.5-turbo）。
  • messages: 对话消息列表，每条消息包含 role（system、user 或 assistant）和 content（消息内容）。
  • max_tokens: 生成的最大 token 数。
  • temperature: 控制生成文本的随机性（0-1，值越高越随机）。
  • top_p: 控制生成文本的多样性。
  • n: 生成多个回复。
  • stop: 停止生成的条件（如遇到特定字符串）。
  • stream: 是否以流式传输方式返回结果。

• 响应示例:

  {
       
    "id": "chatcmpl-12345",
    "object": "chat.completion",
    "created": 1691234567,
    "choices": [
      {
       
        "index": 0,
        "message": {
       
          "role": "assistant",
          "content": "I'm fine, thank you! How can I help you today?"
        },
        "finish_reason": "stop"
      }
    ],
    "usage": {
       
      "prompt_tokens": 10,
      "completion_tokens": 20,
      &#