...
名称 | 描述 | 默认值 | |
接口路径 | http://host:port/aiweb/api/v3/conv/query | ||
接口说明 | V3版本查询方法 -- 异步方法 -- SSE请求 | ||
header | token | 登录key，使用login方法获取；login方法请参考：登录AIChat | |
接口参数 | convId | 会话Id | |
datasetId | 数据模型Id | ||
question | 用户问题 | ||
queryType | 查询类型：
| 建议使用：analysis | |
id | 本次对话id 从外部传入才能做点赞点踩 | ||
need_inquiry | 本次查询是否需要使用反问功能 | default(true) | |
返回内容 | 返回SSE对象，前端处理 SSE返回报文样例： {"role": "SimpleQuery", "response_status": "generating code", "response_message": " \"", "execution_result": "", "send_to": "Unknown", "response_type": "python"} ... SSE 接口会返回很多条这样的报文；具体原理请自行查询百度。 请手工拼接返回报文 "response_message" 和 "execution_result" 部分内容；response_type 表示当前这条报文的返回内容是啥。 | ||
...
名称 | 描述 | 默认值 | |
接口路径 | http://host:port/aiweb/proxy/admin/v3/db/conv/get_list_by_user | ||
接口说明 | 获取当前用户可以使用的数据模型列表 | ||
header | token | 登录key，使用login方法获取；login方法请参考：登录AIChat | |
接口参数 | userName | 当前用户名 | |
返回内容 | { code: 错误码（0 - 表示正确） message：错误描述 result：[{ _id: 对话Id （convId）, name: 对话名称, endTime: 对话结束时间（时间戳 – long） }]} | ||
4.11 打开对话历史
名称 | 描述 | 默认值 | |
接口路径 | http://host:port/aiweb/proxy/admin/v3/db/conv/get_by_convid | ||
接口说明 | 获取当前用户可以使用的数据模型列表 | ||
header | token | 登录key，使用login方法获取；login方法请参考：登录AIChat | |
接口参数 | convId | 会话Id | |
返回内容 | { code: 错误码（0 - 表示正确） message：错误描述 result：[{ id: 消息Id convId： 会话Id, name: 对话名称, answer：消息返回报文 – 主要是解析这个内容 beginTime：消息开始时间 endTime: 消息结束时间（时间戳 – long） ... }]} | ||
4.12 删除对话历史
名称 | 描述 | 默认值 | |
接口路径 | http://host:port/aiweb/proxy/admin/v3/db/conv/remove_by_convid | ||
接口说明 | 获取当前用户可以使用的数据模型列表 | ||
header | token | 登录key，使用login方法获取；login方法请参考：登录AIChat | |
接口参数 | convId | 会话Id | |
返回内容 | { code: 错误码（0 - 表示正确） message：错误描述 result："" } | ||
5.界面集成
名称 | 描述 | 默认值 | |
URL路径 | /smartbi/vision/AIChatV3.html GET请求 示例： | ||
集成说明 | 本地址为bi里面的地址，必须登录bi后再使用。可以跳过登录步骤，直接打开v3的界面 | ||
参数 | 无 | ||
...
