Rótulos de metadados personalizados

O Document AI aceita a adição de rótulos definidos pelo usuário ou pares de chave-valor (KVPs, na sigla em inglês) como metadados enviados ao processador para solicitações ProcessDocument e BatchProcessDocuments. Esses metadados sobre a solicitação (junto com os dados de uso, como o número de páginas) são encaminhados para o sistema do Cloud Billing. Ele é preenchido no sistema de faturamento, onde você pode detalhar as cobranças de faturamento usando esses rótulos de metadados.

Caso de uso

Um caso de uso importante para rótulos envolve clientes que fornecem serviços de processamento de documentos a vários clientes. É possível usar um único projeto para vários clientes. Para fins de faturamento, é essencial associar solicitações específicas aos respectivos clientes. É aí que entram esses rótulos de metadados. Eles servem para filtrar relatórios em Google Cloud.

Requisitos dos rótulos

Os rótulos aplicados a uma solicitação precisam atender aos requisitos a seguir:

• Cada solicitação pode ter vários rótulos. O número máximo é de 64.
• Cada rótulo precisa ser um KVP.
• As chaves têm comprimento mínimo de 1 e máximo de 63 caracteres. Além disso, elas não podem estar vazias. Os valores podem estar vazios e ter um comprimento máximo de 63 caracteres.
• As chaves e os valores contêm apenas letras minúsculas, caracteres numéricos, sublinhados e traços. Todos os caracteres precisam usar a codificação UTF-8, e os caracteres internacionais são permitidos.
• A parte principal de um rótulo precisa ser única em uma solicitação. Por exemplo, {'country':'india'} é permitido, mas {'country':'india','country':'sweden'} não.
• As chaves precisam começar com uma letra minúscula ou um caractere internacional.

Uso com a API

O exemplo de código Sync Process mostra como enviar uma solicitação para um processador usando um rótulo.

  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"

Exemplo de solicitação

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

O exemplo de código Async Process mostra como enviar uma solicitação para um processador usando um rótulo.

  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"

Exemplo de solicitação

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

Preços dos relatórios

É possível usar esses rótulos para conferir o uso de solicitações.

1. Acesse o console do Cloud Billing.

2. No console, selecione o Menu no canto superior esquerdo e Faturamento no menu suspenso. Se você tiver várias contas de faturamento, uma página vai aparecer solicitando que você faça uma seleção. Selecione Acessar a conta de faturamento vinculada.

   

   

3. Na página de faturamento, selecione Relatórios no painel de navegação à esquerda.

   

4. Use os filtros no painel à direita para verificar o uso das solicitações.