...
返回参数名 | 返回值说明 |
retCode | 接口调用是否成功；0 - 表示成功；负数为错误码 |
message | 错误描述，code=0 时，该内容为空 |
token | 登录方法特有内容，这个非常重要，后续接口需要传递该值以验证登录 |
result | 调用接口的返回内容 |
4.9 查询结果分页
URL参数名 | URL参数值 | 说明 | |
输入参数 | className | AIChatRemoteService | |
methodName | queryWithPage | ||
params | token | loginIfSmartbiLogged方法获取的token | |
| clientId | 用户的查询问句的clientId（可以从执行查询接口获取） | ||
| page | 设置翻页，第几页 | ||
dataSource | 数据来源，通常固定为smartbiproxy | ||
| queryType | 用户的查询问句的queryType（可以从执行查询接口获取) | ||
返回值 | retCode | 0 | 非0表示错误 |
result |
- PostMan - 登录方法测试样例
- 接口返回示例
返回值 | {"retCode":0, "result":"{"code":0, "result": {"intentionType":null, "queryRecordIndex":null, "multiRecordSessionId":null, "uuid":null, "rowsCount":-1, "currentRows":10, "currentPage":2, "rowsPerPage":10, "html":"..." } "token":"1B08EF32A971F5DE5981C61AE812C577" }", "duration":177} |
- 接口返回说明
返回参数名 | 返回值说明 |
retCode | 接口调用是否成功；0 - 表示成功；负数为错误码 |
token | 登录方法特有内容，这个非常重要，后续接口需要传递该值以验证登录 |
result | 调用接口的返回内容，登录接口的返回内容说明如下： "currentRows": 当前页行数 "currentPage": 当前页码 "rowsPerPage": 每页行数 "portletType"： 显示类型（表格、图形等） "html": 如果是表格，为html，如果是图形为Echarts Options ... |
4.10 清除对话历史（开启新对话）
Smartbi NLA 是可以启用“多轮对话”和“单轮对话”的，具体操作方法在对话式分析主页面中勾选，这里不详细描述。在启用多轮对话的时候，
有时需要清空对话历史（也就是开启新的对话）。开启新对话需要使用该API实现。
URL参数名 | URL参数值 | 说明 | |
输入参数 | className | AIChatRemoteService | |
methodName | closeQuery | ||
params | token | loginIfSmartbiLogged方法获取的token | |
返回值 | retCode | 0 | 非0表示错误 |
result |
- PostMan - 登录方法测试样例
- 接口返回示例
返回值 | {"retCode":0,"duration":30} |
- 接口返回说明
返回参数名 | 返回值说明 |
retCode | 接口调用是否成功；0 - 表示成功；负数为错误码 |
5. Demo开发设计
本次教程，仅以Web开发作为示例，说明如何调用Smartbi NLA的二次开发API实现自定义对话界面的过程。Android应用和IOS应用基本调用API的方法是一致的，区别只是使用的开发平台不同。开发工程师需要在对应的开发平台上做调整。
...
