ドキュメントファイルを削除
ドキュメントファイルの削除をリクエストし、削除ジョブを返します。このファイルから構築されたすべてのリビジョンについて、チャンク一覧を取得 でチャンクが返らなくなります。
ドキュメント全体を削除するには、ドキュメントを削除 を使用します。ドキュメントのアクティブなリビジョンのファイルは削除しないでください。削除すると、ドキュメントは failed になり、アクティブなリビジョンがなくなります。また、ドキュメント一覧を取得 からも Dify のドキュメント一覧からも消えます。それでもドキュメント数の上限にはカウントされます。
この DELETE には JSON ボディを付けて送信します。クライアントが DELETE リクエストのボディを省略する場合は、ボディを明示的に送信するよう設定してください。
削除の流れについては、ドキュメントとソースの削除 を参照してください。
1 min read
delete/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}
Request example
Response
delete/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}
Authorization
Path parameters
ナレッジベース ID です。ナレッジベースの API アクセス ダイアログに表示されるサービス API エンドポイントの最後のセグメント(
…/knowledge-fs/spaces/<knowledge base ID>)です。アドレスバーでは /datasets/new/ の後のセグメントです。ドキュメントファイル ID です。ドキュメントファイル一覧を取得 から取得します。
Headers
同じ API キーと冪等キーで同一のリクエストを再送信すると、元のジョブが
202 で返されます。別のリクエストや別の API キーで同じキーを再利用すると 409 が返ります。前後に空白を含まない、印字可能な ASCII 文字を使用してください。Length: 8–255
Body
application/jsonドキュメントファイルの現在の
version です。ドキュメントファイル一覧を取得 または ドキュメントファイルを取得 から取得します。ドキュメントファイルの version は常に 1 です。ドキュメントリビジョン一覧を取得 のリビジョン番号ではありません。古い値を送ると 409 が返り、何も削除されません。Range: >= 1
Responses
application/json
削除リクエストが受け付けられ、バックグラウンドで実行されます。受け付けられた時点から、ドキュメントファイルを取得 は
404 を返します。完了を確認するには、run_state が completed または failed になるまで 削除ジョブを取得(status_url)をポーリングしてください。