聊天接口（通用） - 小爱帮助文档

请求参数

Header 参数

Authorization

string

可选

默认值:

Bearer {{YOUR_API_KEY}}

Body 参数application/json

messages

array [object {2}]

必需

以聊天格式生成聊天完成的消息。

role

string

角色

必需

示例值:

systemuser

content

string

内容

必需

stream

boolean

可选

是否流式输出，不填默认为false

默认值:

false

model

string

聊天使用模型名称

必需

temperature

number

可选

使用什么采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更加随机，而较低的值（如 0.2）将使输出更加集中和确定。我们通常建议改变这个或top_p但不是两者。

presence_penalty

integer

可选

-2.0 和 2.0 之间的数字。正值会根据到目前为止是否出现在文本中来惩罚新标记，从而增加模型谈论新主题的可能性

frequency_penalty

integer

可选

2.0 和 2.0 之间的数字。正值会根据新标记在文本中的现有频率对其进行惩罚，从而降低模型逐字重复同一行的可能性

top_p

integer

可选

一种替代温度采样的方法，称为核采样，其中模型考虑具有 top_p 概率质量的标记的结果。所以 0.1 意味着只考虑构成前 10% 概率质量的标记。我们通常建议改变这个或temperature但不是两者。

logprobs

boolean

可选

是否返回输出令牌的对数概率。如果为 true，则返回消息中内容中每个输出令牌的对数概率。

top_logprobs

integer

可选

一个介于 0 到 20 之间的整数，指定返回每个令牌位置上最有可能的令牌数量，每个令牌都有一个相关的对数概率。logprobs必须设置为true，如果使用此参数。

max_tokens

integer

可选

最大令牌的数量可以在聊天完成中生成。此值可用于控制通过 API 生成的文本成本。该值现在已弃用，建议使用max_completion_tokens

max_completion_tokens

integer

可选

生成完成的令牌数的上界，包括可见的输出令牌和< a id=0 >推理令牌

response_format

可选

一个用于指定模型输出格式的对象。与GPT-4o，GPT-4o mini，GPT-4 Turbo和所有新于gpt-3.5-turbo-1106的 GPT-3.5 Turbo 模型兼容。
启用 { "type": "json_schema", "json_schema": {...} } 设置会启用结构化输出，这样模型将与您提供的 JSON 模式匹配。在 Structured Outputs 指南中了解更多信息参考。
设置 { "type": "json_object" } 启用 JSON 模式，确保模型生成的消息是有效的 JSON。

示例

{
    "messages": [
        {
            "role": "system",
            "content": "你是一个大语言模型机器人"
        },
        {
            "role": "user",
            "content": "你好"
        }
    ],
    "stream": false,
    "model": "gpt-3.5-turbo",
    "temperature": 0.5,
    "presence_penalty": 0,
    "frequency_penalty": 0,
    "top_p": 1
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://xiaoai.plus/v1/chat/completions' \
--header 'Authorization: Bearer sk-xxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "messages": [
        {
            "role": "system",
            "content": "你是一个大语言模型机器人"
        },
        {
            "role": "user",
            "content": "你好"
        }
    ],
    "stream": false,
    "model": "gpt-3.5-turbo",
    "temperature": 0.5,
    "presence_penalty": 0,
    "frequency_penalty": 0,
    "top_p": 1
}'

返回响应

🟢200成功

application/json

Body

object {0}

示例

{
  "id": "chatcmpl-AJaak2I8cuhBbdpMor1SikpkWOvSy",
  "object": "chat.completion",
  "created": 1729232254,
  "model":"gpt-3.5-turbo",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "你好，我是AI助手。我是一个虚拟机器人，没有情感，但我可以帮助你回答问题和提供信息。有什么我可以帮助你的吗？"
      },
      "logprobs": null,
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 27,
    "completion_tokens": 57,
    "total_tokens": 84
  },
  "system_fingerprint": null
}