众扬汇 AI 开放平台 API 文档

Chat(工具tools调用)

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)。
  • tools:必填,array,元素为 string,模型可调用的一组工具;当前仅支持函数形式的工具。
  • tool_choice:必填,object,控制模型是否或如何调用函数:none 表示不调用函数、只生成消息;auto 表示由模型自行在生成消息与调用函数之间选择;也可用 {"type": "function", "function": {"name": "my_function"}} 强制指定某个函数。无函数时默认 none,有函数时默认 auto。
  • temperature:可选,integer,采样温度,取值 0 至 2;数值越高输出越随机,越低越集中确定。与 top_p 建议只调整其中一个。
  • top_p:可选,integer,核采样参数,仅考虑累积概率靠前的标记(0.1 即前 10% 概率质量)。与 temperature 建议只调整其中一个。
  • n:可选,integer,默认 1,每条输入消息生成的补全条数。
  • stream:可选,boolean,默认 false;设为 true 时以纯数据形式的服务器发送事件增量返回,流以 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 的偏置值,在采样前作用于模型输出的 logit,从而增减该标记被选中的可能。
  • user:可选,string,终端用户的唯一标识,便于追踪与滥用检测。
  • response_format:可选,object,指定模型必须输出的格式;传 {"type": "json_object"} 可开启 JSON 模式。开启时须在系统或用户消息中明确要求输出 JSON,否则模型可能持续产生空白直到触达标记上限;若 finish_reason 为 length,消息内容可能被截断,说明生成长度超出 max_tokens 或对话超出最大上下文长度。
  • seen:可选,integer,原文标注为测试阶段能力:指定后系统会尽力做确定性采样,使相同种子与参数下的重复请求得到相同结果,但不做保证,可结合响应中的 system_fingerprint 观察后端变化。

**响应

  • 200:成功。
  • id:string,本次请求的唯一标识。
  • object:string,返回对象类型。
  • created:integer,创建时间戳。
  • choices:array,候选结果列表;每项含 index(integer)、message(对象,含 role、content)、finish_reason(string)。
  • usage:对象,含 prompt_tokens、completion_tokens、total_tokens,均为 integer。

使用提示:本平台 Base URL 为 https://api.allyang.cn,OpenAI 兼容接口路径以 /v1 开头;示例里的 {{YOUR_API_KEY}} 请替换为控制台创建的令牌。 补充说明:给定提示词后模型会返回一个或多个补全结果,可配合 tools 与 tool_choice 实现函数调用。