...
返回值 | { "code": 0, "result": [ { "id": "I8a80818c0191262b262b26b0019126c8d71a****", "name": "****NLA-绩效考核-20240806", "title": "****NLA-绩效考核-20240806", "desc": "**证券NLA-绩效考核-20240806包含了年月、年、指标名称、指标口径、指标大类、指标负责人、指标细类、分支机构考核类别、所属考核组织类型、分支机构分组等字段", "type": "augmentedDataset", "recommendQuestion": [ "每年指标名称排名", "每年得分", "近5年指标名称得分", "排名按年份排序，线图显示", "排名的合计" ], "lastBuildTime": "2024/08/09 16:11:00" } ], "duration": 131, } |
- 接口返回说明
返回参数名 | 返回值说明 |
reCoderetCode | 接口调用是否成功；大于等于0 - 表示成功；负数为错误码 |
result | 调用接口的返回内容，登录接口的返回内容说明如下： "id": 数据模型themeID "name": 数据模型名称 "title": 数据模型名称别名 "desc"： 数据模型概览 "type": 数据类型 "recommendQuestion": 推荐问句 "lastBuildTime": 最近构建时间 ... 其他返回值可以忽略 |
...
返回值 | { "code": 0, "result": { "currentRows": "", "currentPage": "", "rowsPerPage": "", "portletType":"", "html":"", "nl2sql":"", "llm":"", ... }, "message": "", "token": "" } |
- 接口返回说明
第一层result的属性 | 属性含义 | 说明 |
coderetCode | NLA请求返回码 | 0表示成功，负数表示错误，整数是路由码 |
message | 错误信息 | 负数才有值 |
result | JSON对象 | 不同的code，返回的内容不一样，详细内容见后续表格不同的retCode，返回的内容不一样，详细内容见后续表格 |
| token | token信息 | 登录方法特有内容，这个非常重要，后续接口需要传递该值以验证登录 |
...
返回参数名 | 返回值说明 |
retCode | 接口调用是否成功；大于等于0 - 表示成功；负数为错误码 |
message | 错误描述，code=0 时，该内容为空 |
token | 登录方法特有内容，这个非常重要，后续接口需要传递该值以验证登录 |
result | 调用接口的返回内容，登录接口的返回内容说明如下： "html": 切换后的图表的html "portletType": 切换后的图标的类型 ... 其他返回值可以忽略 |
4.8 查询结果设置输出行数
URL参数名 | URL参数值 | 说明 | |
输入参数 | className | AIChatRemoteService | |
methodName | setRowsPerPage | ||
params | clientId | 用户的查询问句的clientId（可以从执行查询接口获取） | |
| pageSize | 设置每页输出大小 | ||
| queryType | 用户的查询问句的queryType（可以从执行查询接口获取) | ||
dataSource | 数据来源，通常固定为smartbiproxy | ||
| token | loginIfSmartbiLogged方法获取的token | ||
返回值 | retCode | 0 | 非0表示错误 |
result |
- PostMan - 登录方法测试样例
- 接口返回示例
返回值 | {"retCode":0,"result": "{"code":0,"result":null,"message":null,"token":"B38F13B1700652D1AC9E352E082DC10E"}", "duration":56} |
- 接口返回说明
返回参数名 | 返回值说明 |
retCode | 接口调用是否成功；0 - 表示成功；负数为错误码 |
message | 错误描述，code=0 时，该内容为空 |
token | 登录方法特有内容，这个非常重要，后续接口需要传递该值以验证登录 |
result | 调用接口的返回内容 |
5. Demo开发设计
本次教程，仅以Web开发作为示例，说明如何调用Smartbi NLA的二次开发API实现自定义对话界面的过程。Android应用和IOS应用基本调用API的方法是一致的，区别只是使用的开发平台不同。开发工程师需要在对应的开发平台上做调整。
...
