Chat(结构化输出)

OpenAPI Specification

接口：POST /v1/chat/completions（完整地址 https://api.allyang.cn/v1/chat/completions）

鉴权：请求头 Authorization: Bearer {{YOUR_API_KEY}}。

请求头

• Content-Type：必填，string，示例取值 application/json。
• Accept：必填，string，示例取值 application/json。

请求体参数（application/json）

• model：必填，string，要调用的模型 ID；对话模型共用本接口，切换模型只需改这一项，示例 gpt-4o-2024-08-06。
• messages：必填，array，迄今的对话消息序列，每项含 role（string）与 content（string）。
• temperature：可选，integer，采样温度，介于 0 与 2；取值偏大（如 0.8）输出更发散，偏小（如 0.2）更集中确定。一般只调它和 top_p 中的一个。
• top_p：可选，integer，核采样阈值，仅保留累积概率质量达到该比例的标记，例如 0.1 表示只看构成前 10% 概率质量的标记。一般只调它和 temperature 中的一个。
• n：可选，integer，默认 1；每条输入消息对应的补全条数。
• stream：可选，boolean，默认 false；开启后增量推送部分消息，令牌以仅含数据的服务器发送事件形式下发，由 data: [DONE] 结束。
• stop：可选，string，默认 null；最多 4 个停止序列，命中后停止继续生成。
• max_tokens：可选，integer，默认 inf；补全可生成的最大标记数，输入与输出的标记总量受模型上下文长度约束。
• presence_penalty：可选，number，介于 -2.0 与 2.0；取正值会按「此前是否出现过」惩罚新标记，使模型更容易切入新话题。
• frequency_penalty：可选，number，默认 0，介于 -2.0 与 2.0；取正值会按既有出现频次惩罚新标记，降低逐字复读同一行的可能。
• logit_bias：可选，原文声明类型为 null（实际传 JSON 对象）；把标记 ID 映射到 -100 到 100 的偏差值，采样前叠加到生成 logits 上，用于减少或增加指定标记被选中的概率，极端取值（如 -100、100）可近似禁用或强制指定标记。
• user：可选，string，终端用户的唯一标识，便于平台侧监控与识别滥用。
• response_format：可选，object，约束模型输出格式。传 { "type": "json_object" } 即启用 JSON 模式，可确保消息内容为合法 JSON；启用时还须在系统或用户消息中明确要求输出 JSON，否则模型可能持续输出空白直至触达令牌上限，表现为延迟变大甚至请求卡住；另需注意 finish_reason="length" 时内容可能被截断。
• seen：可选，integer，测试阶段参数；填写后平台会尽力按确定性采样，使相同种子与参数的重复请求得到一致结果，但不保证确定性，可参考 system_fingerprint 响应参数观察后端变化。
• tools：可选，array（元素为 string），模型可调用的工具列表；目前只支持以函数形式提供工具，用于给出可生成 JSON 输入的函数清单。
• tool_choice：可选，object，决定模型调用哪个函数：none 表示只生成消息、不调用函数；auto 表示由模型在生成消息与调用函数间自行选择；也可用 {"type": "function", "function": {"name": "my_function"}} 强制调用指定函数。没有函数时默认 none，有函数时默认 auto。

原文声明的必填项为 model、messages、tools、tool_choice。

response_format 的结构（原文档给出）：

• response_format 内可带 json_schema：object，Schema 定义，含：
  • name：string，Schema 名称，示例 math_reasoning。
  • schema：object，JSON Schema 本体；示例里 properties 下含 steps（array，元素含 explanation（string）与 output（string））与 final_answer（string），并声明 additionalProperties（boolean，示例 false）。
• strict：boolean，示例 true，是否严格按 Schema 输出。

响应

• 200：成功，返回 JSON 对象：
  • id：string。
  • object：string。
  • created：integer。
  • choices：array，每项含 index（integer）、message（对象，含必填的 role 与 content）、finish_reason（string）。
  • usage：object，含必填的 prompt_tokens、completion_tokens、total_tokens，均为 integer。

使用提示：本平台 Base URL 为 https://api.allyang.cn，OpenAI 兼容接口路径以 /v1 开头；示例里的 {{YOUR_API_KEY}} 请替换为控制台创建的令牌。