...
URL参数名 | URL参数值 | 说明 | |
输入参数 | className | AIChatRemoteService | |
methodName | loginIfSmartbiLogged | ||
params | [] | 样例：[] | |
返回值 | retCode | 0 | 非0表示错误 |
result | {\"token\":\"CE3CE70AC12B70052A507D4B560E5374\"} | NLA 的token信息，这个非常重要，后续NLA所有方法需要用到这个token； 非0时是错误信息 |
4.4 查询数据模型清单、推荐问句
该方法，最主要就是设置 interActionInput.userSelected
URL参数名 | URL参数值 | 说明 | |
输入参数 | className | AIChatRemoteService | |
methodName | getBuildThemes | ||
params | |||
token | loginIfSmartbiLogged方法获取的token | ||
返回值 | retCode | 0 | 参考query方法 |
result | 参考query方法 |
- PostMan - 登录方法测试样例
- 接口返回示例
- 接口返回说明
4.3 执行查询
URL参数名 | URL参数值 | 说明 | |
输入参数 | className | AIChatRemoteService | |
methodName | query | ||
params | txt | 问句 | |
token | loginIfSmartbiLogged方法获取的token | ||
| isMultiQuery | 查询类型，该参数为空，则由AIBus判断是否多轮 | ||
themeId | 数据模型id，可为空，有推荐 | ||
reportId | 报表Id，设置为空 | ||
uuid | 设置为空 | ||
userChoseThemeId | 用户选择的模型id 用于锁定模型查询，设置为空 | ||
isMobileCall | 是否手机请求，设置为false | ||
getPageBO | 是否需要仪表盘定义，设置为false | ||
| subTable | 子表 | ||
| llmReviseQuestionWithUserGuide | 合并问句 | ||
| returnPrompt | 是否返回提示词，字符串：true，false | ||
| returnJSON | 是否返回json数据 | ||
返回值 | retCode | 0 | 非0表示错误 |
result | 见下表 |
- PostMan - 登录方法测试样例
- 返回示例接口返回示例
- query方法的返回值比较复杂，下表会详细说明query的返回值。接口返回说明：query方法的返回值比较复杂，下表会详细说明query的返回值。
第一层result的属性 | 属性含义 | 说明 |
code | NLA请求返回码 | 0表示成功，负数表示错误，整数是路由码 |
message | 错误信息 | 负数才有值 |
result | JSON对象 | 不同的code，返回的内容不一样，详细内容见后续表格 |
| token | token信息 | 登录方法特有内容，这个非常重要，后续接口需要传递该值以验证登录 |
...
第二层result属性 | 属性含义 | 说明 |
| intentionType | 意图类型 | text2sql的类型 |
uuid | 本次查询uuid | 记录查询日志id |
rowsCount | 本次查询结果数据总行数 | 表格才生效 |
currentRows | 当前返回数据行数 | 表格才生效 |
currentPage | 当前页码 | 表格才生效 |
rowsPerPage | 每页行数 | 表格才生效 |
clientId | 本次查询id | 记录查询id，用于翻页时标记查询缓存 |
html | 返回结果 | ● 如果是图形，则返回ECharts定义 ● 如果是表格直接返回html |
portletType | 仪表盘组件类型（queryType=PageQuery才生效） | ● ECHARTS_BAR 图形：柱图 ● ECHARTS_LINE 图形：线图 ● ECHARTS_PIE 图形：饼图 ● TABLE_LIST 表格：清单表 ● TABLE_CROSS 表格：交叉表 |
queryType | 查询类型 | ● PageQuery（数据模型、业务主题出图时） ● InsightQuery（业务主题） ● CombinedQuery（业务主题） |
question | 本次查询的问题 | |
resultTips | 本次查询的条件 | where或者having条件 |
themeId | 本次查询的数据模型/业务主题id | |
| nl2sql | 查询定义 | nl2sql的详细定义 |
4.4 选择不确定的实体（维度、指标、成员）
该方法，最主要就是设置 interActionInput.userSelected
URL参数名 | URL参数值 | 说明 | 输入参数 | className | AIChatRemoteService | methodName | rhetoricalQuestionResultInput |
params | question | 问句 | |
datasetId | 数据集Id，query返回的themeId | ||
uuid | query返回的uuid | ||
isMultiQuery | 多否多轮查询，设置false | ||
multiMark | 多选标记，设置空 | ||
interActionInput | 在query方法返回的interActionItems属性基础上，添加了userSelected属性内容，填写了用户选择的内容的Id（在interActionItems属性中有提供） | ||
intentionParams | 把query返回的结果中的intentionParams属性原样传递回服务器 | ||
token | loginIfSmartbiLogged方法获取的token | ||
isMobileCall | 是否手机请求，设置为false | ||
getPageBO | 是否需要仪表盘定义，设置为false | ||
返回值 | retCode | 0 | 参考query方法 |
result | 参考query方法
4.5 选择不确定的模型
该方法，最主要就是设置 datasetId
...
