> ## Documentation Index > Fetch the complete documentation index at: https://docs.dify.ai/llms.txt > Use this file to discover all available pages before exploring further. # 获取查询分段列表 > 列出一次查询运行检索到的分段，每个分段一条，包含其主引用、分数、时效性和文本。 条目按本次运行的排序先后排列。`data` 为空且 `truncated: false` 表示本次运行没有记录分段。 如何结合查看一次运行的分段、冲突和缺失分段，详见 [排查回答](/zh/api-reference/guides/knowledge-base#investigate-an-answer)。 ## OpenAPI ````yaml /zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces/{query_record_id}/evidence openapi: 3.0.1 info: description: 用于 Dify 应用与知识库的 REST API。应用类接口使用应用 API 密钥认证，知识库类接口使用知识库 API 密钥认证。 title: Dify 服务 API version: 1.0.0 servers: - description: Dify 服务 API 的基础 URL。自部署时，替换为你的 API 基础 URL。 url: https://{api_base_url} variables: api_base_url: default: api.dify.ai/v1 description: API 基础 URL 的主机与路径，不含 `https://` 前缀。 security: - ApiKeyAuth: [] tags: - description: 与聊天消息和交互相关的操作。 name: 对话消息 - description: 文件上传和预览操作。 name: 文件操作 - description: 终端用户信息相关操作。 name: 终端用户 - description: 用户反馈操作。 name: 消息反馈 - description: 与管理会话相关的操作。 name: 会话管理 - description: 文字转语音和语音转文字操作。 name: 语音与文字转换 - description: 获取应用设置和信息的操作。 name: 应用配置 - description: 与管理标注直接回复相关的操作。 name: 标注管理 - description: 暂停等待人工输入的工作流恢复操作。 name: 人工介入 - description: 用于执行和管理工作流的操作。 name: 工作流运行 - description: 文本生成相关操作。 name: 文本生成消息 - description: 用于管理知识库的操作，包括创建、配置和检索。 name: 知识库 - description: 用于在知识库中创建、更新和管理文档的操作。 name: 文档 - description: 用于管理分段和子分段的操作。 name: 分段 - description: 用于管理知识库元数据字段和文档元数据值的操作。 name: 元数据 - description: 用于管理知识库标签和标签绑定的操作。 name: 标签 - description: 用于获取可用模型的操作。 name: 模型 - description: 用于管理和运行知识流水线的操作，包括数据源插件和流水线执行。 name: 知识流水线 - description: 向知识库提问，并流式返回回答。 name: 查询 - description: 查看一次查询检索到了什么，以及原因。 name: 查询记录 - description: 在后台运行研究问题，并获取其结果。 name: 研究任务 - description: 读取知识库中的文档及其文件、修订版本和分段，并用元数据标注文档。 name: 文档与分段 - description: 跟踪、取消或重试索引，并列出知识库的后台任务。 name: 索引任务 - description: 跟踪文档文件、一批文件或数据源的删除，直到完成。 name: 删除作业 - description: 管理为知识库提供内容的数据源，以及它们的定时同步设置和连接。 name: 数据源 - description: 立即同步数据源，导入网站页面或提供商条目，并跟踪、取消或重试运行。 name: 数据源同步与导入 - description: 读取和更改知识库的模型与检索设置，并跟踪更改触发的迁移。 name: 设置 paths: /knowledge-fs/spaces/{knowledge_base_id}/traces/{query_record_id}/evidence: get: tags: - Query Records summary: 获取查询分段列表 description: >- 列出一次查询运行检索到的分段，每个分段一条，包含其主引用、分数、时效性和文本。 条目按本次运行的排序先后排列。`data` 为空且 `truncated: false` 表示本次运行没有记录分段。 如何结合查看一次运行的分段、冲突和缺失分段，详见 [排查回答](/zh/api-reference/guides/knowledge-base#investigate-an-answer)。 operationId: listQueryChunks parameters: - description: >- 知识库 ID：即知识库 **API 访问** 对话框中所示服务 API 端点的最后一段（`…/knowledge-fs/spaces/`），也是地址栏中 `/datasets/new/` 之后的那一段。 in: path name: knowledge_base_id required: true schema: format: uuid type: string - description: >- 查询记录 ID：即 [运行查询](/zh/api-reference/queries/run-query) 返回的 `x-query-run-id` 响应头，或 [获取查询记录列表](/zh/api-reference/query-records/list-query-records) 中的 `id`。 in: path name: query_record_id required: true schema: format: uuid type: string - description: 游标，取自上一页的 `next_cursor`。条目按偏移量定位，因此 `0` 表示从第一条开始。 in: query name: cursor required: false schema: maxLength: 1000 minLength: 1 type: string - description: 每页条目数。 in: query name: limit required: false schema: default: 100 maximum: 100 minimum: 1 type: integer responses: '200': content: application/json: examples: success: summary: 响应示例 value: consistency_class: null data: - kind: resource metadata: availability: available citationCount: 1 conflictCount: 1 documentId: 6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b documentVersion: 1 freshness: observedAt: '2026-09-05T10:00:00.000Z' sourceUpdatedAt: '2026-08-30T12:00:00.000Z' status: fresh score: 0.82 scores: final: 0.82 freshness: 0.9 rerank: 0.85 retrieval: 0.71 sectionPath: - Policies - Refunds text: Refunds are issued within 14 days of purchase. title: Refunds name: a1f3c5e7-9b2d-4f6a-8c0e-1d2f3a4b5c6d path: >- /queries/3c9e3b1a-2f0a-4b7d-9d3e-1f2a3b4c5d6e/evidence/a1f3c5e7-9b2d-4f6a-8c0e-1d2f3a4b5c6d resource_type: node target_id: a1f3c5e7-9b2d-4f6a-8c0e-1d2f3a4b5c6d version: null - kind: resource metadata: availability: unavailable citationCount: 1 conflictCount: 0 documentId: 6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b documentVersion: 1 freshness: status: unknown score: 0.64 scores: final: 0.64 retrieval: 0.6 sectionPath: [] text: Evidence deleted or unavailable unavailableReason: evidence-unavailable name: b2e4d6f8-0c3e-4a7b-9d1f-2e3a4b5c6d7e path: >- /queries/3c9e3b1a-2f0a-4b7d-9d3e-1f2a3b4c5d6e/evidence/b2e4d6f8-0c3e-4a7b-9d1f-2e3a4b5c6d7e resource_type: node target_id: b2e4d6f8-0c3e-4a7b-9d1f-2e3a4b5c6d7e version: null next_cursor: null path: /queries/3c9e3b1a-2f0a-4b7d-9d3e-1f2a3b4c5d6e/evidence preview: null truncated: false schema: $ref: '#/components/schemas/KnowledgeBaseQueryRecordEntries' description: 一页分段条目。`name` 和 `target_id` 均为分段 ID，`resource_type` 为 `node`。 '400': content: application/json: examples: knowledge_fs_invalid_request: summary: knowledge_fs_invalid_request (local validation) value: code: knowledge_fs_invalid_request message: Agent Knowledge Base request is invalid. status: 400 violations: - field: - cursor type: string_too_long knowledge_fs_invalid_request_2: summary: knowledge_fs_invalid_request (upstream) value: 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 knowledge_fs_invalid_request_path: summary: knowledge_fs_invalid_request (path ID) value: code: knowledge_fs_invalid_request message: Agent Knowledge Base request is invalid. status: 400 description: >- - `knowledge_fs_invalid_request`：请求未通过校验、`limit` 超过 100，或 `query_record_id` 不是 UUID。`violations` 列出每个出错的字段。 - `knowledge_fs_invalid_request`：`query_record_id` 格式不正确。 - `knowledge_fs_invalid_request`：`cursor` 不是非负整数偏移量。 '401': content: application/json: examples: knowledge_fs_invalid_credential: summary: knowledge_fs_invalid_credential value: code: knowledge_fs_invalid_credential message: Invalid Agent Knowledge Base service credential. status: 401 unauthorized: summary: unauthorized value: code: unauthorized message: Access token is invalid status: 401 description: >- - `unauthorized`：缺少 `Authorization` 请求头，或密钥无法识别、不是知识库 API 密钥。 - `knowledge_fs_invalid_credential`：密钥有效，但其所属工作空间中没有此 ID 的知识库，或该密钥未关联任何工作空间。 '403': content: application/json: examples: forbidden: summary: forbidden (rate limit) value: code: forbidden message: >- Sorry, you have reached the knowledge base request rate limit of your subscription. status: 403 knowledge_fs_access_denied: summary: knowledge_fs_access_denied (key scope) value: code: knowledge_fs_access_denied message: Agent Knowledge Base operation is not allowed. status: 403 knowledge_fs_access_denied_2: summary: knowledge_fs_access_denied (upstream) value: 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 description: >- - `knowledge_fs_access_denied`：该密钥的访问范围限定为其他知识库、此知识库已关闭 **API 访问**，或知识库未处于活动状态。 - `knowledge_fs_access_denied`：该密钥无权访问此知识库的内容。 - `forbidden`：在 Dify Cloud 上，工作空间已达到其订阅套餐的知识库请求频率限制。所有调用都计入，读取操作也不例外。 '404': content: application/json: examples: knowledge_fs_resource_not_found: summary: knowledge_fs_resource_not_found value: 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 not_found: summary: not_found (feature off) value: 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 description: >- - `knowledge_fs_resource_not_found`：不存在此 ID 的查询记录、该记录属于其他知识库，或该记录指向的检索分段已不再存储。 - `not_found`：当前部署已关闭 Agent 知识库功能。 '502': content: application/json: examples: knowledge_fs_upstream_unavailable: summary: knowledge_fs_upstream_unavailable value: code: knowledge_fs_upstream_unavailable message: Agent Knowledge Base is unavailable. status: 502 description: '- `knowledge_fs_upstream_unavailable`：未能及时收到响应，或无法读取响应。稍候重试。' '503': content: application/json: examples: knowledge_fs_operation_unavailable: summary: knowledge_fs_operation_unavailable value: code: knowledge_fs_operation_unavailable message: Agent Knowledge Base operation is not available. status: 503 knowledge_fs_operation_unavailable_upstream: summary: knowledge_fs_operation_unavailable (temporary) value: 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 description: >- - `knowledge_fs_operation_unavailable`：此工作空间尚未配置 Agent 知识库功能、当前部署不提供此操作，或在请求鉴权期间该密钥对此知识库的访问权限发生了变化。 - `knowledge_fs_operation_unavailable`：暂时无法处理该请求。按 `failure.retryPolicy` 处理。 - `knowledge_fs_operation_unavailable`：该知识库由经典知识库升级而来，仍在禁用原先已禁用或已归档的文档。稍后重试。 components: schemas: KnowledgeBaseQueryRecordEntries: properties: consistency_class: description: 在这些视图中始终为 `null`。 nullable: true type: string data: description: 本页的条目，按本次运行记录的顺序排列。 items: properties: kind: description: 在这些视图中始终为 `resource`。 type: string metadata: description: 条目详情。可用的键取决于视图。在缺失分段视图中，`metadata` 还包含缺失项自身的元数据键。 properties: availability: description: '`available`；分段已删除或无法再读取时为 `unavailable`。' type: string citationCount: description: 分段视图：该分段的引用数。 type: integer conflictCount: description: 分段视图：该分段上记录的冲突数。分段不可用时为 `0`。 type: integer documentId: description: >- 分段视图：主引用的文档文件 ID，可用于 [获取文档文件](/zh/api-reference/documents-and-chunks/get-document-file)。仅当分段有引用时返回。 type: string documentVersion: description: 分段视图：该文档文件的版本。仅当分段有引用时返回。 type: integer freshness: description: 分段视图。检索时分段的时效信息。 properties: observedAt: description: 最后一次观测到该分段的时间，ISO 8601 格式。已知时返回。 type: string sourceUpdatedAt: description: 数据源最后变更的时间，ISO 8601 格式。已知时返回。 type: string status: description: '`fresh`、`stale` 或 `unknown`。' type: string type: object nodeId: description: 冲突视图：记录该冲突的分段 ID。 type: string reason: description: >- 冲突视图：对冲突的自由文本说明。缺失分段视图：未使用该分段的原因，取值为 `not-retrieved`、`permission-filtered`、`stale`、`conflict` 或 `unknown` 之一。 `permission-filtered`：访问权限检查排除了该分段。 type: string score: description: 分段视图：分段的相关性分数，取值 0～1。 type: number scores: description: 分段视图：各项分数明细，每项取值 0～1。 properties: final: description: 经过所有阶段后的最终分数。 type: number freshness: description: 时效分数。已计算时返回。 type: number rerank: description: 重排序分数。执行了重排序时返回。 type: number retrieval: description: 检索分数。 type: number type: object sectionPath: description: 分段视图：主引用的标题路径，由外到内排列。仅当分段有引用时返回。 items: type: string type: array severity: description: >- 冲突视图：`info`、`warning` 或 `blocking`。`blocking` 级别的冲突会阻止本次运行给出回答。 type: string text: description: 分段视图。分段文本。分段不可用时为占位文本。 type: string title: description: 分段视图：`sectionPath` 的最后一个元素。仅当 `sectionPath` 非空时返回。 type: string unavailableReason: description: >- 分段不可用的原因，例如 `evidence-unavailable`。仅当 `availability` 为 `unavailable` 时返回。 type: string type: object name: description: >- 条目名称。分段视图：分段 ID。冲突视图：`conflict-`，在同一分段内从 1 开始编号。缺失分段视图：`missing-`，从 1 开始编号。 type: string path: description: 条目的内部路径，仅供参考。此 API 不提供该路径。 type: string resource_type: description: 分段视图和冲突视图中为 `node`，缺失分段视图中为 `evidence`。 nullable: true type: string target_id: description: |- 条目的目标： - 分段视图：分段 ID。 - 冲突视图：与之冲突的分段；未记录时为其自身所在的分段 ID。 - 缺失分段视图：已记录时为预期的分段 ID，否则为条目的 `name`。 `metadata.availability` 为 `unavailable` 时，该值可能无法对应到现存的分段。 nullable: true type: string version: description: 在这些视图中始终为 `null`。 nullable: true type: integer type: object type: array next_cursor: description: 下一页的游标，最后一页时为 `null`。将其作为 `cursor` 传回。 nullable: true type: string path: description: 视图的内部路径，例如 `/queries//evidence`。仅供参考，此 API 不提供该路径。 type: string preview: description: 在这些视图中始终为 `null`。 nullable: true type: boolean truncated: description: 本页之后还有更多条目时为 `true`。沿 `next_cursor` 读取后续条目。 type: boolean type: object securitySchemes: ApiKeyAuth: bearerFormat: API_KEY description: >- 每个请求都通过 API Key 认证：`Authorization: Bearer {API_KEY}`。应用接口使用应用 API Key，知识库接口使用知识库 API Key（[快速开始](/zh/api-reference/guides/get-started)）。 API Key 应保存在服务端，切勿嵌入客户端代码。缺失或无效的 Key 会返回 HTTP `401`（`unauthorized`）。 scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.