智能问数：飞书端--数据智能体-火山引擎

文档中心

立即注册

导航

智能问数：飞书端

最近更新时间：2025.11.21 11:41:14首次发布时间：2025.10.09 17:35:37

本接口用于调用OpenAPI接口，使用飞书端的智能分析Agent查询数据。

请求说明

请求方式：POST
请求地址： https://{domain}/aeolus/llm/openApi/v2/chatbi/query

请求参数

参数	类型	是否必选	示例值	描述
question	string	是	10月20日有多少文章	问题
chatId	string	否	100000	如果是独立问题，可不传；如果是多轮对话需上传会话 ID，同一个chatId的问题会视为同一会话中的多轮问题对话。
agentId	int	是	1000	智能体 ID，获取方式见下方的说明。
imageFormat	string	是	lark_fragment	指定返回的查询结果中图表的格式类型： lark_fragment：飞书格式富文本 image_url：图片url地址，仅SaaS环境的华北2（北京）地域支持。 lark_image_key：飞书图片key vchart_schema：vchart图表配置注意因环境可能会出现图片生成服务未 ready 的情况，为了防止出错，建议"imageFormat"字段传入固定值"lark_fragment"。不同图表结果类型的适用场景和图表解析使用指导可参见参考：智能分析Agent OpenAPI 图表消费说明。
enableAnalysis	bool	否	false	是否启用开启图表分析，默认值为：false。设置为true后，智能体将在进行数据查询的过程中同步对查询结果的图表进行分析，返回智能体的问题结果时，会同步返回图表的解读内容。注意 DataAgent的管理后台的“基本信息”页面也有智能体的“开启图表分析”配置开关，调用OpenAPI时，此处的参数配置结果如果与控制台界面配置结果不一致：调用OpenAPI时，OpenAPI的配置结果优先级高于控制台界面的配置结果，OpenAPI的返回结果以API请求参数的配置结果为准。但是OpenAPI的配置结果不会覆盖控制台界面配置的结果，即界面上使用智能体的返回结果以界面配置为准。

说明

APPID和AGENT_ID获取方式见智能体网页链接：

请求示例

{
    "question": "10月20日有多少文章",    // 问题，必填
    "chatId": "100000",    // 会话ID，同一个chatId视为多轮对话，如果是独立问题，可不传
    "agentId": 1000,   // 智能体ID
    "imageFormat": "lark_fragment"  // 传入该值
}

返回参数

参数	类型	示例值	描述
charts	array		返回的查询结果图表。通常会根据您的查询问题返回不同类型的图表，例如折线图、柱状图等。当前最多返回top4图表，即最符合场景的4个图表，优先推荐顺序是从上到下，即返回结果的第一个图表为推荐的图表，更便于做查询结果分析。以界面化的查询为例，图表结果类似：支持类型包括： "column_parallel"：柱状图 "combination"：组合图 "line"：折线图 "pie"：饼图 "measure_card"：指标卡 "table" ：表格 scatter：散点图 map：中国地图 double_axis：双轴图更多关于支持的图表类型和使用实践可参见最佳实践：支持的图表类型与使用实践。您在请求参数中通过imageFormat参数设置了结果图表的返回类型，不同图表结果类型的图表解析使用指导可参见参考：智能分析Agent OpenAPI 图表消费说明。
dataSetUrl	string	https://数据集网址	智能体所配置数据集的链接
meta	array		结果字段描述信息，可以理解为表头，其中 role 参数表明该查询结果字段角色，measure 为指标，dimension 为维度。
queryHistory	string	https://网址	sql查看地址
rows	array	[ // 查询数据结果 [ 369251756 ] ]	结果数据
sql	string	SELECT (count(*)) AS article_count FROM `event_online` WHERE (`1702552137_日期`) = ('2024-10-20') LIMIT 1000	查询sql
thought_process	string	模型的输出信息	模型的思考过程

返回示例

{
    "code": "llm/ok", // 状态码
    "data": {
        "charts": [ //图表类型
            {
                "chartType": "measure_card",    
                "image": "",
                "imageLarkKey": null,
                "larkFragment":"{\"tag\": \"column_set\", \"flex_mode\": \"stretch\", \"background_style\": \"grey\", \"horizontal_spacing\": \"default\", \"columns\": [{\"tag\": \"column\", \"width\": \"weighted\", \"weight\": 1, \"elements\": [{\"tag\": \"markdown\", \"text_align\": \"left\", \"content\": \"article_count(\文\章\数\量):\\n**369251756**\"}]}]}"
            },
            {
                "chartType": "table",
                "image": "",
                "imageLarkKey": null,
                "larkFragment":"{\"tag\": \"table\", \"page_size\": 6, \"row_height\": \"32px\", \"custom_tag\": \"chart_type_table\", \"header_style\": {\"bold\": true, \"background_style\": \"grey\", \"text_size\": \"normal\", \"row_height\": \"middle\", \"lines\": 2}, \"columns\": [{\"name\": \"173329985\", \"display_name\": \"article_count(\文\章\数\量)\", \"data_type\": \"text\"}], \"rows\": [{\"1733765\": \"36926\"}]}"
            }
        ],
        "dataSetUrl": "https://网址",// 数据集链接
        "meta": [// 查询结果字段列表
            {
                "dataType": "int", //字段类型
                "name": "article_count(文章数量)", //字段名称
                "role": "measure" //指标 或 维度
            }
        ],
        "queryHistory": "https://data.", //sql查看地址
        "rows": [ // 查询数据结果
            [
                369251756
            ]
        ],
        "sql": "  SELECT  (count(*)) AS article_count  FROM `event_online`     WHERE (`170252137_日期`) = ('2024-10-20')      LIMIT 1000   " //查询sql,
        "thought_process":"用户想了解今年的xx情况。根据数据集定义，我们需要筛选出今年的数据，并展示xx的相关指标。...."
    },
    "msg": {} //额外信息
}