获取研究任务结果列表

get/knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}/partials

Request example

curl --request GET \
  --url https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}/partials \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}/partials"
headers = {
    "Authorization": "Bearer <token>",
}

response = requests.request("GET", url, headers=headers)

print(response.text)

const response = await fetch('https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}/partials', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>'
  }
});

const data = await response.json();
console.log(data);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}/partials',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <token>',
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	url := "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}/partials"

	req, _ := http.NewRequest("GET", url, nil)
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}/partials"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

require 'uri'
require 'net/http'

url = URI('https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}/partials')

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = url.scheme == 'https'

request = Net::HTTP::Get.new(url)
request['Authorization'] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

Response

{
  "data": [
    {
      "answer": null,
      "evidence_bundle": {
        "createdAt": "2026-09-06T08:00:10.000Z",
        "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
        "items": [
          {
            "citations": [
              {
                "documentAssetId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
                "documentVersion": 1,
                "pageNumber": 2,
                "sectionPath": [
                  "Policies",
                  "Refunds"
                ]
              }
            ],
            "conflicts": [],
            "freshness": {
              "sourceUpdatedAt": "2026-08-30T09:12:00.000Z",
              "status": "fresh"
            },
            "metadata": {},
            "nodeId": "5d4c3b2a-1f0e-4d9c-8b7a-6f5e4d3c2b1a",
            "score": 0.82,
            "scores": {
              "final": 0.82,
              "rerank": 0.85,
              "retrieval": 0.71
            },
            "text": "From 1 March 2025, refunds are issued within 14 days of the return being received. The previous window was 30 days."
          },
          {
            "citations": [
              {
                "documentAssetId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
                "documentVersion": 1,
                "pageNumber": 3,
                "sectionPath": [
                  "Policies",
                  "Refunds",
                  "Regional exceptions"
                ]
              }
            ],
            "conflicts": [],
            "freshness": {
              "sourceUpdatedAt": "2026-08-30T09:12:00.000Z",
              "status": "fresh"
            },
            "metadata": {},
            "nodeId": "c3b2a1f0-e9d8-4c7b-8a6f-5e4d3c2b1a09",
            "score": 0.77,
            "scores": {
              "final": 0.77,
              "rerank": 0.8,
              "retrieval": 0.66
            },
            "text": "The 14-day window applies to orders shipped to the EU and the UK. Other regions keep the 30-day window until further notice."
          }
        ],
        "missingEvidence": [],
        "query": "What changed in the 2025 refund policy, and which regions are affected?",
        "state": "partial"
      },
      "knowledge_space_id": "b2f1d3a4-5e6c-4a7b-8c9d-0e1f2a3b4c5d",
      "research_task_job_id": "e4d1b7a2-3c5f-4d8e-9a0b-1c2d3e4f5a6b",
      "sequence": 1
    },
    {
      "answer": "The 2025 policy shortened the refund window from 30 days to 14 days after the return is received, effective 1 March 2025. The change applies to orders shipped to the EU and the UK; other regions keep the 30-day window.",
      "evidence_bundle": {
        "createdAt": "2026-09-06T08:00:41.000Z",
        "id": "1f2e3d4c-5b6a-4978-8a7b-6c5d4e3f2a1b",
        "items": [
          {
            "citations": [
              {
                "artifactHash": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
                "documentAssetId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
                "documentVersion": 1,
                "endOffset": 1978,
                "pageNumber": 2,
                "sectionPath": [
                  "Policies",
                  "Refunds"
                ],
                "startOffset": 1840
              }
            ],
            "conflicts": [
              {
                "reason": "States a 14-day window while another chunk keeps 30 days for some regions.",
                "severity": "info",
                "withNodeId": "c3b2a1f0-e9d8-4c7b-8a6f-5e4d3c2b1a09"
              }
            ],
            "freshness": {
              "observedAt": "2026-09-06T08:00:12.000Z",
              "sourceUpdatedAt": "2026-08-30T09:12:00.000Z",
              "status": "fresh"
            },
            "metadata": {},
            "nodeId": "5d4c3b2a-1f0e-4d9c-8b7a-6f5e4d3c2b1a",
            "score": 0.82,
            "scores": {
              "final": 0.82,
              "freshness": 0.9,
              "rerank": 0.85,
              "retrieval": 0.71
            },
            "text": "From 1 March 2025, refunds are issued within 14 days of the return being received. The previous window was 30 days."
          },
          {
            "citations": [
              {
                "documentAssetId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
                "documentVersion": 1,
                "pageNumber": 3,
                "sectionPath": [
                  "Policies",
                  "Refunds",
                  "Regional exceptions"
                ]
              }
            ],
            "conflicts": [],
            "freshness": {
              "observedAt": "2026-09-06T08:00:12.000Z",
              "sourceUpdatedAt": "2026-08-30T09:12:00.000Z",
              "status": "fresh"
            },
            "metadata": {},
            "nodeId": "c3b2a1f0-e9d8-4c7b-8a6f-5e4d3c2b1a09",
            "score": 0.77,
            "scores": {
              "final": 0.77,
              "freshness": 0.9,
              "rerank": 0.8,
              "retrieval": 0.66
            },
            "text": "The 14-day window applies to orders shipped to the EU and the UK. Other regions keep the 30-day window until further notice."
          }
        ],
        "missingEvidence": [
          {
            "expectedEvidenceId": "7e6d5c4b-3a29-4180-9f8e-7d6c5b4a3928",
            "metadata": {},
            "reason": "not-retrieved",
            "text": "No chunk lists the effective date for regions outside the EU and the UK."
          }
        ],
        "query": "What changed in the 2025 refund policy, and which regions are affected?",
        "retrievalQuery": "2025 refund policy changes refund window regions affected",
        "state": "answerable"
      },
      "knowledge_space_id": "b2f1d3a4-5e6c-4a7b-8c9d-0e1f2a3b4c5d",
      "research_task_job_id": "e4d1b7a2-3c5f-4d8e-9a0b-1c2d3e4f5a6b",
      "sequence": 2
    }
  ],
  "next_cursor": null
}

