页面树结构

版本比较

标识

  • 该行被添加。
  • 该行被删除。
  • 格式已经改变。

...

通过API接口方式集成,相对比较复杂,并且做集成的第三方系统需要做非常多的工作。如果第三方系统只是需要让自己具备“问数”能力,把用户所有问数的请求都转给 AIChat 直接处理,则可以直接把 AIChat 整体嵌入到自己的页面中。此种集成方式最简单,几行代码即能搞定,并且还能充分发挥 AIChat 所有前端的便捷功能,而不仅仅是使用它的“问数”能力。本文重点介绍此种集成方式。

2.

...

参数
描述
user 登录 Smartbi 的用户名
password 登录Smartbi的用户密码
id 模块id,参数值请见后文
showbanner 是否显示Smartbi的标题栏。不设置此参数或设置为false时,不显示标题栏;设置为true时,则显示。
传递上述四个参数,集成分析展现模块的访问地址,如下所示。

...

集成地址及参数

在第三方系统中集成 AIChat,如果是web页面,直接在页面中放置一个 iframe 元素,然后嵌入如下 URL地址即可。


代码块
http://
localhost
Smartbi-server:
18080
port/smartbi/vision
/openmodule.jsp?id=Analysis&showbanner=false&user=admin&password=manager
效果如下所示。

3.集成模块与参数对应关系
具体每个模块的集成示例请见集成示例。

4.集成示例
4.1 我的工作区
支持id: privatefolder、favorite

折叠代码
http://localhost:8080/smartbi/vision/openmodule.jsp?id=privatefolder&showbanner=false
4.2 消息详情
集成消息详情模块访问地址(只能访问未读的消息),如下所示。

折叠代码
http://localhost:8080/smartbi/vision/openmodule.jsp?id=messageDetail&showbanner=true&b64msg=eyJpZCIgOiAiSThhOGE5ZjVlMDE3OWVhYmZlYWJmMGVlOTAxNzllYWVlYzk4NzAwOGYiLCAiY2F0ZWdvcnkiIDogInByaXZhdGUifQ==
其中b64msg为{"id" : "I8a8a9f5e0179eabfeabf0ee90179eaeec987008f", "category" : "private"}的base64加密字符串。

...

/aichat/proxy/#/
然后在上述 URL 后面附加各种参数,来控制 AIChat 的界面及行为。下面详细说明支持的参数、以及该参数对应的效果。

参数

备选值/默认值

说明

navigationPanel

  • show:显示(默认值)

  • hide:隐藏

  • delete:删除

左侧的导航栏面板。

  • show:显示导航面板。

  • hide:隐藏导航面板,但用户可以通过点击 Image Added 图标将其显示出来。

  • delete:隐藏导航模板,同时不显示Image Added 图标,此时用户无法再将导航面板调出。

logoSection

  • show:显示(默认值)

  • hide:隐藏

左侧导航栏面板上顶部的LOGO区域。

chatHistorySection

  • show:显示(默认值)

  • hide:隐藏

左侧导航栏面板上中间的“历史对话”区域。

userInfoSection

  • show:显示(默认值)

  • hide:隐藏

左侧导航栏面板上底部的用户信息区域。

dataPanel

  • show:显示(默认值)

  • hide:隐藏

  • delete:删除

右侧的数据面板。

  • show:显示数据面板。

  • hide:隐藏数据面板,但用户可以通过点击 Image Added 图标将其显示出来。

  • delete:隐藏数据模板,同时不显示 Image Added 图标,此时用户无法再将数据面板调出。

dataResourceId

Resource ID

资源ID,右侧数据面板上选中该资源

  • 数据模型ID。传入数据模型的resid,用户可以直接开始问数。

  • 对于“报表助手”智能体,可能传入多个resid(多个resid之间用逗号分隔),用户对多数据模型问数。

agentId

Agent ID

默认选中的智能体。

传入选中的智能体的“资源ID”,比如分析模式/专家模式/报表问数。




3. 集成示例

3.1 隐藏导航面板

打开 AIChat 时,默认隐藏左侧的“导航”面板,但同时允许用户再把它打开。

代码块
http://Smartbi-server:port/smartbi/vision/aichat/proxy/#/?navigationPanel=hide
  • 添加 navigationPanel=hide 参数后,集成的效果如下图。“导航”面板虽然被隐藏了,但用户可以通过点击顶部的“显示导航栏”按钮,再把导航面板显示出来。
  • Image Added

3.2 删除数据面板

打开 AIChat 时,默认隐藏右侧的“数据”面板,并且不允许用户再次把它打开。

代码块
http://Smartbi-server:port/smartbi/vision/aichat/proxy/#/?dataPanel=delete
  • 添加 dataPanel=delete 参数后,集成的效果如下图。“数据”面板被删除了,用户无法再把数据面板显示出来。
  • Image Added