聊天接口（通用）

只提供简单的请求示例，更详细的API接口使用说明请阅读官方文档
注意：OpenAI、Claude、Gemini...等聊天模型均使用该接口格式。

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Header 参数

Content-Type

string

必需

示例值:

application/json

Body 参数application/json

model

string

模型名称

必需

messages

array [object {2}]

必需

role

string

角色 system | user

必需

content

string

提问消息

必需

temperature

integer

温度

可选

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

top_p

integer

可选

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

max_tokens

number

最大回复

可选

聊天完成时生成的最大Tokens数量。输入标记和生成标记的总长度受模型上下文长度的限制。

stream

boolean

流式输出

可选

流式输出或非流式输出

number

可选

为每个输入消息生成多少个聊天完成选项。

presence_penalty

integer

可选

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

frequency_penalty

integer

可选

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

logit_bias

null

可选

修改指定标记出现在完成中的可能性。接受一个 json 对象，该对象将标记（由标记器中的标记 ID 指定）映射到从 -100 到 100 的关联偏差值。从数学上讲，偏差会在采样之前添加到模型生成的 logits 中。确切的效果因模型而异，但 -1 和 1 之间的值应该会减少或增加选择的可能性；像 -100 或 100 这样的值应该导致相关令牌的禁止或独占选择。

stop

array[string]

可选

传入该参数后，当遇到匹配的关键词请求自动停止并完成。可传入字符串或字符串数组。

user

string

可选

代表您的最终用户的唯一标识符，可以帮助 OpenAI 监控和检测滥用行为。了解更多

示例

{
    "model": "gpt-4o",
    "messages": [
        {
            "role": "user",
            "content": "晚上好"
        }
    ],
    "max_tokens": 1688,
    "temperature": 0.5,
    "stream": false
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

string

必需

object

string

必需

created

integer

必需

model

string

必需

choices

array [object {4}]

必需

index

integer

可选

message

object

可选

logprobs

null

可选

finish_reason

string

可选

usage

object

必需

prompt_tokens

integer

必需

completion_tokens

integer

必需

total_tokens

integer

必需

system_fingerprint

string

必需

示例

{
    "id": "chatcmpl-A1iMgDLzZtUJ9QDpfqDLxKH0zfUnp",
    "object": "chat.completion",
    "created": 1724972230,
    "model": "gpt-4o-2024-05-13",
    "choices": [
        {
            "index": 0,
            "message": {
                "role": "assistant",
                "content": "晚上好！有什么我可以帮你的吗？",
                "refusal": null
            },
            "logprobs": null,
            "finish_reason": "stop"
        }
    ],
    "usage": {
        "prompt_tokens": 9,
        "completion_tokens": 10,
        "total_tokens": 19
    },
    "system_fingerprint": "fp_157b3831f5"
}