深色模式
参数说明
接口请求
| 传输方式 | https |
|---|---|
| 请求地址 | https://ai-maas.wair.ac.cn/maas/v1/chat/completions |
| 调用方式 | 同步调用，等待模型执行完成并返回最终结果或 SSE 调用 |
| 字符编码 | UTF-8 |
| 接口请求格式 | JSON |
| 响应格式 | JSON 或标准 Stream Event |
| 接口请求类型 | POST |
| 开发语言 | 任意可发起 HTTP 请求的开发语言 |
接口请求参数
Header 参数说明
| 字段 | 类型 | 必选 | 描述 | 示例值 |
|---|---|---|---|---|
| Content-Type | string | 是 | 请求类型 | application/json |
| Authorization | string | 是 | API Key，格式为 Bearer $ | Bearer ayvs***vufp |
Body 参数说明
| 参数名称 | 类型 | 是否必填 | 参数说明 |
|---|---|---|---|
| model | string | 是 | 所要调用的模型编码，模型可选模型 taichu_llm(语言大模型），taichu2_mm（多模态大模型） |
| messages | list | 是 | 一个由历史消息组成的列表，详细说明，参照 messages 信息说明 |
| stream | bool | 否 | 使用同步调用时，此参数应当设置为 fasle。表示模型生成完所有内容后一次性返回所有内容。如果设置为 true，模型将通过标准 Event Stream ，逐块返回模型生成内容。Event Stream 结束时会返回一条data: [DONE]消息。默认值为 true |
| temperature | float | 否 | 生成过程中的温度值，取值范围[0.01,1.00] 闭区间，默认值为 0.8,调节最小细粒度为0.01 |
| top_p | float | 否 | 生成过程中的token几率阈值取值范围是：(0.0, 1.0) 开区间，默认值为 0.9,调节最小细粒度为0.1 |
| max_tokens | int | 否 | 模型输出最大 tokens，最大输出为8192，默认值为3000 |
| tools | list | 否 | 可供模型调用的工具。详细说明，参照 tools参数说明 |
| tool_choice | string | 否 | 用于控制模型是如何选择要调用的函数，仅当工具类型为function时补充。默认为auto，当前仅支持auto |
messages参数说明
| 参数名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| role | string | 是 | system:系统，user:用户，assistant:模型，tool:工具调用 |
| content | string/list | 是 | role=system 时为系统提示信息，role=user 时为用户输入信息，role=assistant 时为模型返回信息，role=tool 时为工具调用返回信息 |
tools参数说明
| 参数名称 | 子参数名称 | 类型 | 是否必须 | 说明 |
|---|---|---|---|---|
| type | string | 是 | 工具类型,目前支持function、retrieval | |
| function | object | 否 | function工具，仅当工具类型为function时补充 | |
| name | string | 是 | 函数名称 | |
| description | string | 是 | 函数描述，模型会根据这段描述决定函数调用方式。 | |
| parameters | object | 是 | 需要传入一个 Json Schema 对象，以准确地定义函数所接受的参数。若调用函数时不需要传入参数，省略该参数即可。 | |
| retrieval | object | 否 | 知识库搜索，仅当工具类型为retrieval时补充 | |
| knowledge_ids | array | 是 | 知识库id（可通过 文档管理->知识库管理->相关信息 获取） | |
| document_id | int | 否 | 知识库下对应的文档id，若为空，针对整个知识库问答（可通过 文档管理->我的文档->相关信息 获取） | |
| document_name | string | 否 | 知识库下对应的文档名称，可通过 文档管理->我的文档->相关信息 获取） | |
| remove_corner_mark | bool | 否 | 为true的时候能去除答案的引用角标，默认值为false | |
| tips_text | string | 否 | 知识库问答未命中时的固定描述，当不传无固定描述，默认值为"抱歉，我的知识库中未检索到相关信息。请换个问题或参考小初的回答:"。 | |
| backup_chat | bool | 否 | 知识库问答未命中时，是否启用大语言模型兜底回答，默认开启，默认值为true |
返回参数说明
| 参数名称 | 子参数名称 | 类型 | 说明 |
|---|---|---|---|
| id | string | 本次请求唯一标识 | |
| model | string | 本次使用的模型名称 | |
| choices | list | ||
| messages | object | 同步响应时，返回该字段，详细说明见 messages 和 delta 参数说明 | |
| delta | object | 流式响应时，返回该字段，详细说明见 messages 和 delta 参数说明 | |
| finish_reason | string | stop: 表示模型输出结束length: 表示模型输出长度达到max_tokens tool_calls: 表示模型命中函数 content_filter: 表示模型输出被安全审核拦截，针对此类内容，请用户自行判断并决定是否撤回已公开的内容。 | |
| usage | object | token使用数量 | |
| completion_tokens | int | 内容生成的 tokens 数量 | |
| prompt_tokens | int | prompt 使用的 tokens 数量 | |
| total_tokens | int | 总 tokens 用量 |