众扬汇 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。
  • Authorization:可选,string,默认值 Bearer {{YOUR_API_KEY}}。

请求体参数(application/json)

  • model:必填,string,要使用的模型 ID;把该值改成模型名即可使用本接口,模型需具备识图能力。
  • messages:必填,array,按对话格式组织的消息;元素含 role(string)与 content(string)。
  • temperature:可选,integer,采样温度,取值 0–2;偏高的值(如 0.8)输出更随机,偏低(如 0.2)输出更集中确定。
  • top_p:可选,integer,核采样的替代方案,仅考虑累积概率质量为 top_p 的候选,取值 0.1 表示只看前 10% 概率质量的候选。
  • 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 对象把标记(tokenizer 中的标记 ID)映射到 -100–100 的偏差值,采样前叠加到 logits 上。
  • user:可选,string,代表最终用户的唯一标识,便于对滥用行为做监控与检测。
  • 响应

    • 200(原文标注 OK):返回 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。
      • 必填:id、object、created、choices、usage。
      • 使用提示:本平台 Base URL 为 https://api.allyang.cn,OpenAI 兼容接口路径以 /v1 开头;示例里的 {{YOUR_API_KEY}} 请替换为控制台创建的令牌。

        示例中 messages 的 content 可用数组承载文本与图片(type 取 text 或 image_url)。