众扬汇 AI 开放平台 API 文档

Chat(指定GPTs)

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。走 GPTs 时按 gpt-4-gizmo-* 的形式给出模型名,平台会自动识别;示例 gpt-4-gizmo-g-IcWrQy2I9。
  • messages:必填,array,消息列表,每项为对象:
    • role:string,消息角色。
    • content:string,消息内容。

其余可选参数(原文档同样列出,取值语义与对话接口一致):

  • temperature:可选,integer,采样温度,取值 0–2;越大输出越随机,越小越集中。一般只调它或 top_p 之一。
  • top_p:可选,integer,核采样阈值,仅保留累积概率达到该比例的标记,例如 0.1 表示只看概率前 10% 的标记。
  • stream:可选,boolean,开启后以仅含数据的服务器发送事件增量下发,由 data: [DONE] 结束。
  • stop:可选,string,最多 4 个停止序列,命中后停止继续生成。
  • max_tokens:可选,integer,补全可生成的最大标记数;输入与输出合计受模型上下文长度约束。
  • presence_penalty:可选,number,取值 -2.0–2.0;正值按标记此前是否出现过惩罚,使模型更容易切入新话题。
  • frequency_penalty:可选,number,取值 -2.0–2.0;正值按出现频次惩罚,降低逐字复读。
  • logit_bias:可选,原文类型标注为 null(实际传 JSON 对象);把标记 ID 映射到 -100–100 的偏差值。
  • user:可选,string,终端用户的唯一标识,便于平台侧识别滥用。

响应

  • 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}} 请替换为控制台创建的令牌。