You need to enable JavaScript to run this app.
数据智能体 DataAgent（私有化）

数据智能体 DataAgent（私有化）

请输入
  • 文档首页
    • 数据智能体 DataAgent（私有化）开放与集成智能分析AgentOpenAPI深度研究执行深度研究任务
复制全文
我的收藏
深度研究
执行深度研究任务
复制全文
我的收藏
执行深度研究任务

请求说明

请求方式：POST
请求地址： https://{domain}/dataAgent/llm/openApi/v2/deepresearch/executeTask

请求参数

位置

参数

类型

是否必选

示例值
描述

ROOT

stream

bool

是

False

流式输出

content

string

是

分析一下销售额趋势

执行的具体任务

pushNotificationconfig

PushNotificationConfig

否

非必选，见请求示例

异步推送通知配置

metadata

TaskMeataData

是

见请求示例

任务元信息

TaskMeataData

agentId

int

是

1

智能体ID，您可以在智能体列表页面查看到对应智能体ID。获取智能体ID的方式请参见agentId。

templateId

int

否

1

强制召回模板ID，如果在请求参数中提供了强制召回模版，则后续深度研究任务执行时一定会使用该召回模板的分析思路进行深度分析。获取强制召回模板ID的方式请参见强制召回模板ID。

fileList

List[string]

否

["storage-A"]

需要额外分析的文件（仅通用智能体可用）。如果您希望在深度研究任务运行时参考指定的文件，您可以通过文件上传接口先将参考文件上传，上传后即可获取返回的storageKey值，即为此处的fileList取值。
上传文件接口详情请参见文件上传。

dataSetList

List[TaskDataSetInfo]

否

[
    {"id": 1, "appId": 1},
    {"id": 2, "appId": 1}
]

需要额外分析的数据集，垂类智能体已配置数据集，可不提供此参数。其中：

  • appId: 数据集所在项目id，获取方式请参见agentId。
  • Id: 数据集id，获取方式请参见dataSetId。

reportList

List[TaskReportInfo]

否

[
    {
        "reportId": 1,
        "appId": 1,
        "dashboardId": 1,
        "sheetId": 1
    },
    {
        "reportId": 2,
        "appId": 1,
    }
]

需要额外分析的可视化图表，其中：

  • reportId: 可视化图表ID，获取方式请参见rid（reportid）。
  • appId: 可视化图表所在项目Id，获取方式请参见appId。
  • dashboardId：图表所在仪表盘Id(非必填)，获取方式请参见dashboardid。
  • sheetId: 图表所在仪表盘对应的sheetId(非必填)，获取方式请参见sheetid。

enableRunningStepOutput

bool

否

False

默认False，为True时启用过程输出，见流式返回示例及参考：输出结果模块说明章节。

enableWebSearch

bool

否

False

配置是否启用联网搜索。

PushNotificationConfig

id

string

否

"push-1"

自定义推送id，用于标识该推送方式的id，非必填。

url

string

是

"https://example.com/webhook"

接受推送的url。

token

string

否

"123456"

用于接收方验证的token，非必填。

authentication

PushNotificationAuthentication

否

Bearer Token

{
    "schemes": ["Bearer"],
    "credentials": "sk-12345"
}

自定义ApiKey

{
    "schemes": ["ApiKey"],
    "credentials": "key:value"
}

认证信息，提供时会在Header中添加相应结构。

  • Bearer Token时，固定在Authorization请求头中提供。
  • 自定义ApiKey时，会以第一个冒号切分，冒号前为header中的key，冒号后为该key的value值。

请求示例 
{
    "stream": true,
    "metadata": {
        "agentId": 17368,
        "reportList":[
            {
                "appId":1004033,
                "reportId": 7112515
            }
        ],
        "dataSetList": [
            {
                "id": 1836089,
                "appId": 1004033
            }
        ],
        "fileList": [
            "agent-upload-20250916121852-a79607aef5e44339ad9afa1aa41c81b5"
        ]
    },
    "content": "立即进入报告编写阶段，在报告编写阶段中通过render_to_chart的方法将传入的文件df渲染为图表，只需要这一个步骤即可，报告长度不超过100词"
}

返回参数

非流式返回

位置

参数

类型

示例值

描述

ROOT

taskId

string

