众扬汇 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;所选模型需自带图像修改能力。

  • model:string,必传;要调用的模型 ID。
  • messages:array,必传;对话消息序列,每个元素是 object,内含 role(string)与 content(string)。
  • temperature:integer,可选;采样温度,可填 0 与 2 之间的数值,越大输出越发散、越小越确定,建议和 top_p 只改其中一个。
  • top_p:integer,可选;核采样阈值,含义是只保留累计达到该概率质量的标记。
  • n:integer,可选;每条输入消息要产出几个候选。
  • 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(object,内有 role、content 两个 string)与 finish_reason(string)。
  • usage:object,内有 prompt_tokens、completion_tokens、total_tokens 三个 integer。

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