You need to enable JavaScript to run this app.
导航
数据智能体 DataAgent（私有化）
  • 文档首页
    • /数据智能体 DataAgent（私有化）/开放与集成/智能分析Agent/OpenAPI/深度研究/执行深度研究任务
执行深度研究任务
最近更新时间：2025.11.06 17:09:24首次发布时间：2025.10.16 14:55:04
复制全文
我的收藏
有用
有用
无用
无用

请求说明

请求方式：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。

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

见下方返回值示例

产物更新，其中产物会以Markdown格式形式返回。

  • 产物包含表格时，会按Markdown格式的表格返回。
  • 产物包含图片时，会返回图片url，读取图片时需使用有权限的账号进行图片读取（推荐使用当前接口调用的账号）。

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"]}}}

其中，metadata的type字段可用于判断深度研究报告的产品类型：

  • deep_research_markdown_report：文档版报告（markdown格式），报告内容已将折线图等特殊图表转换为markdown表格的形式。
  • deep_research_html_report_key：html报告key，访问该网页可展示网页版报告，格式例如：
    • https://{domain}/aeolus/pages/agent/report/html?reportKey=YYY
    • https://{domain}/{PATH_TO_DATAAGENT}-open#/agent/report/html?reportKey=XXX&jwtToken=YYY