自定义元数据标签

Document AI 支持将用户定义的标签或键值对 (KVP) 添加为发送给处理器的元数据,以便在 ProcessDocumentBatchProcessDocuments 请求中使用。系统会将与请求相关的这些元数据(以及网页数量等使用数据)转发到 Cloud Billing 系统。系统会在结算系统中填充此标签,您可以在该系统中使用这些元数据标签进行过滤,以细分结算费用。

使用场景

标签的一个重要使用场景是客户向他们的许多客户提供文档处理服务。一个项目可用于多个客户。为了进行结算,必须将特定的请求与各自的客户相关联。这正是这些元数据标签的用武之地。这些维度用于在 Google Cloud中过滤报告。

标签要求

应用于请求的标签必须满足以下要求:

  • 每个请求可以带有多个标签,最多 64 个。
  • 每个标签都必须采用键值对形式。
  • 键至少包含 1 个字符,最多包含 63 个字符,且不能为空。值可以为空,且最多包含 63 个字符。
  • 键和值只能包含小写字母、数字字符、下划线和短划线。所有字符都必须使用 UTF-8 编码,且允许使用国际字符。
  • 标签的键部分在单个请求中必须是唯一的(例如,您可以使用 {'country':'india'},但不能使用 {'country':'india','country':'sweden'})。
  • 键必须以小写字母或国际字符开头。

与 API 搭配使用

Sync Process 代码示例展示了如何使用标签向处理器发送请求。

  curl -X POST \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    -d @docai_request.json \
    "https://us-documentai.googleapis.com/v1/projects/514064100333/locations/us/processors/3bb61571a9731982:process"

示例请求

  {
    "skipHumanReview": true,
    "rawDocument": {
      "mimeType": "application/pdf",
        "content" : "PDF/IMAGE CONTENT"
    },
    "labels": {"country": "india" },
    "processOptions": {
      "individualPageSelector" : {
        "pages": [1]
      }
    }
  }

Async Process 代码示例展示了如何使用标签向处理器发送请求。

  curl -X POST \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    -d @batch_docai_request.json \
    "https://us-documentai.googleapis.com/v1/projects/514064100333/locations/us/processors/3bb61571a9731982:batchProcess"

示例请求

  {
   "inputDocuments": {
     "gcsPrefix": {
       "gcsUriPrefix": "gs://atul_dai_test/ravi/GCS_DWH_work_flows_docs/Small_pdf/"
     }
   },
   "documentOutputConfig": {
     "gcsOutputConfig": {
       "gcsUri": "gs://atul_dai_test/ravi/GCS_DWH_work_flows_docs/test/docai_config/"
     }
   },
   "labels": {"country": "india" },
   "skipHumanReview": true
 }

价格报告

您可以使用这些标签查看请求用量。

  1. 前往 Cloud Billing 控制台

  2. 在控制台中,选择左上角的 Menu(菜单),然后从下拉菜单中选择 Billing(结算)。如果您有多个结算账号,则系统会显示一个页面,要求您选择结算账号。选择转至关联的结算账号

    custom-defined-request-metadata-labels-1

    custom-defined-request-metadata-labels-2

  3. 在“结算”页面中,选择左侧导航窗格中的报告

    custom-defined-request-metadata-labels-3

  4. 使用右侧窗格中的过滤条件检查请求的用量。

    custom-defined-request-metadata-labels-4

    custom-defined-request-metadata-labels-5