POST /v1/chat/completions 是 HHAPI 的核心接口,用于基于输入消息列表生成 AI 模型的回复。支持单轮问答与多轮对话,可通过系统提示词(system 角色消息)设定模型的行为风格,并提供多种参数用于控制生成质量与长度。接口设计参考 OpenAI Chat Completions 规范,具体参数兼容范围待确认,以本文档所列参数为准。
接口信息
- 方法:
POST - 路径:
/v1/chat/completions - 鉴权:必需(Bearer Token)
请求参数
string
required
要使用的模型 ID。可通过 GET /v1/models 接口获取当前可用的模型列表。
array
required
对话消息数组,按时间顺序排列,构成完整的对话上下文。每个消息对象需包含
role 和 content 字段。integer
本次请求允许生成的最大 Token 数量。超出此限制后生成将被截断,
finish_reason 返回 "length"。number
采样温度,范围
0 到 2。值越高,输出越随机多样;值越低,输出越确定集中。通常建议使用默认值或在 0.7–1.0 之间调整。不建议同时修改 temperature 和 top_p。number
核采样(nucleus sampling)参数,范围
0 到 1。模型只从累积概率达到 top_p 的最小 token 集合中采样。不建议同时修改 temperature 和 top_p。integer
default:"1"
为每个输入消息生成的回复条数。注意:此参数是否受支持待确认,建议默认使用
1。string | array
停止序列。当模型生成内容中出现指定字符串时,停止继续生成。可传入单个字符串或字符串数组(最多 4 个)。注意:此参数是否受支持待确认。
请求示例
以下示例从环境变量读取 API Key 和 Base URL:响应字段
string
本次请求的唯一 ID,格式通常为
chatcmpl- 开头的字符串,可用于日志追踪。string
固定值
"chat.completion"。integer
响应创建时的 Unix 时间戳(秒级)。
string
本次请求实际使用的模型 ID。
array
模型回复列表。默认情况下(
n=1)仅包含一个元素。string
回复消息的角色,固定为
"assistant"。string
模型生成的回复文本内容。
string
生成结束的原因:
"stop"— 自然结束或触发停止序列"length"— 达到max_tokens限制null— 流式模式中间块
integer
输入消息(prompt)消耗的 Token 数量。
integer
模型生成回复消耗的 Token 数量。
integer
本次请求消耗的总 Token 数量(prompt_tokens + completion_tokens)。
响应示例
错误说明
完整的错误码和错误处理说明请参阅 错误响应说明。