1. 需求背景与适用场景
1.1 需求背景
Smartbi NLA AIChat 本身是提供了多种客户端供用户选择的。如果常用PC，我们有基于PC浏览器的AIWeb页面；如果常用手机，我们有基于手机的App或者使用手机浏览器访问的AIChatView页面；我们还提供了基于钉钉的使用页面。
但是，这些都是Smartbi NLA平台内置的使用页面，页面样式和操作方式是基于产品内置好的。如果用户想把自然语言查询集成到用户自己的APP里面，或者集成到用户其他的平台里面，我们内置的页面样式可能不太符合用户的要求，集成起来就不自然。AIChat平台内置的使用页面，页面样式和操作方式是基于产品内置好的。如果用户想把自然语言查询集成到用户自己的APP里面，或者集成到用户其他的平台里面，我们内置的页面样式可能不太符合用户的要求，集成起来就不自然。
为了让用户在使用Smartbi自然语言查询的时候，可以自定义前端页面，我们提供了基于Java语言实现的RestFul API接口。本文主要就是介绍如何使用Smartbi NLA的接口实现自己的前端页面。AIChat的接口实现自己的前端页面。
1.2 适用场景
使用Smartbi NLA 使用Smartbi AIChat 提供的API适合以下场景开发：
- 觉得Smartbi内置的对话界面不好看，可以使用Smartbi扩展包机制重新开发使用界面
- 需要将对话嵌入到集团内部APP中，可以定制Android/IOS原生界面，或者嵌入自定义H5页面
- 需要嵌入到其他的Web平台中，可以定制H5页面
- 需要嵌入其聊天工具中（如：钉钉、微信等），可以定制符合聊天工具要求的页面
- 其他使用场景，可以咨询Smartbi客服团队，获取支持
...
【PostMan - 登录方法测试样例】
4. API说明
Smartbi NLA提供了比较丰富的二次开发API，本次Demo只使用了一部分。这个章节，重点介绍下本次Demo使用的API。AIChat提供了比较丰富的二次开发API，本次Demo只使用了一部分。这个章节，重点介绍下本次Demo使用的API。
以下介绍的接口，调用方法和调用URL是一样的，区别仅仅是参数不同，所以对每个API不会重复介绍调用方法，具体调用方法请参考：上一章节的 “Smartbi接口调用说明”
...
返回参数名 | 返回值说明 |
retCode | 接口调用是否成功；0 - 表示成功；负数为错误码 |
token | 登录方法特有内容，这个非常重要，后续接口需要传递该值以验证登录 |
result | 调用接口的返回内容，登录接口的返回内容说明如下： "currentRows": 当前页行数 "currentPage": 当前页码 "rowsPerPage": 每页行数 "portletType"： 显示类型（表格、图形等） "html": 如果是表格，为html，如果是图形为Echarts Options ... |
4.10 清除对话历史（开启新对话）
Smartbi NLA Smartbi AIChat 是可以启用“多轮对话”和“单轮对话”的，具体操作方法在对话式分析主页面中勾选，这里不详细描述。在启用多轮对话的时候，
...
返回参数名 | 返回值说明 |
retCode | 接口调用是否成功；0 - 表示成功；负数为错误码 |
5. 页面集成
SmartBi NLA提供三种页面集成的方式 AIChat提供三种页面集成的方式 。
5.1 页面集成方式一
名称 | 值 |
请求地址 | |
参数说明 | question：问句，可以选填 userName：用户名 password：密码 |
请求URL：http://smartbi-nlaaichat-server:port/smartbi/vision/AIChatView2.html?userName=admin&password=admin
...
5.2 页面集成方式二
名称 | 值 |
请求地址 | |
参数说明 | userName：用户名 password： 密码 surl ：/smartbi/smartbix/#/sdk |
...