d9ec4b426c5a4f7d8e30ced79d5ecb0e

任务Id

{
    "JSONIFY_PRETTYPRINT_REGULAR": false,
    "code": "llm/ok",
    "data": {
        "taskId": "d9ec4b426c5a4f7d8e30ced79d5ecb0e"
    },
    "msg": {}
}

流式返回

位置

参数

类型

示例值

描述

ROOT

task

DeepResearchTask

见下方返回值示例

任务信息

artifactUpdate

DeepResearchTaskArtifactUpdateEvent

见下方返回值示例

产物更新结果，包含artifactId、name、meta等多个字段，详细介绍见下文的artifact定义章节。

statusUpdate

DeepResearchTaskStatusUpdateEvent

见下方返回值示例

任务状态更新

data: {"task": {"kind": "task", "id": "314b788f83394219afa563e47a******", "contextId": "fd86552d317b4733aa8e7438f81c84b5", "status": {"state": "submitted", "timestamp": "2025-09-26T14:50:42.280030"}, "metadata": {"agentId": 17368, "dataSetList": [{"id": 1836089, "appId": 1004033}], "reportList": [{"reportId": 7112515, "appId": 1004033}], "fileList": ["agent-upload-20250916121852-a79607aef5e44339ad9afa1aa41c81b5"]}}}

data: {"statusUpdate": {"kind": "status-update", "taskId": "314b788f83394219afa563e47a******", "contextId": "fd86552d317b4733aa8e7438f81c84b5", "status": {"state": "working", "timestamp": "2025-09-26T14:50:45.351049"}, "final": false, "metadata": {"agentId": 17368, "sessionId": 12013496, "deepResearchTaskId": 181928, "dataSetList": [{"id": 1836089, "appId": 1004033}], "reportList": [{"reportId": 7112515, "appId": 1004033}], "fileList": ["agent-upload-20250916121852-a79607aef5e44339ad9afa1aa41c81b5"]}}}

data: {"statusUpdate": {"kind": "status-update", "taskId": "314b788f83394219afa563e47a******", "contextId": "fd86552d317b4733aa8e7438f81c84b5", "status": {"state": "working", "timestamp": "2025-09-26T14:51:15.928361"}, "final": false, "metadata": {"agentId": 17368, "sessionId": 12013496, "deepResearchTaskId": 181928, "dataSetList": [{"id": 1836089, "appId": 1004033}], "reportList": [{"reportId": 7112515, "appId": 1004033}], "fileList": ["agent-upload-20250916121852-a79607aef5e44339ad9afa1aa41c81b5"]}}}

data: {"artifactUpdate": {"kind": "artifact-update", "taskId": "314b788f83394219afa563e47a******", "contextId": "fd86552d317b4733aa8e7438f81c84b5", "artifact": {"artifactId": "821c905ef77c4e0ead2c22f4a20e4365", "name": "0x验证数据可视化报告", "description": "Markdown Report", "parts": [{"kind": "text", "text": "# 0x验证数据可视化报告\n\n# 1 数据概览与图表展示\n\n基于0x验证表的数据分析，该数据集包含3个日期（2023-04-20至2023-04-22），涵盖2个项目（A和B），共计6条记录。\n\n\n\n\n| 日期         | 项目   |    数字 |      浮点 |\n|------------|------|-------|---------|\n| 2023-04-20 | B    | 49930 | 39940.4 |\n| 2023-04-20 | A    |  9980 | 19980.5 |\n| 2023-04-21 | A    |  9990 | 19990.7 |\n| 2023-04-21 | B    | 49980 | 39980.6 |\n| 2023-04-22 | A    | 10000 | 20000.9 |\n| 2023-04-22 | B    | 50000 | 40000.8 |\n\n\n\n数据可视化显示，项目B的数字总和为149,910，显著高于项目A的29,970，两者比例约为5:1。浮点数据同样呈现类似分布趋势，项目B的浮点总和约为项目A的2倍。\n\n# 参考信息\n\n本报告的数据来源与图表引用如下："}], "metadata": {"type": "deep_research_markdown_report"}}}}

