...
第一层result的属性 | 属性含义 | 说明 |
code | NLA请求返回码 | 0表示成功,负数表示错误,整数是路由码 |
message | 错误信息 | 负数才有值 |
result | JSON对象 | 不同的code,返回的内容不一样,详细内容见后续表格 |
token | token信息 | 登录方法特有内容,这个非常重要,后续接口需要传递该值以验证登录 |
- query返回 result.code=0,仅列举需要的属性(0,仅列举主要的属性(正确查询)
第二层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 |
- query返回 result.code=50,仅列举需要的属性(选择不确定实体)
- 啊啊啊
第二层result属性 | 属性含义 | 说明 | ||
intentionType | 选择类型 | ● sim_table 选择不确定的数据集(数据模型、业务主题) ● fuzzy_entity 选择不确定的维度、指标、成员 | ||
interActionItems | 需要选择的内容 | 用于构造界面 | ||
intentionParams | 模型识别参数 | 需要原样返回给服务器nl2sql | 查询定义 | nl2sql的详细定义 |
- 选择数据集样例(sim_table )
{
"queryIntention": "sim_table",
"rhetoricalQuestionType": "sim_table",
"desc": "发现多个相似表,请从以下列表进行选择并确认。",
"fuzzyObjects": null,
"alternatives": [
[
"业务主题:主流热销私家车",
"数据模型:hcy热销车"
]
],
"alternativesRealValue": [
[
"THEME.demo2019.CSAC汽车销售分析",
"I8a8aa3ed017bc404c404760a017bc40bc0b90004"
]
],
"userSelected": null,
"otherParams": "{\"system_question\":\"发现多个相似表,请从以下列表进行选择并确认。\",\"id_list\":[[\"THEME.demo2019.CSAC汽车销售分析\",\"I8a8aa3ed017bc404c404760a017bc40bc0b90004\"]],\"fuzzy_entity_list\":[],\"option_list\":[[\"业务主题:主流热销私家车\",\"数据模型:hcy热销车\"]],\"theme_id\":\"\",\"question_ori\":\"去年长安各车型的销售量\"}"
},
...