> ## Documentation Index
> Fetch the complete documentation index at: https://dify-6c0370d8-fix-template-upload-size-guidance.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# ドキュメントメタデータを一括更新

> 複数のドキュメントのメタデータ値を 1 回のリクエストで更新します。



## OpenAPI

````yaml /ja/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/metadata
openapi: 3.0.1
info:
  description: >-
    Dify アプリケーションとナレッジベースのための REST API です。アプリケーション系エンドポイントはアプリの API
    キーで、ナレッジ系エンドポイントはナレッジベースの API キーで認証します。
  title: Dify サービス API
  version: 1.0.0
servers:
  - description: Dify サービス API のベース URL です。セルフホスト環境では、独自の API ベース URL に置き換えてください。
    url: https://{api_base_url}
    variables:
      api_base_url:
        default: api.dify.ai/v1
        description: API ベース URL のホストとパス（`https://` を除く）。
security:
  - ApiKeyAuth: []
tags:
  - description: チャットメッセージとインタラクションに関連する操作です。
    name: チャットメッセージ
  - description: ファイルのアップロードとプレビューの操作です。
    name: ファイル操作
  - description: エンドユーザー情報に関連する操作です。
    name: エンドユーザー
  - description: ユーザーフィードバックの操作です。
    name: メッセージフィードバック
  - description: 会話管理に関連する操作です。
    name: 会話管理
  - description: テキスト読み上げと音声認識の操作です。
    name: 音声・テキスト変換
  - description: アプリケーション設定と情報を取得する操作です。
    name: アプリケーション設定
  - description: ダイレクト返信用のアノテーション管理に関連する操作です。
    name: アノテーション管理
  - description: 人間の入力を要する一時停止中のワークフローの再開操作です。
    name: 人間の入力
  - description: ワークフローの実行と管理のための操作です。
    name: ワークフロー実行
  - description: テキスト生成に関連する操作です。
    name: 完了メッセージ
  - description: ナレッジベースの作成、設定、取得を含むナレッジベース管理の操作です。
    name: ナレッジベース
  - description: ナレッジベース内のドキュメントの作成、更新、管理のための操作です。
    name: ドキュメント
  - description: ドキュメントチャンクと子チャンクの管理のための操作です。
    name: チャンク
  - description: ナレッジベースのメタデータフィールドとドキュメントメタデータ値の管理のための操作です。
    name: メタデータ
  - description: ナレッジベースタグとタグバインディングの管理のための操作です。
    name: タグ管理
  - description: 利用可能なモデルを取得するための操作です。
    name: モデル
  - description: データソースプラグインとパイプライン実行を含むナレッジパイプラインの管理と実行のための操作です。
    name: ナレッジパイプライン
paths:
  /datasets/{dataset_id}/documents/metadata:
    post:
      tags:
        - メタデータ
      summary: ドキュメントメタデータを一括更新
      description: 複数のドキュメントのメタデータ値を 1 回のリクエストで更新します。
      operationId: batchUpdateDocumentMetadataJa
      parameters:
        - description: >-
            ナレッジベース ID
            です。[ナレッジベースリストを取得](/ja/api-reference/knowledge-bases/list-knowledge-bases)
            を参照してください。
          in: path
          name: dataset_id
          required: true
          schema:
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                operation_data:
                  description: ドキュメントメタデータの更新操作です。ドキュメントごとに 1 エントリです。
                  items:
                    properties:
                      document_id:
                        description: >-
                          更新するドキュメントの ID
                          です。[ナレッジベースのドキュメントリストを取得](/ja/api-reference/documents/list-documents)
                          を参照してください。
                        type: string
                      metadata_list:
                        description: ドキュメントに設定するメタデータフィールドです。
                        items:
                          properties:
                            id:
                              description: >-
                                メタデータフィールド ID
                                です。[メタデータフィールドリストを取得](/ja/api-reference/metadata/list-metadata-fields)
                                を参照してください。
                              type: string
                            name:
                              description: メタデータフィールド名です。
                              type: string
                            value:
                              description: メタデータ値。文字列、数値、または `null` を指定できます。
                          required:
                            - id
                            - name
                          type: object
                        type: array
                      partial_update:
                        default: false
                        description: メタデータを部分的に更新し、未指定フィールドの既存の値を保持するかどうかです。
                        type: boolean
                    required:
                      - document_id
                      - metadata_list
                    type: object
                  type: array
              required:
                - operation_data
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                success:
                  summary: レスポンス例
                  value:
                    result: success
              schema:
                properties:
                  result:
                    description: 操作結果です。
                    type: string
                type: object
          description: ドキュメントメタデータが正常に更新されました。
        '400':
          content:
            application/json:
              examples:
                invalid_param:
                  summary: invalid_param
                  value:
                    code: invalid_param
                    message: >-
                      Another document metadata operation is running, please
                      wait a moment.
                    status: 400
          description: '`invalid_param` : このリクエスト内のドキュメントで別のメタデータ操作が実行中です。'
        '403':
          content:
            application/json:
              examples:
                forbidden_1:
                  summary: forbidden (api access)
                  value:
                    code: forbidden
                    message: Dataset api access is not enabled.
                    status: 403
                forbidden_2:
                  summary: forbidden (rate limit)
                  value:
                    code: forbidden
                    message: >-
                      Sorry, you have reached the knowledge base request rate
                      limit of your subscription.
                    status: 403
          description: |-
            - `forbidden` : このナレッジベースでは API アクセスが有効になっていません。
            - `forbidden` : サブスクリプションのナレッジベースリクエストのレート制限に達しました。
        '404':
          content:
            application/json:
              examples:
                not_found_1:
                  summary: not_found (knowledge base)
                  value:
                    code: not_found
                    message: Dataset not found.
                    status: 404
                not_found_2:
                  summary: not_found (document)
                  value:
                    code: not_found
                    message: Document not found.
                    status: 404
                not_found_3:
                  summary: not_found (metadata)
                  value:
                    code: not_found
                    message: Metadata not found.
                    status: 404
          description: |-
            - `not_found` : ナレッジベースが見つかりません。
            - `not_found` : `operation_data` で参照されたドキュメントがこのナレッジベースに存在しません。
            - `not_found` : `metadata_list` で参照されたメタデータフィールドがこのナレッジベースに存在しません。
components:
  securitySchemes:
    ApiKeyAuth:
      bearerFormat: API_KEY
      description: >-
        すべてのリクエストは API キーで認証します：`Authorization: Bearer
        {API_KEY}`。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API
        キーを使用します（[Dify API クイックスタート](/ja/api-reference/guides/get-started)）。


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

````