获取缺失分段列表

列出一次查询运行预期使用但未能使用的分段，每个分段一条。data 为空且 truncated: false 表示本次运行没有记录此类分段。

条目包含原因和条目元数据，但不包含缺失的文本。如需读取文本，调用获取查询记录并查看 steps[].metadata.evidenceBundle.missingEvidence。

如何结合查看一次运行的分段、冲突和缺失分段，详见排查回答。

1 min read

get/knowledge-fs/spaces/{knowledge_base_id}/traces/{query_record_id}/missing

Request example

curl --request GET \
  --url https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/traces/{query_record_id}/missing \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/traces/{query_record_id}/missing"
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}/traces/{query_record_id}/missing', {
  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}/traces/{query_record_id}/missing',
  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}/traces/{query_record_id}/missing"

	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}/traces/{query_record_id}/missing"))
    .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}/traces/{query_record_id}/missing')

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

{
  "consistency_class": null,
  "data": [
    {
      "kind": "resource",
      "metadata": {
        "availability": "available",
        "reason": "permission-filtered"
      },
      "name": "missing-1",
      "path": "/queries/3c9e3b1a-2f0a-4b7d-9d3e-1f2a3b4c5d6e/missing/1",
      "resource_type": "evidence",
      "target_id": "d4c6e8a0-2b4d-4e6f-8a0c-2e4f6a8b0c2d",
      "version": null
    }
  ],
  "next_cursor": null,
  "path": "/queries/3c9e3b1a-2f0a-4b7d-9d3e-1f2a3b4c5d6e/missing",
  "preview": null,
  "truncated": false
}

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

{
  "code": "knowledge_fs_invalid_request",
  "failure": {
    "category": "validation",
    "code": "KNOWLEDGE_FS_INVALID_REQUEST",
    "message": "The Agent Knowledge Base request is invalid.",
    "retryPolicy": "never",
    "traceId": "8f3a2c14-9d6b-4c07-b5a1-2e7d0c93f5b2"
  },
  "message": "The Agent Knowledge Base request is invalid.",
  "status": 400
}

{
  "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": "8f3a2c14-9d6b-4c07-b5a1-2e7d0c93f5b2"
  },
  "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": "8f3a2c14-9d6b-4c07-b5a1-2e7d0c93f5b2"
  },
  "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}/traces/{query_record_id}/missing

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/ 之后的那一段。

query_record_idstringrequired#

查询记录 ID：即运行查询返回的 x-query-run-id 响应头，或获取查询记录列表中的 id。

Query parameters

cursorstring#

游标，取自上一页的 next_cursor。条目按偏移量定位，因此 0 表示从第一条开始。

Length: 1–1000

limitinteger#

每页条目数。

Default: 100

Range: 1–100

Responses

application/json

一页缺失分段条目：

name 为 missing-<n>。
target_id 为预期的分段 ID（如有记录），否则为条目名称。
resource_type 为 evidence。

consistency_classstring#

在这些视图中始终为 null。

dataobject[]#

本页的条目，按本次运行记录的顺序排列。

Show child attributes

kindstring#

在这些视图中始终为 resource。

metadataobject#

条目详情。可用的键取决于视图。在缺失分段视图中，metadata 还包含缺失项自身的元数据键。

Show child attributes

availabilitystring#

available；分段已删除或无法再读取时为 unavailable。

citationCountinteger#

分段视图：该分段的引用数。

conflictCountinteger#

分段视图：该分段上记录的冲突数。分段不可用时为 0。

documentIdstring#

分段视图：主引用的文档文件 ID，可用于获取文档文件。仅当分段有引用时返回。

documentVersioninteger#

分段视图：该文档文件的版本。仅当分段有引用时返回。

freshnessobject#

分段视图。检索时分段的时效信息。

Show child attributes

observedAtstring#

最后一次观测到该分段的时间，ISO 8601 格式。已知时返回。

sourceUpdatedAtstring#

数据源最后变更的时间，ISO 8601 格式。已知时返回。

statusstring#

fresh、stale 或 unknown。

nodeIdstring#

冲突视图：记录该冲突的分段 ID。

reasonstring#

冲突视图：对冲突的自由文本说明。缺失分段视图：未使用该分段的原因，取值为 not-retrieved、permission-filtered、stale、conflict 或 unknown 之一。

permission-filtered：访问权限检查排除了该分段。

scorenumber#

分段视图：分段的相关性分数，取值 0～1。

scoresobject#

分段视图：各项分数明细，每项取值 0～1。

Show child attributes

finalnumber#

经过所有阶段后的最终分数。

freshnessnumber#

时效分数。已计算时返回。

reranknumber#

重排序分数。执行了重排序时返回。

retrievalnumber#

检索分数。

sectionPathstring[]#

分段视图：主引用的标题路径，由外到内排列。仅当分段有引用时返回。

severitystring#

冲突视图：info、warning 或 blocking。blocking 级别的冲突会阻止本次运行给出回答。

textstring#

分段视图。分段文本。分段不可用时为占位文本。

titlestring#

分段视图：sectionPath 的最后一个元素。仅当 sectionPath 非空时返回。

unavailableReasonstring#

分段不可用的原因，例如 evidence-unavailable。仅当 availability 为 unavailable 时返回。

namestring#

条目名称。分段视图：分段 ID。冲突视图：conflict-<n>，在同一分段内从 1 开始编号。缺失分段视图：missing-<n>，从 1 开始编号。

pathstring#

条目的内部路径，仅供参考。此 API 不提供该路径。

resource_typestring#

分段视图和冲突视图中为 node，缺失分段视图中为 evidence。

target_idstring#

条目的目标：

分段视图：分段 ID。
冲突视图：与之冲突的分段；未记录时为其自身所在的分段 ID。
缺失分段视图：已记录时为预期的分段 ID，否则为条目的 name。

metadata.availability 为 unavailable 时，该值可能无法对应到现存的分段。

versioninteger#

在这些视图中始终为 null。

next_cursorstring#

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

pathstring#

视图的内部路径，例如 /queries/<query_record_id>/evidence。仅供参考，此 API 不提供该路径。

previewboolean#

在这些视图中始终为 null。

truncatedboolean#

本页之后还有更多条目时为 true。沿 next_cursor 读取后续条目。

获取查询冲突列表获取研究任务列表