ドキュメントステータスを一括更新

複数のドキュメントを一括で有効化、無効化、アーカイブ、またはアーカイブ解除します。

PATCH /datasets/{dataset_id}/documents/status/{action}

Error

A valid request URL is required to generate request examples

200

{
  "result": "success"
}

承認

Authorization · string · header · 必須

API Key 認証です。すべての API リクエストにおいて、Authorization HTTP ヘッダーに Bearer プレフィックスを付けた API Key を含めてください。例：Authorization: Bearer {API_KEY}。API Key はサーバーサイドに保存し、クライアントサイドで共有・保存しないことを強く推奨します。API Key の漏洩は深刻な結果につながる可能性があります。

パスパラメータ

dataset_id · string<uuid> · 必須

ナレッジベース ID です。

action · enum<string> · 必須

enable で有効化、disable で無効化、archive でアーカイブ、un_archive でアーカイブから復元します。

利用可能なオプション: enable, disable, archive, un_archive

ボディ

application/json

document_ids · string[] · 必須

更新するドキュメント ID のリストです。

レスポンス

200

application/json

ドキュメントが正常に更新されました。

result · string

操作結果です。