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

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 です。ナレッジベースのドキュメントリストを取得 から取得します。

Body

multipart/form-data
datastring#
設定情報を含む JSON 文字列です。テキストからドキュメントを作成 と同じフィールド(doc_form、doc_language、process_rule、retrieval_model、embedding_model、embedding_model_provider)を受け付けますが、name と text は除きます。
filefile#

アップロードするファイルです。デフォルトの上限は 15 MB です。

セルフホスト環境では UPLOAD_FILE_SIZE_LIMIT 環境変数 で調整できます。Dify Cloud の Professional と Team プランでは上限が 50 MB になります。

Responses

application/json
ドキュメントが正常に更新されました。
batchstring#
インデックス進捗を追跡するためのバッチ ID です。
documentobject#