Skip to main content
get/datasets/{dataset_id}/documents/{document_id}/segments
Request example
Response
get/datasets/{dataset_id}/documents/{document_id}/segments

Authorization

Authorizationstringheaderrequired#

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

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

Path parameters

dataset_idstringrequired#
ナレッジベース ID。ナレッジベースリストを取得 で取得します。スコープを限定したキーでは、Dify の URL から ID をコピー してください。
document_idstringrequired#
ドキュメント ID です。ナレッジベースのドキュメントリストを取得 から取得します。

Query parameters

pageinteger#
ページ番号。

Default: 1

Range: >= 1

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

Default: 20

Range: >= 1

statusstring[]#
インデックスステータスでチャンクをフィルタリングします(例:completed、indexing、error)。
keywordstring#
検索キーワードです。

Responses

application/json
チャンクのリストです。
dataobject[]#
チャンクのリスト。
doc_formstring#
このドキュメントが使用するドキュメントチャンキングモードです。
has_moreboolean#
次のページにさらに項目が存在するかどうかです。
limitinteger#
1 ページあたりの件数です。
pageinteger#
現在のページ番号です。
totalinteger#
一致するチャンクの合計数です。