You need to enable JavaScript to run this app.
文档中心
文档控制台
注册
数据智能体 DataAgent(私有化)

数据智能体 DataAgent(私有化)

复制全文
下载 pdf
智能问数(旧版)
参考:智能分析Agent OpenAPI 图表消费说明
复制全文
下载 pdf
参考:智能分析Agent OpenAPI 图表消费说明

使用OpenAPI方式进行数据查询时,您可以设置查询结果返回的图表格式(imageFormat参数),本文为您介绍不同类型的图表返回结果如何解析使用。

背景信息

在数据查询OpenAPI中,您可以设置imageFormat参数设置查询结果的图表格式,支持设置为:

| | | | \

返回图表格式类型 返回结果格式说明 适用场景
image_url 返回的是静态图片的 url 地址。 PC 端快速消费(无法交互),不做任何二次开发。
lark_fragment(推荐) 飞书格式富文本,返回结果是飞书原生片段格式。 飞书端消费,通过卡片等格式消息推送可交互图表,需要较少的二次开发
lark_image_key 飞书图片key,返回结果是飞书静态图片格式。 飞书端消费,通过卡片等格式消息推送静态图表图片(无法交互),需要较少的二次开发
vchart_schema 返回结果是 vchart 和 vtable 图表原生格式。 PC 端消费,需要较多的二次开发
返回的图表不是静态图片,而是可交互的真实图表,也可以自定义样式主题或数值格式化

运行数据查询OpenAPI后的返回结果中,charts字段即为返回的推荐图表列表,当前最多返回top4图表,即最符合场景的4个图表,优先推荐顺序是从上到下,即第一个是最推荐的。您可以通过设置入参 maxImageNumber 修改返回 topN图表数量。
![Image](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/7b097bfd177b44beab14ecf8ead4559d~tplv-goo7wpa0wc-image.image =1280x)
:::tip
当前支持的图表类型包括折线图、柱状图、饼图等多种类型,更多关于支持的图表类型和使用实践可参见最佳实践:支持的图表类型与使用实践
:::

图表结果解析消费

image_url格式

当 OpenApi 传入的入参 imageFormat 为"image_url"时,返回图表为静态图片 url 地址格式,您可直接消费图片链接即可,无需其他处理。

lark_fragment格式

  • 返回结果示例:
    当 OpenApi 传入的入参 imageFormat 为"lark_fragment",返回图表为飞书原生片段格式,示例如下:
    ![Image](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/87d78300fa2b47089080f0183730c28c~tplv-goo7wpa0wc-image.image =670x)

  • 消费使用:OpenAPI返回的 larkFragment 只是一个飞书原生片段,如果您希望最终展示在飞书应用中是消息卡片的样式,您需要将 OpenAPI 返回的 larkFragment 封装在此结构里。

    {
      "header": {
        "template": "blue",
        "title": {
          "content": "示例",
          "tag": "plain_text"
        }
      },
      "elements": [
        charts[0].larkFragment // dataagent OpenApi 返回图表内容
      ]
    }
    

    封装后的展示效果示例:
    ![Image](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/eef77b8abff145748143e5df52f40fad~tplv-goo7wpa0wc-image.image =398x)

lark_image_key

  • 返回结果示例:
    当 OpenApi 传入的入参 imageFormat 为"lark_image_key",返回图表为飞书图片格式,示例如下:
    ![Image](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/ea4403aa028c4ea5a2d67fb17d350a49~tplv-goo7wpa0wc-image.image =646x)

  • 消费使用:OpenAPI返回的 imageLarkKey 只是一个飞书 image_key,如果您希望最终展示在飞书应用中是消息卡片的样式,您需要将 OpenAPI 返回的 larkFragment 封装在此结构里。

    {
        "header": {
            "template": "blue",
            "title": {
                "content": "lark_image_key 测试",
                "tag": "plain_text"
            }
        },
        "elements": [
            {
                "tag": "img",
                "img_key": charts[0].imageLarkKey, // dataagent OpenApi 返回图表内容
                "alt": {
                    "tag": "plain_text",
                    "content": "柱状图"
                }
            }
        ]
    }
    

    封装后的展示效果示例:
    ![Image](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/61ebdb7a07144b769be56fb558746138~tplv-goo7wpa0wc-image.image =361x)

vchart_schema

当 OpenApi 传入的入参 imageFormat 为“vchart_schema”,返回图表为 vchartvtable 图表原生格式,业务的前端开发需要根据返回的 chartType,安装 vchartvtable 组件库实现真实渲染。各类图表的示例如下。

| | | | \

图表类型 OpenAPI返回结果示例 消费使用示例
饼图 ![Image](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/0a9c4906ed364dcaa1c6a397997ad6be~tplv-goo7wpa0wc-image.image =1806x) \
1. 复制返回的 vchartSchema 内容
2. 前端通过 vchart 消费
您可以通过 测试地址 对返回结果进行测试解析,消费结果示例如下。
![Image](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/46a658b6401e4b13ab377cff48c501c8~tplv-goo7wpa0wc-image.image =3448x)
柱状图 \
![Image](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/4a86ff9a15a34beab8890d201039959f~tplv-goo7wpa0wc-image.image =330x) \
1. 复制返回的 vchartSchema 内容
2. 前端通过 vchart 消费
您可以通过 测试地址 对返回结果进行测试解析,消费结果示例如下。
![Image](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/463dd1b5b6d34645ab7bc6a45932f56c~tplv-goo7wpa0wc-image.image =3456x)
指标卡 暂无 1. 复制返回的 vchartSchema 内容
2. 前端通过 DOM 实现,没有依赖开源库
折线图 ![Image](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/d97aee6f6b644cb6a09a860cb313da2f~tplv-goo7wpa0wc-image.image =2252x) \
1. 复制返回的 vchartSchema 内容
2. 前端通过 vchart 消费
您可以通过 测试地址 对返回结果进行测试解析,消费结果示例如下。
![Image](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/d49f5c18d3714a38b056f4e482ed4496~tplv-goo7wpa0wc-image.image =3430x)
双轴图 ![Image](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/61c37f50c86b428294a1e74c05f472cb~tplv-goo7wpa0wc-image.image =2272x) \
1. 复制返回的 vchartSchema 内容
2. 前端通过 vchart 消费
您可以通过 测试地址 对返回结果进行测试解析,消费结果示例如下。
![Image](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/81a6fc64061f42c6b1b803e859f6ff35~tplv-goo7wpa0wc-image.image =3436x)
组合图 ![Image](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/136717f4c10041a594c9d287687296c0~tplv-goo7wpa0wc-image.image =1680x) \
1. 复制返回的 vchartSchema 内容
2. 前端通过 vtable + vchart 消费
您可以通过 测试地址 对返回结果进行测试解析,消费结果示例如下。
![Image](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/7a6c333e44e24c6abaa7ba7c1e24eef4~tplv-goo7wpa0wc-image.image =3442x)
表格 ![Image](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/3ee1694bad8d4ae99965a1987bdf7566~tplv-goo7wpa0wc-image.image =1796x) \
1. 复制返回的 vchartSchema 内容
2. 前端通过 vtable 消费
您可以通过 测试地址 对返回结果进行测试解析,消费结果示例如下。
![Image](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/12213d0e14834019aca473fe90585ce5~tplv-goo7wpa0wc-image.image =3456x)
最近更新时间:2026.07.07 20:00:16
这个页面对您有帮助吗?
有用
有用
无用
无用