chatgpt接口文档

ChatGPT是一个能够进行对话的自然语言生成模型。以下是ChatGPT接口的文档：

请求

• model: （必需）模型的名称或模型的id。例如：”gpt-3.5-turbo”。

• messages: （必需）一个包含对话消息的数组。每个消息对象都有两个属性：role和content。

  • role可以是"system"、"user"或"assistant"之一。其中，"system"表示系统消息，"user"表示用户消息，"assistant"表示助手消息。
  • content是消息的内容。例如，"role": "user", "content": "tell me a joke"。

以下是一个请求示例：

{
  "model": "gpt-3.5-turbo",
  "messages": [
    {"role": "system", "content": "You are a helpful assistant."},
    {"role": "user", "content": "Who won the world series in 2020?"},
    {"role": "assistant", "content": "The Los Angeles Dodgers won the World Series in 2020."},
    {"role": "user", "content": "Where was it played?"}
  ]
}

响应

成功的响应返回一个包含助手回复的对象：

{
  "id": "chatcmpl-6p9XYPYSTTRi0xEviKjjilqrWU2Ve",
  "object": "chat.completion",
  "created": 1677649420,
  "model": "gpt-3.5-turbo",
  "usage": {"prompt_tokens": 56, "completion_tokens": 31, "total_tokens": 87},
  "choices": [
    {
      "message": {
        "role": "assistant",
        "content": "The 2020 World Series was played in Arlington, Texas at the Globe Life Field, which was the new home stadium for the Texas Rangers."
      },
      "finish_reason": "stop",
      "index": 0
    }
  ]
}

助手回复可以通过response['choices'][0]['message']['content']来访问。

如果发生错误，响应将包含错误信息而不是choices字段。

Python代码示例

这是一个使用OpenAI Python库发送请求的代码示例：

import openai

openai.ChatCompletion.create(
  model="gpt-3.5-turbo",
  messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "Who won the world series in 2020?"},
        {"role": "assistant", "content": "The Los Angeles Dodgers won the World Series in 2020."},
        {"role": "user", "content": "Where was it played?"}
    ]
)

这将返回包含助手回复的响应对象。您可以使用response['choices'][0]['message']['content']来访问助手的回复。

ChatGPT是OpenAI开发的一款基于GPT的自然语言生成模型，可以用于进行对话生成。ChatGPT接口提供了一个简单的方式来与ChatGPT模型进行交互。

模型介绍

ChatGPT模型是一个基于GPT的生成式对话模型。它通过读取一个上下文字符串，并生成一个回答字符串。通过连续的交互，可以创建一个对话流。

接口地址

https://api.openai.com/v1/chat/completions

请求方式

POST

请求参数

必选参数

• model: 模型的名称，固定为”chatgpt”。
• messages: 一个包含对话历史的数组。每个对话历史包含两个属性，role表示说话者的角色（”system”、”user”或”assistant”），content表示说话者的内容。

可选参数

• temperature: 温度参数，用于控制输出的随机性。默认值为0.6。
• max_tokens: 输出的最大令牌数。较小的值会导致更短的回答。默认值为50。

响应参数

• id: 请求的唯一标识符。
• object: 固定为”chat.completion”。
• created: 请求的创建时间。
• model: 使用的模型名称。
• usage: 请求的模型使用信息。
• choices: 一个数组，包含生成的回答。

示例

请求

import openai

openai.ChatCompletion.create(
  model="chatgpt",
  messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "Who won the world series in 2020?"},
        {"role": "assistant", "content": "The Los Angeles Dodgers won the World Series in 2020."},
        {"role": "user", "content": "Where was it played?"}
    ]
)

响应

{
  "id": "chatcmpl-6p9XYPYSTTRi0xEviKjjilqrWU2Ve",
  "object": "chat.completion",
  "created": 1677649420,
  "model": "chatgpt",
  "usage": {
    "prompt_tokens": 56,
    "completion_tokens": 31,
    "total_tokens": 87
  },
  "choices": [
    {
      "message": {
        "role": "assistant",
        "content": "The 2020 World Series was played in Arlington, Texas at the Globe Life Field, which was the new home stadium for the Texas Rangers."
      },
      "finish_reason": "stop",
      "index": 0
    }
  ]
}

注意事项

• 每个对话历史的role属性必须是”system”、”user”或”assistant”之一。
• 对于每个请求，最多只能包含20个对话历史。
• 请求的对话历史的顺序非常重要，因为模型是根据历史生成回答的。
• 模型的响应时间通常在几秒钟到几十秒之间。
• 请求的messages参数为空数组时，模型将产生一个基于系统提示的回答。