文件
如何与多智能体聊天
如何与多智能体聊天
了解如何与多智能体进行高效交互
如何与多智能体聊天
POST /api/v1/backend/chatbot/{bot_uid}/chat
Chat API 支持通过 POST 请求实现与多智能体的程序化交互。
此 API 仅对付费订阅用户开放,用于与多智能体进行通信。
路径参数
参数 | 类型 | 是否必填 | 描述 |
---|---|---|---|
bot_uid | string | 是 | 您希望与之交互的多智能体的唯一标识符。 |
请求体参数
请求的 Content-Type 应设置为 application/json
。
参数 | 类型 | 是否必填 | 描述 |
---|---|---|---|
q | string | 是 | 您想向多智能体提出的问题。 |
conversation_uid | string | 否 | 聊天的会话标识符。请您注意,您不应手动构造会话标识符。在与多智能体交互后,会返回一个会话标识符。如果您希望继续同一会话,可以在后续交互中传递此会话标识符。 |
language | string | 否 | 与多智能体交互时的目标语言。目前支持英语、法语、西班牙语、俄语、中文(简体)等。默认值为 auto。 |
stream | boolean | 否 | 是否启用流式输出。默认值为 False。 |
返回值
正常返回
{
"code": 0,
"data": {
"answer": "answer",
"conversation_uid": "f05f1800-a728-4e23-adb8-69abd55b5dcb",
"is_qa_mode": true,
"question": "Ut minim ex",
"system_message": ""
},
"msg": "Success.",
"request_id": "25a40914-d8d9-4b0f-a92d-b8844bfc9852"
}
流式返回
{"answer": "", "question": "Ut minim ex", "related_docs": [], "conversation_uid": "9628808a-dbb6-42c3-aba6-9fe5b772c724", "is_qa_mode": true, "system_message": ""}
645130146e8d07b175fd8b1d5682d520answer
数据字段
字段 | 类型 | 描述 |
---|---|---|
answer | string | 多智能体对问题的回答。 |
conversation_uid | string | 当前会话的标识符。 |
is_qa_mode | boolean | 是否处于 QA 模式(QA 模式将为答案提供参考文献)。 |
question | string | 用户提出的问题。 |
system_message | string | 系统生成的消息,用于显示系统通知。 |
在流式模式下,响应数据通过特殊分隔符 "645130146e8d07b175fd8b1d5682d520" 分隔。
特殊分隔符之前是 JSON 字符串,特殊分隔符之后是实际的回答内容。
附录
1. 语言代码
代码 | 名称 | 本地名称 | 备注 |
---|---|---|---|
auto | 自动检测 | 自动 | 根据输入自动判断语言 |
en | 英语 | English | |
fr | 法语 | Français | |
es | 西班牙语 | Español | |
ru | 俄语 | Русский | |
zh-Hans | 中文(简体) | 中文 (简体) | |
zh-Hant | 中文(繁体) | 中文 (繁體) | |
ar | 阿拉伯语 | العربية | |
de | 德语 | Deutsch | |
jp | 日语 | 日本語 | |
pt | 葡萄牙语 | Português | |
hi | 印地语 | हिंदी | |
ko | 韩语 | 한국어 | |
it | 意大利语 | Italiano | |
uk | 乌克兰语 | Українська |