> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dify.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# 批量更新文档元数据

> 批量更新多个文档的元数据值。请求中的每个文档将接收指定的元数据键值对。



## OpenAPI

````yaml /zh/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/metadata
openapi: 3.0.1
info:
  title: Dify 服务 API
  description: 用于 Dify 应用与知识库的 REST API。应用类接口使用应用 API 密钥认证，知识库类接口使用知识库 API 密钥认证。
  version: 1.0.0
servers:
  - url: https://{api_base_url}
    description: Dify 服务 API 的基础 URL。自部署时，替换为你的 API 基础 URL。
    variables:
      api_base_url:
        default: api.dify.ai/v1
        description: API 基础 URL 的主机与路径，不含 `https://` 前缀。
security:
  - ApiKeyAuth: []
tags:
  - 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: 知识流水线
    description: 用于管理和运行知识流水线的操作，包括数据源插件和流水线执行。
paths:
  /datasets/{dataset_id}/documents/metadata:
    post:
      tags:
        - 元数据
      summary: 批量更新文档元数据
      description: 批量更新多个文档的元数据值。请求中的每个文档将接收指定的元数据键值对。
      operationId: batchUpdateDocumentMetadataZh
      parameters:
        - name: dataset_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: 知识库 ID。
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - operation_data
              properties:
                operation_data:
                  type: array
                  items:
                    type: object
                    required:
                      - document_id
                      - metadata_list
                    properties:
                      document_id:
                        type: string
                        description: 要更新元数据的文档 ID。
                      metadata_list:
                        type: array
                        items:
                          type: object
                          required:
                            - id
                            - name
                          properties:
                            id:
                              type: string
                              description: 元数据字段 ID。
                            name:
                              type: string
                              description: 元数据字段名称。
                            value:
                              description: 元数据值。可以是字符串、数字或 `null`。
                      partial_update:
                        type: boolean
                        default: false
                        description: 是否部分更新元数据，保留未指定字段的现有值。
                  description: 文档元数据更新操作数组。每个条目将一个文档 ID 映射到其元数据键值对。
      responses:
        '200':
          description: 文档元数据更新成功。
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: string
                    description: 操作结果。
              examples:
                success:
                  summary: 响应示例
                  value:
                    result: success
        '400':
          description: '`invalid_param` : 引用的文档不存在，或该知识库已有另一个元数据操作正在进行。'
          content:
            application/json:
              examples:
                invalid_param_doc:
                  summary: invalid_param (document)
                  value:
                    status: 400
                    code: invalid_param
                    message: Document not found.
        '403':
          description: |-
            - `forbidden` : 该知识库未启用 API 访问。
            - `forbidden` : 已达到您订阅套餐的知识库请求速率限制。
          content:
            application/json:
              examples:
                forbidden_1:
                  summary: forbidden (api access)
                  value:
                    status: 403
                    code: forbidden
                    message: Dataset api access is not enabled.
                forbidden_2:
                  summary: forbidden (rate limit)
                  value:
                    status: 403
                    code: forbidden
                    message: >-
                      Sorry, you have reached the knowledge base request rate
                      limit of your subscription.
        '404':
          description: '`not_found` : 未找到知识库。'
          content:
            application/json:
              examples:
                not_found:
                  summary: not_found
                  value:
                    status: 404
                    code: not_found
                    message: Dataset not found.
components:
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API_KEY
      description: >-
        API Key 认证。对于所有 API 请求，请在 `Authorization` HTTP 头中包含您的 API Key，并加上
        `Bearer ` 前缀。示例：`Authorization: Bearer {API_KEY}`。**强烈建议将 API Key
        存储在服务端，不要在客户端共享或存储，以避免 API Key 泄漏导致严重后果。**缺少或无效的 API Key 会返回 HTTP
        `401`，错误码为 `unauthorized`。

````