> ## 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_knowledge.json get /datasets/{dataset_id}/metadata
openapi: 3.0.1
info:
  title: 知识库 API
  description: >-
    用于管理知识库、文档、分段、元数据和标签的 API，包括创建、检索和配置操作。**注意：**单个知识库 API
    密钥有权操作同一账户下所有可见的知识库。请注意数据安全。
  version: 1.0.0
servers:
  - url: https://{api_base_url}
    description: Knowledge 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: 用于管理和运行知识流水线的操作，包括数据源插件和流水线执行。
paths:
  /datasets/{dataset_id}/metadata:
    get:
      tags:
        - 元数据
      summary: 获取元数据字段列表
      description: 返回知识库的所有元数据字段列表（包括自定义和内置字段），以及使用每个字段的文档数量。
      operationId: listMetadataFieldsZh
      parameters:
        - name: dataset_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: 知识库 ID。
      responses:
        '200':
          description: 知识库的元数据字段。
          content:
            application/json:
              schema:
                type: object
                properties:
                  doc_metadata:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: 元数据字段标识符。
                        name:
                          type: string
                          description: 元数据字段名称。
                        type:
                          type: string
                          description: 元数据字段类型。
                        count:
                          type: integer
                          description: 使用该元数据字段的文档数量。
                    description: 元数据字段定义列表。
                  built_in_field_enabled:
                    type: boolean
                    description: 该知识库是否启用了内置元数据字段。
              examples:
                success:
                  summary: 响应示例
                  value:
                    doc_metadata:
                      - id: b5c6d7e8-f9a0-1b2c-3d4e-5f6a7b8c9d0e
                        name: author
                        type: string
                        count: 3
                    built_in_field_enabled: true
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 泄漏导致严重后果。**

````