Étiquettes de métadonnées personnalisées

Document AI permet d'ajouter des libellés définis par l'utilisateur ou des paires clé-valeur (PKV) en tant que métadonnées envoyées au processeur pour les requêtes ProcessDocument et BatchProcessDocuments. Ces métadonnées sur la requête (ainsi que les données d'utilisation, comme le nombre de pages) sont transmises au système Cloud Billing. Il est renseigné dans le système de facturation, dans lequel vous pouvez consulter le détail des frais apparaissant sur votre facture en fonction de ces libellés de métadonnées.

Cas d'utilisation

Un cas d'utilisation important des libellés concerne les clients qui fournissent des services de traitement de documents à de nombreux clients. Un même projet peut être utilisé pour plusieurs clients. À des fins de facturation, il est important d'associer des requêtes spécifiques à leur client respectif. C'est là qu'interviennent ces libellés de métadonnées. Ils permettent de filtrer les rapports dans Google Cloud.

Exigences relatives aux étiquettes

Les libellés appliqués à une requête doivent répondre aux exigences suivantes :

  • Chaque requête peut posséder plusieurs libellés, jusqu'à un maximum de 64.
  • Chaque étiquette doit être une paire clé-valeur.
  • Les clés doivent comporter un (1) caractère au minimum et 63 au maximum, et ne peuvent pas être vides. Les valeurs peuvent être vides et comporter 63 caractères au maximum.
  • Les clés et les valeurs ne contiennent que des lettres minuscules, des chiffres, des traits de soulignement et des tirets. Tous les caractères doivent être au format d'encodage UTF-8. Les caractères internationaux sont autorisés.
  • La partie clé d'un libellé doit être unique au sein d'une même requête. Par exemple, {'country':'india'} convient, mais {'country':'india','country':'sweden'} n'est pas autorisé.
  • Les clés doivent commencer par une lettre minuscule ou un caractère international.

Utilisation avec l'API

L'exemple de code Sync Process montre comment envoyer une requête à un processeur à l'aide d'un libellé.

  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"

Exemple de requête

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

L'exemple de code Async Process montre comment envoyer une requête à un processeur à l'aide d'un libellé.

  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"

Exemple de requête

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

Rapport de tarification

Vous pouvez utiliser ces libellés pour afficher l'utilisation des requêtes.

  1. Accédez à la console Cloud Billing.

  2. Dans la console, sélectionnez Menu en haut à gauche, puis Facturation dans le menu déroulant. Si vous possédez plusieurs comptes de facturation, une page s'affiche et vous invite à faire votre choix. Sélectionnez Accéder au compte de facturation associé.

    custom-defined-request-metadata-labels-1

    custom-defined-request-metadata-labels-2

  3. Sur la page "Facturation", sélectionnez Rapports dans le volet de navigation de gauche.

    custom-defined-request-metadata-labels-3

  4. Utilisez les filtres du volet de droite pour vérifier l'utilisation des requêtes.

    custom-defined-request-metadata-labels-4

    custom-defined-request-metadata-labels-5