1. 需求背景与适用场景

1.1 需求背景

Smartbi AIChat 提供了多种使用方式，供用户自由选择。如果常用PC端，我们有基于PC浏览器的AIWeb页面；如果常用手机，我们有基于手机的App或者使用手机浏览器访问的AIChatView页面；我们还提供了基于钉钉、企微、飞书等IM的使用页面。

但是，这些都是Smartbi AIChat平台内置的使用页面，页面样式和操作方式是基于产品内置好的。如果用户想把自然语言查询集成到用户自己的APP里面，或者集成到用户其他的平台里面，我们内置的页面样式可能不太符合用户的要求，集成起来就不自然。 

为了让用户在使用Smartbi自然语言查询的时候，可以自定义前端页面，我们提供了基于Java语言实现的RestFul API接口。本文主要就是介绍如何使用Smartbi AIChat的接口实现自己的前端页面。

...

提供了多种使用方式，供用户自由选择。如果常用PC端，我们有基于PC浏览器的AIWeb页面；如果常用手机，我们有基于手机的App或者使用手机浏览器访问的AIChatView页面；我们还提供了基于钉钉、企微、飞书等IM的使用页面。但是，这些都是AIChat平台内置页面，页面样式和操作方式是基于产品内置好的。如果要把AIChat集成到客户自己的APP里，或者集成到其他平台中，Smartbi AIChat内置页面样式可能不符合要求。 为了让客户在使用AIChat的时候可以自定义前端页面，我们提供了 Restfull API 接口。本文主要就是介绍如何使用 AIChat 接口实现客户自己的前端页面。

1.2 适用场景

使用Smartbi AIChat 提供的API适合以下场景开发：提供的API适合以下应用场景的开发：

• 觉得Smartbi内置的对话界面不好看，可以使用Smartbi扩展包机制重新开发使用界面觉得Smartbi AIChat内置对话界面不好看，可以使用Smartbi扩展包机制重新开发使用界面。
• 需要将对话嵌入到集团内部APP中，可以定制Android/IOS原生界面，或者嵌入自定义H5页面IOS原生界面，或者嵌入自定义H5页面。
• 需要嵌入到其他的Web平台中，可以定制H5页面需要嵌入到其他的Web平台中，可以定制H5页面。
• 需要嵌入其聊天工具中（如：钉钉、微信等），可以定制符合聊天工具要求的页面需要嵌入其聊天工具中（如钉钉、企业微信、飞书等），可以定制符合聊天工具要求的页面。
• 其他使用场景，可以咨询Smartbi客服团队，获取支持其他使用场景，可以咨询Smartbi客服团队，获取支持。

2.

...

【用户自定义对话界面-逻辑架构图】

说明：

• 用户自定义界面，可以脱离Smartbi，嵌入在第三方平台里面，包括：
  • 第三方Web应用
  • 第三方Android应用
  • 第三方IOS应用

如果是Web页面，推荐使用Smartbi扩展包方式开发集成页面。这样可以避免跨域问题。如果需要在第三方应用中开发，需要做对所有API做服务端转发。

...

 技术架构

用户自定义对话界面的逻辑架构图如下。

Image Added

• 用户自定义界面，可以脱离Smartbi AIChat，嵌入在第三方平台里面，包括：
  • 第三方Web应用。
  • 第三方Android应用。
  • 第三方IOS应用。
• 如果第三方系统也是Web页面，推荐使用Smartbi扩展包方式开发集成页面，这样可以避免跨域问题。如果需要在第三方非Web应用中开发，需要对所有API做服务端转发。

3. API说明

Smartbi AIChat二次开发，提供的是标准Restful API。只需要登录后，执行查询就可以了。所以，只需要2个API就可以完成需要的操作。

...