data: {"artifactUpdate": {"kind": "artifact-update", "taskId": "314b788f83394219afa563e47a******", "contextId": "fd86552d317b4733aa8e7438f81c84b5", "artifact": {"artifactId": "4927de5b776d44768136a8dfbbf18248", "name": "0x验证数据可视化报告", "description": "Html Report", "parts": [{"kind": "text", "text": "13053891-246995-c41b4846d85646a6b93c6e50b45cd802/6f79dc1eee3b49de939232d8e80d90bf.html"}], "metadata": {"type": "deep_research_html_report_key"}}}}

data: {"statusUpdate": {"kind": "status-update", "taskId": "314b788f83394219afa563e47a******", "contextId": "fd86552d317b4733aa8e7438f81c84b5", "status": {"state": "completed", "timestamp": "2025-09-26T14:52:00.878760"}, "final": true, "metadata": {"agentId": 17368, "sessionId": 12013496, "deepResearchTaskId": 181928, "dataSetList": [{"id": 1836089, "appId": 1004033}], "reportList": [{"reportId": 7112515, "appId": 1004033}], "fileList": ["agent-upload-20250916121852-a79607aef5e44339ad9afa1aa41c81b5"]}}}

参考：输出结果模块说明

artifact定义

流式返回结果中，产物更新结果（artifactUpdate）中包含的artifact字段的内容示例及详细字段说明如下。

{
    "artifactId": "080e334f-29c1-5587-bd0c-e230bd78da0d",
    "name": "绘制各地区销售额分布图",
    "description": "任务已完成：【执行Python代码】绘制各地区销售额分布图",
    "parts": [
        {
            "kind": "text",
            "text": "......"
        },
        {
            "kind": "data",
            "data": {
                "type": "python_sandbox",
                "content": "```python......```\n\n",
                "result": "代码执行成功，输出内容如下：......"
            }
        }
    ],
    "metadata": {
        "type": "deep_research_running_step",
        "stepType": "python_sandbox",
        "stepId": -15913542,
        "parentStepId": 15913542
    }
}

字段名

字段类型

示例值

字段说明

artifactId

string

52df4714-4fc2-5025-aea9-bd8837ca****

产物ID，相同的产物ID代表同一个产物

name

string

获取数据集相关信息

产物名称，可能会在执行过程中改变

description

string

任务已完成：获取数据集相关信息

产物描述，可能会在执行过程中改变

parts

List[Part]

[
    {
        "kind": "text",
        "text": "\n\n## ......"
    },
    {
        "kind": "data",
        "data": {
            ...
        }
    }
]

产物内容块：

  • text块为文本信息
  • data块为结构化信息

metadata

Metadata

不同产物类型具有不同metadata字段，其中，type字段：可用于判断深度研究报告的产物类型，不同类型的产物介绍如下：

  • deep_research_markdown_report：文档版报告（markdown格式），报告内容已将折线图等特殊图表转换为markdown表格的形式。
    • 产物包含表格时，会按Markdown格式的表格返回。
    • 产物包含图片时，会返回图片url，读取图片时需使用有权限的账号进行图片读取（推荐使用当前接口调用的账号）。
  • deep_research_html_report_key：网页版报告，您可通过获取网页版报告的key来拼接网页报告访问URL，访问该网页URL即可展示网页版报告，格式例如：
    • https://{domain}/aeolus/pages/agent/report/html?reportKey=YYY
    • https://{domain}/{PATH_TO_DATAAGENT}-open#/agent/report/html?reportKey=XXX&jwtToken=YYY
      拼接网页版报告URL的操作详情请参见下文应用实践的拼接深度研究报告URL章节。
  • deep_research_running_step: 中间过程信息，只有在请求任务时metadata中设置enableRunningStepOutput: true时才会提供，具体定义可参见下文 中间步骤产物：deep_research_running_step章节。

中间步骤产物：deep_research_running_step

位置

字段名

字段类型

示例值

字段说明

Metadata

type

string

deep_research_running_step

产物类型

stepType

string

executor_think

中间步骤类型，用于识别中间步骤的类型：

  • executor_think：思考推理步骤
  • sql_sandbox：数据查询SQL处理步骤
  • python_sandbox：分析处理步骤
  • table_insight：获取数据集步骤

各个中间步骤类型的详细返回内容位置说明和示例可参见下文。

stepId

Optional[int]

1919810

当前步骤的步骤ID，用于创建中间过程的关联关系

