众扬汇 AI 开放平台 API 文档

Chat(聊天)

OpenAPI Specification

接口:POST /v1/chat/completions(完整地址 https://api.allyang.cn/v1/chat/completions)

鉴权:请求头 Authorization 传令牌,取值形如 Bearer {{YOUR_API_KEY}}(该字段非必填)。

请求头

  • Content-Type:必填,固定 application/json。
  • Accept:必填,固定 application/json。

请求体参数(application/json)

原文档把 model、messages、tools、tool_choice 四个字段列入必传,其余均可省略。

  • model:string,必传;要使用的模型 ID。
  • messages:array,必传;截止当前的对话消息序列,每个元素含 role(string)与 content(string)。
  • temperature:integer,可选;采样温度,可填 0 与 2 之间的数值,越大结果越发散。
  • top_p:integer,可选;核采样阈值,建议和 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,可选;把标记 ID 映射到 -100 到 100 的偏差值。
  • user:string,可选;终端用户的唯一标识,用于滥用监控。
  • response_format:object,可选;指定输出格式。置为 {"type": "json_object"} 即开启 JSON 模式,此时还得在系统或用户消息里明确要求输出 JSON,否则模型可能一直吐空白直到触达标记上限;若 finish_reason 为 length,内容可能会被截断。
  • seen:integer,可选;测试阶段的参数,填入后系统会尽量做确定性采样,但确定性不作保证,可借助响应中的 system_fingerprint 观察后端变化。
  • tools:array,必传(原文档请求体 schema 列为 required);元素为 string,列出可供模型调用的工具,当前只支持函数形式。
  • tool_choice:object,必传(原文档请求体 schema 列为 required);控制函数调用策略:none 表示不调用、auto 交给模型判断,也可以写成 {"type": "function", "function": {"name": "my_function"}} 指定具体函数;没有可用函数时不传即按 none 处理,存在函数时按 auto 处理。

响应

  • 200:返回成功,响应体为 JSON 对象。
  • id:string,唯一编号。
  • object:string,对象类型。
  • created:integer,创建时刻。
  • choices:array;每个元素含 index(integer)、message(object,内有 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}} 请替换为控制台创建的令牌。