聊天

POST

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

用于发送生成聊天完成信息的请求。请求中应包含一个 model 参数，指定要使用的模型；一个 messages 列表，包含角色和信息内容；以及一个 stream 参数，用于指示是否流式传输响应。

请求正文

model （字符串）：指定用于生成完成信息的模型。

messages（数组）：包含要生成补全的消息的角色和内容。

角色（字符串）：指定信息的角色（如 “用户”、“助手”、“系统”）。

内容（字符串）：要生成补全的信息内容。

stream （布尔）：表示是否对响应进行流式处理。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.deerapi.com/v1/chat/completions' \
--header 'Authorization: Bearer {{api-key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model": "gpt-4o",
    "messages": [
        {
            "role": "user",
            "content": "Hello!"
        }
    ],
    "stream": false
}'

响应示例

{
    "id": "chatcmpl-AreYSBEwmzB0kY3GxzBEhE1Olct83",
    "object": "chat.completion",
    "created": 1737350640,
    "model": "gpt-4o-2024-08-06",
    "system_fingerprint": "fp_f3927aa00d",
    "choices": [
        {
            "index": 0,
            "message": {
                "content": "Hello! How can I assist you today?",
                "role": "assistant"
            },
            "finish_reason": "stop"
        }
    ],
    "usage": {
        "completion_tokens": 9,
        "completion_tokens_details": {},
        "prompt_tokens": 9,
        "prompt_tokens_details": {},
        "total_tokens": 18
    }
}

请求参数

Header 参数

Authorization

string

必需

示例值:

Bearer {{api-key}}

Body 参数application/json

model

string

必需

要使用的模型的 ID。有关哪些模型适用于聊天 API 的详细信息，请参阅模型端点兼容性表:https://platform.openai.com/docs/models/model-endpoint-compatibility

messages

array [object {2}]

必需

以聊天格式:https://platform.openai.com/docs/guides/text?api-mode=chat生成聊天完成的消息。

role

string

消息发送者的角色

可选

content

string

消息的具体内容

可选

stream

boolean

可选

如果设置，将发送部分消息增量，就像在 ChatGPT 中一样。当令牌可用时，令牌将作为纯数据服务器发送事件data: [DONE]发送，流由消息终止。有关示例代码，请参阅 OpenAI Cookbook 。

temperature

integer

可选

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

top_p

integer

可选

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

integer

可选

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

stop

string

可选

API 将停止生成更多令牌的最多 4 个序列。

max_tokens

integer

可选

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

presence_penalty

number

可选

-2.0 和 2.0 之间的数字。正值会根据到目前为止是否出现在文本中来惩罚新标记，从而增加模型谈论新主题的可能性。查看有关频率和存在惩罚的更多信息:https://platform.openai.com/docs/api-reference/parameter-details

frequency_penalty

number

可选

logit_bias

null

可选

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

user

string

可选

代表您的最终用户的唯一标识符，可以帮助 OpenAI 监控和检测滥用行为。了解更多:https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids

示例

返回响应

🟢200Successful Response

application/json

Body

string

必需

本次API请求的唯一标识符。

object

string

返回对象的类型，

必需

created

integer

必需

请求处理完成时的Unix时间戳

model

string

必需

本次请求所使用的具体模型名称。

system_fingerprint

string

必需

系统指纹，代表了模型运行所使用的后端配置。

choices

array [object {3}]

必需

个包含模型生成结果的列表。如果请求时指定了 n > 1，这里可能会包含多个结果对象。

index

integer

可选

该结果在列表中的索引，从 0 开始。

message

object

可选

模型生成的消息内容对象。

finish_reason

string

可选

模型停止生成的原因。

usage

object

必需

本次请求的 token 使用量统计。

completion_tokens

integer

必需

模型生成的消息（completion）所消耗的 token 数量。

completion_tokens_details

object

必需

关于 completion_tokens 的详细信息

prompt_tokens

integer

必需

用户输入的提示（prompt）所消耗的 token 数量。

prompt_tokens_details

object

必需

关于 prompt_tokens 的详细信息

total_tokens

integer

必需

本次请求消耗的总 token 数量

修改于 2025-05-27 05:44:19

gpt-4o-image生图

识图

聊天

请求正文#

请求参数

返回响应

请求正文