parentStepId

Optional[int]

114514

上游步骤的步骤ID，用于创建中间过程的关联关系。
目前中间步骤固定为2级结构，parentStepId为0的步骤代表一个「步骤组」的信息，真实的步骤内容应从parentStepId不为0的步骤中获取。

executor_think

  • 不含data块
  • 存在流式更新，更新至text块中
data: {"artifactUpdate": {"kind": "artifact-update", "taskId": "49e0fed9b5714bf9807164d012ce4b2a", "contextId": "0c4f27bcb95f40fd8a0e72c93647dca0", "artifact": {"artifactId": "9c73aa1e-4b6a-574a-92ae-5b3e7523e98a", "name": "思考推理", "description": "思考推理", "parts": [{"kind": "text", "text": ""}], "metadata": {"type": "deep_research_running_step", "stepType": "executor_think", "stepId": 15913627, "parentStepId": 15913542}}, "lastChunk": false}}

data: {"artifactUpdate": {"kind": "artifact-update", "taskId": "49e0fed9b5714bf9807164d012ce4b2a", "contextId": "0c4f27bcb95f40fd8a0e72c93647dca0", "artifact": {"artifactId": "9c73aa1e-4b6a-574a-92ae-5b3e7523e98a", "parts": [{"kind": "text", "text": "##"}]}, "append": true, "lastChunk": false}}

......

data: {"artifactUpdate": {"kind": "artifact-update", "taskId": "49e0fed9b5714bf9807164d012ce4b2a", "contextId": "0c4f27bcb95f40fd8a0e72c93647dca0", "artifact": {"artifactId": "9c73aa1e-4b6a-574a-92ae-5b3e7523e98a", "parts": [{"kind": "text", "text": "。"}]}, "append": true, "lastChunk": false}}

data: {"artifactUpdate": {"kind": "artifact-update", "taskId": "49e0fed9b5714bf9807164d012ce4b2a", "contextId": "0c4f27bcb95f40fd8a0e72c93647dca0", "artifact": {"artifactId": "9c73aa1e-4b6a-574a-92ae-5b3e7523e98a", "name": "思考推理", "description": "思考推理完成", "parts": [{"kind": "text", "text": "## 思路分析\n\n已完成各地区销售额的查询和分析，获得了61个城市的数据，并绘制了各省份销售额分布图。数据显示：\n- 广东省和江苏省销售额领先\n- 前10名省份占总销售额74.37%\n- 已通过可视化展示分布情况\n\n任务已完成，可以进入报告编写阶段。"}], "metadata": {"type": "deep_research_running_step", "stepType": "executor_think", "stepId": 15913627, "parentStepId": 15913542}}, "lastChunk": true}}

table_insight

  • 不含data块
data: {"artifactUpdate": {"kind": "artifact-update", "taskId": "49e0fed9b5714bf9807164d012ce4b2a", "contextId": "0c4f27bcb95f40fd8a0e72c93647dca0", "artifact": {"artifactId": "86875483-3508-56b3-8f16-7cb041226e2a", "name": "获取数据集相关信息", "description": "任务已完成：获取数据集相关信息", "parts": [{"kind": "text", "text": "\n\n## 表`1836089`的相关信息\n表信息如下:\n表ID: `1836089`\n表名: `销售GMV-直连`\n\n\n引擎列名和数据类型：\n|列名|数据类型|\n| ---- | ---- |\n|sale_price|Nullable(Float32)|\n|order_count|int|\n\n\n基于引擎列创建的字段列表，可以直接使用，字段名均以``包围：\n\n|字段名|数据类型|相关信息|抽样示例值(非全量)|\n| ---- | ---- | ---- | ---- |\n|`销售年份`|int|||\n|`customer_id`|int|||\n|`order_date`|date|数据可用日期范围：最大值: 2016-06-30,最小值: 2013-07-01||\n|`sale_price`|float|||\n|`order_count`|int|||\n|`price`|float|||\n|`null维度`|string|||\n|`product_id`|string|||\n|`图表中没有出现的公共维度`|string|||\n|`sale_city`|string|||\n|`公共维度`|string|||\n|`产品类型`|string|||\n|`省份`|string|||\n|`GMV`|float|||\n\n\n聚合指标定义参考:\n\n```\n`总销售额`: sum(((order_count) * (sale_price)))\n```\n\n\n## 表`2133291`的相关信息\n表信息如下:\n表ID: `2133291`\n表名: `0x验证表`\n\n字段列表，字段名均以``包围：\n\n|字段名|数据类型|相关信息|抽样示例值(非全量)|\n| ---- | ---- | ---- | ---- |\n|`日期`|date|数据可用日期范围：最大值: 2023-04-22,最小值: 2023-04-20||\n|`数字`|int|||\n|`浮点`|float|||\n\n\n\n"}], "metadata": {"type": "deep_research_running_step", "stepType": "table_insight", "stepId": -15913420, "parentStepId": 15913420}}, "lastChunk": true}}

