Skip to main content
GET
クエリのチャンク一覧を取得

Authorizations

Authorization
string
header
required

すべてのリクエストは API キーで認証します:Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します(Dify API クイックスタート)。

キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401(unauthorized)で失敗します。

Path Parameters

knowledge_base_id
string<uuid>
required

ナレッジベース ID です。ナレッジベースの API アクセス ダイアログに表示されるサービス API エンドポイントの最後のセグメント(…/knowledge-fs/spaces/<knowledge base ID>)です。アドレスバーでは /datasets/new/ の後のセグメントです。

query_record_id
string<uuid>
required

クエリ記録 ID です。クエリを実行 のレスポンスヘッダー x-query-run-id、または クエリ記録一覧を取得 の id です。

Query Parameters

cursor
string

前のページの next_cursor から取得したカーソルです。エントリはオフセットで指定するため、0 を指定すると最初のエントリから始まります。

Required string length: 1 - 1000
limit
integer
default:100

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

Required range: 1 <= x <= 100

Response

1 ページ分のチャンクエントリです。name と target_id はチャンクの ID で、resource_type は node です。

consistency_class
string | null

これらのビューでは常に null です。

data
object[]

このページのエントリで、実行時に記録された順に並びます。

next_cursor
string | null

次のページのカーソルです。最後のページでは null です。cursor として送り返してください。

path
string

ビューの内部パスです(例:/queries/<query_record_id>/evidence)。参考情報であり、この API ではこのパスを提供していません。

preview
boolean | null

これらのビューでは常に null です。

truncated
boolean

このページ以降にもエントリがある場合は true です。続きは next_cursor を使って取得します。