Neste guia, você verá todas as etapas de configuração necessárias para começar a usar a Document AI.
Sobre o console Google Cloud
O Google Cloud console é uma UI da Web usada para provisionar, configurar, gerenciar e monitorar sistemas que usam produtos do Google Cloud . Use o console Google Cloud para configurar e gerenciar recursos da Document AI.
Criar um projeto
Para usar os serviços fornecidos por Google Cloud, crie um projeto, que organiza todos os seus 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.
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.
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.
Verify 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 tratados. Em especial, ao criar um processador, você precisa escolher um local para armazenar e processar seus dados. Por padrão, a Document AI armazena e processa recursos em um local nos EUA. Se você escolher a União Europeia como local, seus dados e processos serão armazenados somente na União Europeia.
Como definir o local usando a API
É necessário especificar a localização do seu 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 forma:
Process |
|
batchProcess |
|
Instalar a biblioteca de cliente da API Document AI
Você tem três opções para chamar a API Document AI:
- Bibliotecas de cliente compatíveis com o Google (recomendado)
- REST
- gRPC
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 oferece um conjunto de ferramentas que podem ser usadas para gerenciar recursos e aplicativos hospedados em Google Cloud.
O link a seguir fornece as instruções:
Instale a CLI do Google Cloud. Após a instalação, inicialize a CLI do Google Cloud executando o seguinte comando:
gcloud initAo usar um provedor de identidade (IdP) externo, primeiro faça login na gcloud CLI com sua identidade federada.
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 de você estar 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 tab for how you plan to use the samples on this page:
gcloud
In the Google Cloud console, activate Cloud Shell.
At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.
C#
Para usar os exemplos .NET desta página em um ambiente de desenvolvimento local, instale e inicialize a CLI gcloud e configure o Application Default Credentials com suas credenciais de usuário.
Instale a CLI do Google Cloud.
Ao usar um provedor de identidade (IdP) externo, primeiro faça login na gcloud CLI com sua identidade federada.
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.
If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.
Para mais informações, consulte Configurar o ADC para um ambiente de desenvolvimento local na documentação de autenticação do Google Cloud .
Go
Para usar os exemplos Go desta página em um ambiente de desenvolvimento local, instale e inicialize a CLI gcloud e configure o Application Default Credentials com suas credenciais de usuário.
Instale a CLI do Google Cloud.
Ao usar um provedor de identidade (IdP) externo, primeiro faça login na gcloud CLI com sua identidade federada.
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.
If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.
Para mais informações, consulte Configurar o ADC para um ambiente de desenvolvimento local na documentação de autenticação do Google Cloud .
Java
Para usar os exemplos Java desta página em um ambiente de desenvolvimento local, instale e inicialize a CLI gcloud e configure o Application Default Credentials com suas credenciais de usuário.
Instale a CLI do Google Cloud.
Ao usar um provedor de identidade (IdP) externo, primeiro faça login na gcloud CLI com sua identidade federada.
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.
If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.
Para mais informações, consulte Configurar o ADC para um ambiente de desenvolvimento local na documentação de autenticação do Google Cloud .
Node.js
Para usar os exemplos Node.js desta página em um ambiente de desenvolvimento local, instale e inicialize a CLI gcloud e configure o Application Default Credentials com suas credenciais de usuário.
Instale a CLI do Google Cloud.
Ao usar um provedor de identidade (IdP) externo, primeiro faça login na gcloud CLI com sua identidade federada.
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.
If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.
Para mais informações, consulte Configurar o ADC para um ambiente de desenvolvimento local na documentação de autenticação do Google Cloud .
PHP
Para usar os exemplos PHP desta página em um ambiente de desenvolvimento local, instale e inicialize a CLI gcloud e configure o Application Default Credentials com suas credenciais de usuário.
Instale a CLI do Google Cloud.
Ao usar um provedor de identidade (IdP) externo, primeiro faça login na gcloud CLI com sua identidade federada.
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.
If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.
Para mais informações, consulte Configurar o ADC para um ambiente de desenvolvimento local na documentação de autenticação do Google Cloud .
Python
Para usar os exemplos Python desta página em um ambiente de desenvolvimento local, instale e inicialize a CLI gcloud e configure o Application Default Credentials com suas credenciais de usuário.
Instale a CLI do Google Cloud.
Ao usar um provedor de identidade (IdP) externo, primeiro faça login na gcloud CLI com sua identidade federada.
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.
If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.
Para mais informações, consulte Configurar o ADC para um ambiente de desenvolvimento local na documentação de autenticação do Google Cloud .
Ruby
Para usar os exemplos Ruby desta página em um ambiente de desenvolvimento local, instale e inicialize a CLI gcloud e configure o Application Default Credentials com suas credenciais de usuário.
Instale a CLI do Google Cloud.
Ao usar um provedor de identidade (IdP) externo, primeiro faça login na gcloud CLI com sua identidade federada.
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.
If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.
Para mais informações, consulte Configurar o ADC para um ambiente de desenvolvimento local na documentação de autenticação do Google Cloud .
REST
Para usar as amostras da API REST nesta página em um ambiente de desenvolvimento local, use as credenciais fornecidas para a CLI gcloud.
Instale a CLI do Google Cloud.
Ao usar um provedor de identidade (IdP) externo, primeiro faça login na gcloud CLI com sua identidade federada.
Para mais informações, consulte Autenticar para usar REST 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 Gerenciamento de identidade e acesso (IAM, na sigla em inglês).
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 completas, especifique um papel mais restritivo usando o console doGoogle 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 saber 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 ele acesse arquivos de entrada armazenados em outro projeto da mesma organização que hospeda os processadores da Document AI.
Para permitir o acesso entre projetos, conceda o papel Leitor de objetos do Storage
(roles/storage.objectViewer) à conta de serviço padrão da Document AI, conforme mostrado na figura a seguir.
Exemplo
- Suponha que o projeto A hospede processadores da Document AI e, opcionalmente, um bucket em que a saída do processador é gravada.
- O projeto B é proprietário do bucket que contém arquivos de entrada para 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.
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 da 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
Próximas etapas: casos de uso
Depois que a API Document AI é ativada, os processadores da Document AI podem ser criados e usados. O melhor tipo de processador depende do seu caso de uso.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-08-18 UTC.