欠落チャンク一覧を取得

クエリの実行で想定されていたものの、使用できなかったチャンクを一覧表示します。チャンク 1 つにつき 1 エントリです。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 キーで認証します：Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します（Dify API クイックスタート）。

キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは 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#

1 ページあたりのエントリ数です。

Default: 100

Range: 1–100

Responses

application/json

1 ページ分の欠落チャンクエントリです。

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 を使って取得します。

クエリの矛盾一覧を取得リサーチタスク一覧を取得