You need to enable JavaScript to run this app.
导航
ChatBI 智能体三方集成说明
最近更新时间:2025.04.03 18:03:55首次发布时间:2025.04.03 18:03:55
我的收藏
有用
有用
无用
无用

1.概述

本文为您介绍的是“DataWind 智能体的三方集成说明”,您将了解到如何通过 API 进行 Web 端和移动端接入智能体。
注意:在您使用本文所述的 API 前,还需完成接入 JWT-Token 和申请 Token 的前置操作,请先了解调用方式,详情可阅读调用方式

2.三方集成方案接口

2.1 Web 端接入

基于 JWT-Token + iframe 效果如下图:

请求参数

参数

类型

是否必选

示例值

描述

domain

string

https://console.volcengine.com/bi/datawind

域名

  • 注意事项:
    • Saas环境 domain: https://console.volcengine.com/bi/datawind-open
    • 私有化domain: 实际部署的环境域名地址 ${domain}/bi

APPID

number

1

项目 id

jwtToken

string

eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoib3BlbmFwaSIsInVzZXJuYW1lIjoiYWRtaW4iLCJ1c2VyX3BheWxvYWQiOnt9LCJleHAiOjE3NDM1NjY0OTEsImNsaWVudF9pZCI6ImYzMDE5ZGMzZmZmNTE1MzhkMjM5Nzc0ZmI3ZjI4Mzg4In0.gHN39Aq3XQkiZpCJmcvBLaH1eMU1eFVM

用户 jwtToken

AGENT_ID

number

1

智能体 id

请求示例

<iframe
  src={`${domain}/#/agent?agentId={AGENT_ID}&appId={APPID}&inline=true&jwtToken={jwtToken}`}
/>

2.2 移动端接入

移动端视图可用于移动端 H5、侧边栏/浮窗唤起或者空间较小的时候进行接入。移动端视图与 PC 端视图会话完全一致,只是展示的效果不同。智能体页面做了自适应,在移动端访问时,会自动切换到移动端视图。
移动端接入效果预览,如下图所示:
Image

接入方式

正常使用移动端设备访问时会自动切换到移动端视图,也可以使用参数强制切换到移动端视图。在 urlqueryString后增加 &forceMobile=true

请求参数

同本文 2.1 Web端接入 - 请求参数

请求示例

<iframe src="${domain}/#/agent?agentId=${agentId}&appId={APPID}&jwtToken=${jwtToken}&inline=true&forceMobile=true" />