Guia de início rápido: configurar a API Document AI

Neste guia, você vai encontrar todas as etapas de configuração necessárias para começar a usar a Document AI.

Sobre o Console do Google Cloud

O Console do Google Cloud é uma UI da Web usada para provisionar, configurar, gerenciar e monitorar sistemas que usam produtos do Google Cloud . Use o console do Google Cloud para configurar e gerenciar recursos da Document AI.

Crie um projeto

Para usar os serviços fornecidos pelo Google Cloud, você precisa criar um projeto, que organiza todos os recursos do Google Cloud e consiste nos seguintes componentes:

  • Um grupo de colaboradores
  • APIs ativadas (e outros recursos)
  • Ferramentas de monitoramento
  • Informações de faturamento
  • Autenticação e controles de acesso
  • Processadores da Document AI

É possível criar um projeto ou vários projetos. É possível usar seus projetos para organizar os recursos do Google Cloud em uma hierarquia de recursos. Para mais informações sobre projetos, consulte a documentação do Resource Manager.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Ativar a API

Ative a API Document AI no seu projeto. Para mais informações sobre como ativar APIs, consulte a documentação do Service Usage.

Enable the Document AI API.

Enable the API

Ativar faturamento

Uma conta de faturamento define quem paga por um determinado conjunto de recursos. As contas de faturamento podem ser vinculadas a um ou mais projetos. O uso do projeto é cobrado na conta de faturamento vinculada. Você configura o faturamento quando cria um projeto. Para mais informações, consulte a documentação de faturamento.

Make sure that billing is enabled for your Google Cloud project.

Locais

A Document AI oferece algum controle sobre onde os recursos do seu projeto são armazenados e processados. Especificamente, ao criar um processador, é necessário escolher um local para armazenar e processar seus dados. Por padrão, a Document AI armazena e processa recursos em um local dos EUA. Se você escolher o local da União Europeia, seus dados e processos serão armazenados apenas na União Europeia.

Como definir o local usando a API

É necessário especificar o local do processador sempre que você enviar uma solicitação de processamento usando a API. Por exemplo, se o processador estiver configurado para armazenar e processar seus dados na União Europeia, use o URI eu-documentai.googleapis.com da seguinte maneira:

Process
  • https://eu-documentai.googleapis.com/v1/projects/$PROJECT_ID/locations/eu/processors/$PROCESSOR_ID:process
  • https://eu-documentai.googleapis.com/v1beta3/projects/$PROJECT_ID/locations/eu/processors/$PROCESSOR_ID:process
batchProcess
  • https://eu-documentai.googleapis.com/v1/projects/$PROJECT_ID/locations/eu/processors/$PROCESSOR_ID:batchProcess
  • https://eu-documentai.googleapis.com/v1beta3/projects/$PROJECT_ID/locations/eu/processors/$PROCESSOR_ID:batchProcess

Instalar a biblioteca de cliente da API Document AI

Você tem três opções para chamar a API Document AI:

As bibliotecas de cliente estão disponíveis para vários idiomas conhecidos. Para informações sobre como instalar as bibliotecas de cliente, consulte Bibliotecas de cliente da API Document AI.

Instale e inicialize a CLI do Google Cloud.

A CLI gcloud fornece um conjunto de ferramentas que podem ser usadas para gerenciar recursos e aplicativos hospedados no Google Cloud.

O link a seguir fornece as instruções:

Install the Google Cloud CLI, then initialize it by running the following command:

gcloud init

Configurar a autenticação

Qualquer aplicativo cliente que usa a API precisa ser autenticado e receber acesso aos recursos solicitados. A configuração da autenticação depende se você está trabalhando em um ambiente de desenvolvimento local ou configurando um ambiente de produção. Para mais informações, consulte Configurar o Application Default Credentials.

Select the tabs for how you plan to access the API:

gcloud

Install the Google Cloud CLI, then initialize it by running the following command:

gcloud init

Bibliotecas de cliente

Para usar bibliotecas de cliente em um ambiente de desenvolvimento local, instale e inicialize o gcloud CLI e configure o Application Default Credentials com suas credenciais de usuário.

  1. Install the Google Cloud CLI.
  2. To initialize the gcloud CLI, run the following command:

    gcloud init
  3. If you're using a local shell, then create local authentication credentials for your user account:

    gcloud auth application-default login

    You don't need to do this if you're using Cloud Shell.

Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local na documentação de autenticação do Google Cloud.

REST

Para usar a API REST em um ambiente de desenvolvimento local, use as credenciais fornecidas para a gcloud CLI.

    Install the Google Cloud CLI, then initialize it by running the following command:

    gcloud init

Para mais informações, consulte Autenticar para usar REST na documentação de autenticação do Google Cloud.

Para informações sobre como configurar a autenticação para um ambiente de produção, consulte Set up Application Default Credentials for code running on Google Cloud na documentação de autenticação do Google Cloud.

Sobre os papéis

Ao chamar uma API, o Google Cloud exige que a identidade que faz a chamada (qualquer pessoa, entidade ou processo aplicável e os respectivos atributos definidos) tenha as permissões apropriadas. É possível conceder permissões ao atribuir papéis a uma conta de usuário ou de serviço. Para mais informações, consulte a documentação do Identity and Access Management (IAM).

Para testar a API Document AI, use o papel Projeto > Proprietário nas etapas abaixo. O papel Projeto > Proprietário concede à conta de serviço permissão total para os recursos em seu projeto. Se a solicitação não exigir permissões totais, especifique um papel mais restritivo usando o console do Google Cloud. Para uma lista de permissões e papéis da Document AI, consulte Permissões da Document AI e Papéis da Document AI. Para informações sobre como gerenciar permissões usando papéis do IAM, consulte Gerenciar o acesso a projetos, pastas e organizações.

Configuração de acesso a arquivos entre projetos

Ao configurar o processador da Document AI em um projeto, talvez você queira que esse projeto acesse arquivos de entrada armazenados em um projeto diferente na mesma organização que hospeda processadores da Document AI.

Para permitir o acesso entre projetos, conceda o papel de Leitor de objetos do Storage (roles/storage.objectViewer) à conta de serviço padrão da Document AI, conforme mostrado na figura a seguir.

setup-1

Exemplo

  • Suponha que o projeto A hospede processadores da Document AI e, opcionalmente, hospede uma saída de processador de bucket em que a saída é gravada.
  • O Projeto B é o proprietário do bucket que contém arquivos de entrada para os processadores da Document AI.
  • Para tornar os arquivos do projeto B acessíveis ao projeto A, conceda o papel de leitor de objetos do Storage (roles/storage.objectViewer) para o bucket de entrada no projeto B à conta de serviço da Document AI do projeto A.

    setup-2

Para mais informações sobre o IAM e o Storage Object Viewer, consulte Papéis do IAM para o Cloud Storage.

Contas de serviço integradas

Uma conta de serviço do Document AI segue esta convenção de nomenclatura:

service-{project number}@gcp-sa-prod-dai-core.iam.gserviceaccount.com

Exemplo: service-361747088407@gcp-sa-prod-dai-core.iam.gserviceaccount.com

setup-3

Próximas etapas: casos de uso

Depois que a API Document AI for ativada, os processadores da Document AI poderão ser criados e usados. O tipo de processador mais adequado depende do caso de uso.