sql_sandbox

  • data块定义

字段名

字段类型

示例值

字段说明

type

string

execute_sql

固定为execute_sql，用于标识该data块的类型

content

string

见下方示例。

注意区分真正的text块
可能在真正的text块更新前出现
可用于部分渲染内容

result

string

查询结果[XX]...

查询结果的文本

executeSql

string

Select XX from XX

实际执行的sql

rewriteSql

string

Select 170001_XX from XX

改写后的sql，用于向用户展示

data: {"artifactUpdate": {"kind": "artifact-update", "taskId": "49e0fed9b5714bf9807164d012ce4b2a", "contextId": "0c4f27bcb95f40fd8a0e72c93647dca0", "artifact": {"artifactId": "81301578-a38a-5df9-aeb6-403249f7b650", "name": "查询各个地区的销售额数据", "description": "任务已完成：【执行SQL语句】按地区维度查询销售额数据，包括省份和城市信息，计算总销售额", "parts": [{"kind": "text", "text": "```sql\nSELECT `省份`,\n       `sale_city`,\n       SUM(`order_count` * `sale_price`) as `总销售额`\nFROM   `销售GMV-直连`\nWHERE  `省份` IS NOT NULL\n   AND `sale_city` IS NOT NULL\nGROUP BY `省份`, `sale_city`\nORDER BY `总销售额` DESC\n```\n\n查询结果[sales_by_region]共61行，详情如下：\n||省份|sale_city|总销售额|\n|--|--|--|--|\n|0|上海市|上海市|2832629.8676199913|...查询成功。查询结果已存储在内存变量sales_by_region中，类型为pandas.DataFrame\nsales_by_region的列名和列数据类型如下:\n|列名|数据类型|\n|--|--|\n|省份|string|\n|sale_city|string|\n|总销售额|float|\n\n查询结果sales_by_region的总行数为：61\n\nsales_by_region的完整的结果数据如下：\n||省份|sale_city|总销售额|\n|--|--|--|--|\n|0|上海市|上海市|2832629.8676199913|..."}, {"kind": "data", "data": {"type": "execute_sql", "content": "```sql\nSELECT `省份`,\n       `sale_city`,\n       SUM(`order_count` * `sale_price`) as `总销售额`\nFROM   `销售GMV-直连`\nWHERE  `省份` IS NOT NULL\n   AND `sale_city` IS NOT NULL\nGROUP BY `省份`, `sale_city`\nORDER BY `总销售额` DESC\n```\n\n", "result": "查询结果[sales_by_region]共61行，详情如下：\n||省份|sale_city|总销售额|\n|--|--|--|--|\n|0|上海市|上海市|2832629.8676199913|", "executeSql": "SELECT (sale_province) AS `alias_prefix_省份`,\n       (sale_city) AS `alias_prefix_sale_city`,\n       SUM((order_count) * (sale_price)) AS `alias_prefix_总销售额`\nFROM   (SELECT `product_type` as `product_type`,\n               `product_id` as `product_id`,\n               `order_count` as `order_count`,\n               `price` as `price`,\n               `sale_province` as `sale_province`,\n               `sale_price` as `sale_price`,\n               `sale_city` as `sale_city`,\n               `order_date` as `order_date`,\n               `customer_id` as `customer_id`\n        FROM   `aeolus_excel_upload_aeolus_rei`.`table_cede732c_c35a_424c_85e7_174fee1739ae`\n        WHERE  1 = 1) AS `销售GMV-直连`\nWHERE  NOT ((sale_province) IS NULL)\n   AND NOT ((sale_city) IS NULL)\nGROUP BY `alias_prefix_省份`, `alias_prefix_sale_city`\nORDER BY `alias_prefix_总销售额` DESC LIMIT 10000 FORMAT JSONCompact", "rewriteSql": "SELECT (`1700031515177_省份`) AS `alias_prefix_省份`,\n       (`1700031515178_sale_city`) AS `alias_prefix_sale_city`,\n       SUM((`1700031515180_order_count`) * (`1700031515182_sale_price`)) AS `alias_prefix_总销售额`\nFROM   `chenrui.ovo 测试.销售GMV-直连` AS `销售GMV-直连`\nWHERE  NOT ((`1700031515177_省份`) IS NULL)\n   AND NOT ((`1700031515178_sale_city`) IS NULL)\nGROUP BY `alias_prefix_省份`, `alias_prefix_sale_city`\nORDER BY `alias_prefix_总销售额` DESC LIMIT 10000"}}], "metadata": {"type": "deep_research_running_step", "stepType": "sql_sandbox", "stepId": -15913462, "parentStepId": 15913462}}, "lastChunk": true}}