{
  "code": "knowledge_fs_invalid_request",
  "message": "Agent Knowledge Base request is invalid.",
  "status": 400,
  "violations": [
    {
      "field": [
        "limit"
      ],
      "type": "less_than_equal"
    }
  ]
}

{
  "code": "knowledge_fs_invalid_request",
  "message": "Agent Knowledge Base request is invalid.",
  "status": 400
}

{
  "code": "knowledge_fs_invalid_credential",
  "message": "Invalid Agent Knowledge Base service credential.",
  "status": 401
}

{
  "code": "unauthorized",
  "message": "Access token is invalid",
  "status": 401
}

{
  "code": "forbidden",
  "message": "Sorry, you have reached the knowledge base request rate limit of your subscription.",
  "status": 403
}

{
  "code": "knowledge_fs_access_denied",
  "message": "Agent Knowledge Base operation is not allowed.",
  "status": 403
}

{
  "code": "knowledge_fs_access_denied",
  "failure": {
    "action": "contact_admin",
    "category": "authorization",
    "code": "KNOWLEDGE_FS_ACCESS_DENIED",
    "message": "You do not have permission to perform this Agent Knowledge Base operation.",
    "retryPolicy": "never",
    "traceId": "602b9b60-6564-4ba7-8b59-54312d41377c"
  },
  "message": "You do not have permission to perform this Agent Knowledge Base operation.",
  "status": 403
}

{
  "code": "knowledge_fs_resource_not_found",
  "failure": {
    "category": "not_found",
    "code": "KNOWLEDGE_FS_NOT_FOUND",
    "message": "The requested Agent Knowledge Base resource was not found.",
    "retryPolicy": "never",
    "traceId": "ca5eb2d9-4242-4950-877c-6c5207b1441e"
  },
  "message": "The requested Agent Knowledge Base resource was not found.",
  "status": 404
}

{
  "code": "not_found",
  "message": "The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again.",
  "status": 404
}

{
  "code": "knowledge_fs_upstream_unavailable",
  "message": "Agent Knowledge Base is unavailable.",
  "status": 502
}

{
  "code": "knowledge_fs_operation_unavailable",
  "message": "Agent Knowledge Base operation is not available.",
  "status": 503
}

{
  "code": "knowledge_fs_operation_unavailable",
  "failure": {
    "action": "retry",
    "category": "dependency",
    "code": "KNOWLEDGE_FS_UNAVAILABLE",
    "message": "A service required by Agent Knowledge Base is temporarily unavailable.",
    "retryPolicy": "manual",
    "traceId": "5e2a9c17-3b4d-4f60-8a1b-2c3d4e5f6a7b"
  },
  "message": "A service required by Agent Knowledge Base is temporarily unavailable.",
  "status": 503
}

get/knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}/partials

Authorization

Authorizationstringheaderrequired#

每个请求都通过 API Key 认证：Authorization: Bearer {API_KEY}。应用接口使用应用 API Key，知识库接口使用知识库 API Key（快速开始）。

API Key 应保存在服务端，切勿嵌入客户端代码。缺失或无效的 Key 会返回 HTTP 401（unauthorized）。

Path parameters

knowledge_base_idstringrequired#

