Skip to main content
DELETE
ドキュメントファイルを一括削除

Authorizations

Authorization
string
header
required

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

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

Headers

Idempotency-Key
string
required

この削除リクエストを識別する必須の値です。同じ API キーで同じ冪等キーと同じリクエストを再送信すると、元のバッチが返され、その pending のファイルが再試行されます。別のリクエストや別の API キーで同じキーを再利用すると 409 が返ります。前後に空白を含まない、印字可能な ASCII 文字を使用してください。

Required string length: 8 - 255

Path Parameters

knowledge_base_id
string<uuid>
required

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

Body

application/json

正規化後のリクエストは、UTF-8 で 1,048,576 バイト以内に収める必要があります。リクエストサイズの制限 を参照してください。

documents
object[]
required

削除するファイルです。各 documentId は 1 回だけ指定します。上限より大きいバッチには 400 が返ります。デプロイ環境によっては、より低い上限が設定されている場合があります。

Required array length: 1 - 100 elements

Response

バッチが記録されました。results に各ファイルの結果が、items に受け付けられたファイルが入ります。削除はバックグラウンドで実行されます。ファイルの削除が受け付けられた時点から、ドキュメントファイルを取得 は 404 を返します。すべてのファイルを最後まで追跡するには、削除バッチを取得(バッチの status_url)をポーリングしてください。

返されたジョブ ID をポーリングしてください。pending のまま残ったファイルを再試行するには、同じ Idempotency-Key で同じリクエストを再送信してください。

batch_id
string | null

このリクエストを記録するバッチの ID です。

items
object[]

受け付けられたファイルごとに 1 つのエントリが入ります。

results
object[]

リクエストされたファイルごとに 1 つのエントリが入り、その結果を示します。

status_url
string | null

このバッチの 削除バッチを取得 の URL です。デプロイ環境で SERVICE_API_URL が設定されている場合は絶対 URL、それ以外の場合は /v1/ で始まるパスです。ドキュメントファイルを一括削除 は、この値を Location レスポンスヘッダーでも返します。

total
integer

元のリクエストに含まれるファイル数です。