python_sandbox

  • data块定义如下

字段名

字段类型

示例值

字段说明

type

string

python_sandbox

固定为python_sandbox，用于标识该data块的类型

content

string

见下方示例

注意区分真正的text块，可能在真正的text块更新前出现
可用于部分渲染内容

result

string

见下方示例

输出结果的提示

data: {"artifactUpdate": {"kind": "artifact-update", "taskId": "49e0fed9b5714bf9807164d012ce4b2a", "contextId": "0c4f27bcb95f40fd8a0e72c93647dca0", "artifact": {"artifactId": "080e334f-29c1-5587-bd0c-e230bd78da0d", "name": "绘制各地区销售额分布图", "description": "任务执行中：【执行Python代码】绘制各地区销售额分布图", "parts": [{"kind": "text", "text": ""}, {"kind": "data", "data": {"type": "python_sandbox", "content": "```python\nimport matplotlib.pyplot as plt\nimport pandas as pd\n\n# 设置中文字体\nplt.rcParams['font.sans-serif'] = ['SimHei']\nplt.rcParams['axes.unicode_minus'] = False\n\n# 按省份汇总销售额\nprovince_sales = sales_by_region.groupby('省份')['总销售额'].sum().sort_values(ascending=False)\n\n# 绘制柱状图\nplt.figure(figsize=(12, 8))\nprovince_sales.plot(kind='bar', color='skyblue')\nplt.title('各省份销售额分布')\nplt.xlabel('省份')\nplt.ylabel('销售额')\nplt.xticks(rotation=45)\nplt.tight_layout()\nplt.show()\n\n# 输出前10名省份\nprint(\"销售额前10名省份:\")\nprint(province_sales.head(10))\n\n# 计算前10名省份占总销售额的比例\ntop10_ratio = province_sales.head(10).sum() / province_sales.sum()\nprint(f\"\\n前10名省份占总销售额比例: {top10_ratio:.2%}\")\n```\n\n"}}], "metadata": {"type": "deep_research_running_step", "stepType": "python_sandbox", "stepId": -15913542, "parentStepId": 15913542}}, "lastChunk": false}}

