Benutzerdefinierte Metadatenlabels

Document AI unterstützt das Hinzufügen benutzerdefinierter Labels oder Schlüssel/Wert-Paare als Metadaten, die an den Prozessor für ProcessDocument- und BatchProcessDocuments-Anfragen gesendet werden. Diese Metadaten zur Anfrage (zusammen mit den Nutzungsdaten, z. B. Anzahl der Seiten) werden an das Cloud Billing-System weitergeleitet. Es wird im Abrechnungssystem ausgefüllt, wo Sie Ihre Abrechnungsgebühren durch Filtern nach diesen Metadaten-Labels aufschlüsseln können.

Anwendungsfall

Ein wichtiger Anwendungsfall für Labels sind Kunden, die Dokumentverarbeitungsdienste für viele Kunden anbieten. Ein einzelnes Projekt kann für mehrere Kunden verwendet werden. Zu Abrechnungszwecken ist es wichtig, bestimmte Anfragen ihren jeweiligen Kunden zuzuordnen. Hier kommen diese Metadaten-Labels ins Spiel. Sie dienen zum Filtern von Berichten in Google Cloud.

Anforderungen an Labels

Die Labels, die auf eine Anfrage angewendet werden, müssen die folgenden Anforderungen erfüllen:

  • Jede Anfrage kann bis zu 64 Labels haben.
  • Jedes Label muss ein Schlüssel/Wert-Paar sein.
  • Schlüssel haben eine Mindestlänge von einem Zeichen und eine maximale Länge von 63 Zeichen und dürfen nicht leer sein. Werte dürfen leer sein und haben eine maximale Länge von 63 Zeichen.
  • Schlüssel und Werte enthalten nur Kleinbuchstaben, Ziffern, Unterstriche und Bindestriche. Alle Zeichen müssen UTF-8-codiert sein. Internationale Zeichen sind zulässig.
  • Der Schlüsselabschnitt eines Labels muss innerhalb einer einzelnen Anfrage eindeutig sein. Beispiel: {'country':'india'} ist zulässig, {'country':'india','country':'sweden'} ist jedoch nicht zulässig.
  • Schlüssel müssen mit einem Kleinbuchstaben oder einem internationalen Zeichen beginnen.

Verwendung mit API

Das Sync Process-Codebeispiel zeigt, wie Sie eine Anfrage mit einem Label an einen Prozessor senden.

  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"

Beispielanfrage

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

Das Async Process-Codebeispiel zeigt, wie Sie eine Anfrage mit einem Label an einen Prozessor senden.

  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"

Beispielanfrage

  {
   "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
 }

Preisbericht

Mit diesen Labels können Sie die Anfragenutzung einsehen.

  1. Rufen Sie die Cloud Billing-Konsole auf.

  2. Wählen Sie in der Konsole links oben das  Menü und dann im Drop-down-Menü Abrechnung aus. Wenn Sie mehrere Rechnungskonten haben, wird eine Seite angezeigt, auf der Sie aufgefordert werden, eine Auswahl zu treffen. Wählen Sie Zum verknüpften Rechnungskonto aus.

    custom-defined-request-metadata-labels-1

    custom-defined-request-metadata-labels-2

  3. Wählen Sie auf der Seite „Abrechnung“ im linken Navigationsbereich die Option Berichte aus.

    custom-defined-request-metadata-labels-3

  4. Verwenden Sie die Filter im rechten Bereich, um die Nutzung von Anfragen zu prüfen.

    custom-defined-request-metadata-labels-4

    custom-defined-request-metadata-labels-5