知识库 ID：即知识库 API 访问 对话框中所示服务 API 端点的最后一段（…/knowledge-fs/spaces/<knowledge base ID>），也是地址栏中 /datasets/new/ 之后的那一段。

research_task_idstringrequired#

研究任务 ID，来自创建研究任务。

Query parameters

cursorstring#

不透明游标：原样发送上一页的 next_cursor。

Length: 1–1000

limitinteger#

每页条目数。

Default: 25

Range: 1–100

Responses

application/json

一页结果。

dataobject[]#

结果，按 sequence 升序排列。

Show child attributes

answerstring#

任务的回答。仅在最终结果中有值，检索检查点中为 null。

evidence_bundleobject#

写入此结果时任务已收集到的检索分段。

如果某项的文档文件在检索后被删除，该项会以占位项的形式返回：

text 为 Evidence deleted or unavailable。
citations[] 仅保留 documentAssetId、documentVersion 和空的 sectionPath。
conflicts 为空。
freshness.status 为 unknown。
metadata.traceEvidenceAvailability 为 {"status": "unavailable", "reason": "document-deleted-or-unavailable"}。

Show child attributes

createdAtstring#

写入这组分段的时间，ISO 8601 时间戳。

idstring#

这组检索分段的 ID。

itemsobject[]#

检索到的分段及其分数和引用，最相关的在前。

Show child attributes

citationsobject[]#

分段的出处。每项至少一条。

Show child attributes

artifactHashstring#

引用所指向文档文件的 SHA-256。未记录时不返回。

documentAssetIdstring#

文档文件 ID。可通过获取文档文件读取文件名。如需查找对应的文档，将它与 documentVersion 一起传给按文件获取文档。

documentVersioninteger#

检索时文档文件的 version。

endOffsetinteger#

解析后文档文本中的 UTF-8 字节偏移量，从 0 开始计数，为结束位置（不包含）。无法获取时省略。

pageNumberinteger#

页码，从 1 开始，源文件提供页码信息时返回，否则省略。

sectionPathstring[]#

从文档根节点到被引用章节的各级章节标题。

startOffsetinteger#

解析后文档文本中的 UTF-8 字节偏移量，从 0 开始计数，为起始位置（包含）。无法获取时省略。

conflictsobject[]#

此分段与其他检索分段之间的冲突。没有冲突时为空。

Show child attributes

reasonstring#

冲突的内容。

severitystring#

info、warning 或 blocking。

withNodeIdstring#

与此分段冲突的分段的 nodeId。冲突不针对某一个分段时不返回。

freshnessobject#

被引用内容的时效性。

Show child attributes

observedAtstring#

最后一次观察到该内容的时间，ISO 8601 时间戳。未知时不返回。

sourceUpdatedAtstring#

源内容最近一次更新的时间，ISO 8601 时间戳。未知时不返回。

statusstring#

fresh、stale 或 unknown。

metadataobject#

该项的附加详情。占位项会带有 traceEvidenceAvailability。

nodeIdstring#

检索到的分段的 ID。

scorenumber#

总体相关性，取值范围为 0 到 1，与 scores.final 的值相同。

scoresobject#

分数明细，每项取值范围为 0 到 1。

Show child attributes

finalnumber#

用于排序的综合分数。

freshnessnumber#

反映来源新近程度的分数。未计算时不返回。

reranknumber#

重排序模型给出的分数。未执行重排序时不返回。

retrievalnumber#

向量检索和关键词检索给出的分数。

textstring#

分段文本。

missingEvidenceobject[]#

本次运行预期使用但未能使用的分段。没有时为空。

Show child attributes

expectedEvidenceIdstring#

预期分段的 ID（如已知）。

metadataobject#

附加详情。

reasonstring#

not-retrieved、permission-filtered、stale、conflict 或 unknown。

textstring#

缺失的内容。

querystring#

研究问题。

retrievalQuerystring#

实际发送给检索的查询文本，仅在与 query 不同时返回。

statestring#

检索到的分段对回答的支撑程度：partial（检索检查点，尚未进行分析）、answerable、not-enough-evidence、conflict（来源之间存在矛盾）或 permission-limited（部分分段因权限被排除）。

traceIdstring#

产生这组分段的运行 ID（如有记录）。研究任务不会记录为查询记录，因此获取查询记录不接受此 ID。

knowledge_space_idstring#

知识库的内部 ID，并非路径中的知识库 ID。

research_task_job_idstring#

研究任务 ID。

sequenceinteger#

该结果在任务中的序号，从 1 开始。

next_cursorstring#

下一页的游标，最后一页时为 null。将其作为 cursor 传回。

取消研究任务获取文档列表