data: {"artifactUpdate": {"kind": "artifact-update", "taskId": "49e0fed9b5714bf9807164d012ce4b2a", "contextId": "0c4f27bcb95f40fd8a0e72c93647dca0", "artifact": {"artifactId": "080e334f-29c1-5587-bd0c-e230bd78da0d", "name": "绘制各地区销售额分布图", "description": "任务已完成：【执行Python代码】绘制各地区销售额分布图", "parts": [{"kind": "text", "text": "```python\nimport matplotlib.pyplot as plt\nimport pandas as pd\n\n# 设置中文字体\nplt.rcParams['font.sans-serif'] = ['SimHei']\nplt.rcParams['axes.unicode_minus'] = False\n\n# 按省份汇总销售额\nprovince_sales = sales_by_region.groupby('省份')['总销售额'].sum().sort_values(ascending=False)\n\n# 绘制柱状图\nplt.figure(figsize=(12, 8))\nprovince_sales.plot(kind='bar', color='skyblue')\nplt.title('各省份销售额分布')\nplt.xlabel('省份')\nplt.ylabel('销售额')\nplt.xticks(rotation=45)\nplt.tight_layout()\nplt.show()\n\n# 输出前10名省份\nprint(\"销售额前10名省份:\")\nprint(province_sales.head(10))\n\n# 计算前10名省份占总销售额的比例\ntop10_ratio = province_sales.head(10).sum() / province_sales.sum()\nprint(f\"\\n前10名省份占总销售额比例: {top10_ratio:.2%}\")\n```\n\n代码执行成功，输出内容如下：\n\n销售额前10名省份:\n                  总销售额\n省份                    \n广东省  4822876.405101776\n江苏省  4590771.994219542\n上海市 2832629.8676199913\n北京市 2738369.6146588326\n浙江省 2471835.6385302544\n河北省  1499687.414835453\n福建省  936069.9314939976\n天津市  687273.1442761421\n陕西省  615094.7341973782\n重庆市  602230.6761865616\n\n前10名省份占总销售额比例: 74.37%\n\n已渲染图片：\n  - title：各省份销售额分布\n  - img_key： b2134d0c161e4822a7d697271802a1d4\n  - img_url：https://data.bytedance.net/dataAgent/llm/api/v2/deepresearch/images?img_key=13464321-286833-b2134d0c161e4822a7d697271802a1d4\n\n"}, {"kind": "data", "data": {"type": "python_sandbox", "content": "```python\nimport matplotlib.pyplot as plt\nimport pandas as pd\n\n# 设置中文字体\nplt.rcParams['font.sans-serif'] = ['SimHei']\nplt.rcParams['axes.unicode_minus'] = False\n\n# 按省份汇总销售额\nprovince_sales = sales_by_region.groupby('省份')['总销售额'].sum().sort_values(ascending=False)\n\n# 绘制柱状图\nplt.figure(figsize=(12, 8))\nprovince_sales.plot(kind='bar', color='skyblue')\nplt.title('各省份销售额分布')\nplt.xlabel('省份')\nplt.ylabel('销售额')\nplt.xticks(rotation=45)\nplt.tight_layout()\nplt.show()\n\n# 输出前10名省份\nprint(\"销售额前10名省份:\")\nprint(province_sales.head(10))\n\n# 计算前10名省份占总销售额的比例\ntop10_ratio = province_sales.head(10).sum() / province_sales.sum()\nprint(f\"\\n前10名省份占总销售额比例: {top10_ratio:.2%}\")\n```\n\n", "result": "代码执行成功，输出内容如下：\n\n销售额前10名省份:\n\n\n\n| 省份   | 总销售额               |\n|:-----|:-------------------|\n| 广东省  | 4822876.405101776  |\n| 江苏省  | 4590771.994219542  |\n| 上海市  | 2832629.8676199913 |\n| 北京市  | 2738369.6146588326 |\n| 浙江省  | 2471835.6385302544 |\n| 河北省  | 1499687.414835453  |\n| 福建省  | 936069.9314939976  |\n| 天津市  | 687273.1442761421  |\n| 陕西省  | 615094.7341973782  |\n| 重庆市  | 602230.6761865616  |\n\n\n\n\n前10名省份占总销售额比例: 74.37%\n\n\n\n\n\n![已渲染图片\"各省份销售额分布\"，可通过地址 https://data.bytedance.net/dataAgent/llm/api/v2/deepresearch/images?img_key=13464321-286833-b2134d0c161e4822a7d697271802a1d4 访问](https://data.bytedance.net/dataAgent/llm/api/v2/deepresearch/images?img_key=13464321-286833-b2134d0c161e4822a7d697271802a1d4 \"各省份销售额分布\")\n\n\n\n\n\n"}}], "metadata": {"type": "deep_research_running_step", "stepType": "python_sandbox", "stepId": -15913542, "parentStepId": 15913542}}, "lastChunk": true}}

应用实践

拼接深度研究报告URL

以下为您介绍执行深度研究任务openAPI后，如何基于返回结果来拼接最终生成的研究报告URL，拼接得到报告URL后即可通过此URL展示网页版报告内容。
首先我们需要了解，当前拼接深度研究报告URL时，有以下两种格式。

对比项

