メインコンテンツへスキップ
GET
チャンク一覧を取得

承認

Authorization
string
header
必須

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

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

パスパラメータ

dataset_id
string<uuid>
必須

ナレッジベース ID です。ナレッジベースリストを取得 から取得します。

document_id
string<uuid>
必須

ドキュメント ID です。ナレッジベースのドキュメントリストを取得 から取得します。

クエリパラメータ

page
integer
デフォルト:1

ページ番号。

必須範囲: x >= 1
limit
integer
デフォルト:20

1 ページあたりの項目数です。サーバーの上限は 100 です。

必須範囲: x >= 1
status
string[]

インデックスステータスでチャンクをフィルタリングします(例:completedindexingerror)。

keyword
string

検索キーワードです。

レスポンス

チャンクのリストです。

data
object[]

チャンクのリスト。

doc_form
string

このドキュメントが使用するドキュメントチャンキングモードです。

total
integer

一致するチャンクの合計数です。

has_more
boolean

次のページにさらに項目が存在するかどうかです。

limit
integer

1 ページあたりの件数です。

page
integer

現在のページ番号です。