方式1：SSO登录场景

方式2：单独认证场景

拼接URL格式示例

https://{domain}/{PATH_TO_DATAAGENT}/agent/report/html?reportKey=XXX

https://{domain}/{PATH_TO_DATAAGENT}-open#/agent/report/html?reportKey=XXX&jwtToken=YYY

适用场景

适用于后续访问深度研究报告页面时，做了SSO登录认证的场景，后续访问报告页面时无需再进行登录认证。
通常在私有化场景下，如果在私有化内部网络环境访问时，可进行SSO登录认证的方式。

适用于后续访问深度研究报告页面时，适用jwtToken进行认证的场景。
通常在SaaS场景下，您需采取此种方式进行登录认证。

变量：{domain}

  • 私有化domain: 实际部署的环境域名地址

变量：{PATH_TO_DATAAGENT}

不涉及

路径参数，建议您先打开一个智能分析Agent的会话页面，复制页面URL，路径参数就在此URL中，详情可参见下文的拼接URL的操作示例。

变量：reportKey

生成的深度研究报告ID，获取方式如下。

  1. 调用“执行深度研究任务”接口后，在返回的流式结果中，查看返回结果artifact中metadate的type字段。
  2. 当metadate的type字段取值为deep_research_html_report_key时，在artifact中的parts字段里，找到type为text、text的取值结果即为深度研究报告IDreportKey。

如下图所示示例。
Image
注意，深度研究报告IDreportKey为text的完整取值结果，你可直接复制完整的取值结果即可。

变量：jwtToken

不涉及

调用OpenAPI的jwttokens，获取方式请参见：调用方式。

拼接深度研究报告URL时，建议您先打开一个智能分析Agent的会话页面，复制页面URL，在此基础之上进行修改拼接，能快速完成URL的拼接。以下为您示例操作步骤。

  1. 登录并进入智能分析Agent的某个会话页面，比如，打开智能问数的问题提问页面，然后复制浏览器中的页面URL。
    例如，复制的页面URL为：https://e16-3-17dataagent.datarangers-onpremise.volces.com/data-agent/analytics-agent/#/agent/session?agentId=2502&appId=2&sessionId=116739。

  2. 对复制得到的URL进行修改，得到拼接后的深度研究报告URL。

    对比说明

    方式1：SSO登录场景

    方式2：单独认证场景

    最终报告URL

    https://e16-3-17dataagent.datarangers-onpremise.volces.com/data-agent/analytics-agent/#/agent/report/html?reportKey=XXX

    https://e16-3-17dataagent.datarangers-onpremise.volces.com/data-agent/analytics-agent-open/#/agent/report/html?reportKey=XXX&jwtToken=YYY

    修改说明

    • 将获取到的会话页面URL的session？开始，往后的内容均删除，拼接报告的report/html?reportKey=XXX部分。
    • 拼接时各变量参数的说明及获取方式见上文，其中：
      • reportKey=XXX的取值为执行深度研究报告OpenAPI返回结果中的深度研究报告ID。
    • URL的其余部分，其中，获取到的会话页面URL中的https://……volces.com部分为域名{domain}的取值，您无需修改，以页面复制结果为准。
    • URL的其余部分，其中，获取到的会话页面URL中{domain}与agent中间部分即为路径参数（data-agent/……/#/部分），您无需修改，以页面复制结果为准。
    • 将获取到的会话页面URL的session？开始，往后的内容均删除，拼接报告的report/html?reportKey=XXX&jwtToken=YYY部分。
    • 拼接时各变量参数的说明及获取方式见上文，其中：
      • reportKey=XXX的取值为执行深度研究报告OpenAPI返回结果中的深度研究报告ID。
      • jwtToken=YYY为调用OpenAPI的jwttokens。
    • URL的其余部分，其中，获取到的会话页面URL中的https://……volces.com部分为域名{domain}的取值，您无需修改，以页面复制结果为准。
    • URL的其余部分，其中，获取到的会话页面URL中{domain}与agent中间部分即为路径参数（data-agent/……/#/部分），您需在复制得到的路径参数analytics-agent后加上-open，作为此访问方式下的最终路径参数。
最近更新时间：2025.12.25 18:34:37
这个页面对您有帮助吗？
有用
有用
无用
无用