Antes de poder enviar documentos para processamento, tem de criar a sua própria instância de um processador. Esta página fornece detalhes sobre a criação e a gestão de processadores.
Processadores disponíveis
Para criar uma instância do processador através da API, tem de saber o nome de cada tipo de processador. Obtenha esta lista dinamicamente (com o código abaixo), porque o seu acesso pode mudar.
Os tipos de processadores disponíveis publicamente são:
Processadores de digitalização
OCR_PROCESSORFORM_PARSER_PROCESSORLAYOUT_PARSER_PROCESSOR
Processadores pré-formados
BANK_STATEMENT_PROCESSOREXPENSE_PROCESSORFORM_W2_PROCESSORID_PROOFING_PROCESSORINVOICE_PROCESSORPAYSTUB_PROCESSORUS_DRIVER_LICENSE_PROCESSORUS_PASSPORT_PROCESSORUTILITY_PROCESSOR
Processadores de extração / classificação / divisão
CUSTOM_EXTRACTION_PROCESSORCUSTOM_CLASSIFICATION_PROCESSORCUSTOM_SPLITTING_PROCESSORSUMMARIZER_PROCESSOR
Tipos de processadores de listas
IU da Web
Na Google Cloud consola, na secção Document AI, aceda à página Galeria de processadores.
Veja ou pesquise a lista de tipos de processadores.
REST
Este exemplo mostra como listar os tipos de processadores disponíveis para o seu projeto através do método fetchProcessorTypes.
Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:
- LOCATION: a localização do seu processador, por exemplo:
us– Estados Unidoseu- União Europeia
- PROJECT_ID: o ID do seu Google Cloud projeto.
Método HTTP e URL:
GET https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION:fetchProcessorTypes
Para enviar o seu pedido, escolha uma destas opções:
curl
Execute o seguinte comando:
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION:fetchProcessorTypes"
PowerShell
Execute o seguinte comando:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri "https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION:fetchProcessorTypes" | Select-Object -Expand Content
A resposta é uma lista de ProcessorType que mostra os tipos de processadores disponíveis, juntamente com a categoria e as localizações disponíveis.
{
"processorTypes": [
[
...
{
"name": "projects/PROJECT_ID/locations/LOCATION/processorTypes/FORM_PARSER_PROCESSOR",
"type": "FORM_PARSER_PROCESSOR",
"category": "GENERAL",
"availableLocations": [
{
"locationId": "eu"
},
{
"locationId": "us"
}
],
"allowCreation": true,
"launchStage": "GA"
},
{
"name": "projects/PROJECT_ID/locations/LOCATION/processorTypes/OCR_PROCESSOR",
"type": "OCR_PROCESSOR",
"category": "GENERAL",
"availableLocations": [
{
"locationId": "eu"
},
{
"locationId": "us"
}
],
"allowCreation": true,
"launchStage": "GA"
},
{
"name": "projects/PROJECT_ID/locations/LOCATION/processorTypes/INVOICE_PROCESSOR",
"type": "INVOICE_PROCESSOR",
"category": "SPECIALIZED",
"availableLocations": [
{
"locationId": "eu"
},
{
"locationId": "us"
}
],
"allowCreation": true,
"launchStage": "GA"
},
{
"name": "projects/PROJECT_ID/locations/LOCATION/processorTypes/US_DRIVER_LICENSE_PROCESSOR",
"type": "US_DRIVER_LICENSE_PROCESSOR",
"category": "SPECIALIZED",
"availableLocations": [
{
"locationId": "us"
},
{
"locationId": "eu"
}
],
"allowCreation": true,
"launchStage": "GA"
},
...
]
}
Python
Para mais informações, consulte a documentação de referência da API Python Document AI.
Para se autenticar no Document AI, configure as Credenciais padrão da aplicação. Para mais informações, consulte o artigo Configure a autenticação para um ambiente de desenvolvimento local.
Go
Para mais informações, consulte a documentação de referência da API Go Document AI.
Para se autenticar no Document AI, configure as Credenciais padrão da aplicação. Para mais informações, consulte o artigo Configure a autenticação para um ambiente de desenvolvimento local.
Java
Para mais informações, consulte a documentação de referência da API Java Document AI.
Para se autenticar no Document AI, configure as Credenciais padrão da aplicação. Para mais informações, consulte o artigo Configure a autenticação para um ambiente de desenvolvimento local.
Ruby
Para mais informações, consulte a documentação de referência da API Ruby Document AI.
Para se autenticar no Document AI, configure as Credenciais padrão da aplicação. Para mais informações, consulte o artigo Configure a autenticação para um ambiente de desenvolvimento local.
C#
Para mais informações, consulte a documentação de referência da API C# Document AI.
Para se autenticar no Document AI, configure as Credenciais padrão da aplicação. Para mais informações, consulte o artigo Configure a autenticação para um ambiente de desenvolvimento local.
Crie um processador
IU da Web
Na Google Cloud consola, na secção Document AI, aceda à página Galeria de processadores.
Veja ou pesquise na galeria de processadores para encontrar o processador que quer criar.
Clique no tipo de processador da lista que quer criar.
Na janela lateral Criar processador, especifique um nome do processador.
Selecione a sua Região na lista.
Clique em Criar para criar o processador.
Aceda ao separador Vista geral do processador, que contém informações como Nome, ID, Tipo e Ponto final de previsão. Use este ponto final para enviar pedidos.
REST
Este exemplo mostra como criar um novo processor através do método processors.create.
Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:
- LOCATION: a localização do seu processador, por exemplo:
us– Estados Unidoseu- União Europeia
- PROJECT_ID: o ID do seu Google Cloud projeto.
- PROCESSOR_TYPE: Tipo de processador, por exemplo:
OCR_PROCESSORFORM_PARSER_PROCESSORINVOICE_PROCESSORUS_DRIVER_LICENSE_PROCESSOR
- DISPLAY_NAME: nome a apresentar do processador.
Método HTTP e URL:
POST https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors
Corpo JSON do pedido:
{
"type": "PROCESSOR_TYPE",
"displayName": "DISPLAY_NAME"
}
Para enviar o seu pedido, escolha uma destas opções:
curl
Guarde o corpo do pedido num ficheiro com o nome request.json,
e execute o seguinte comando:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors"
PowerShell
Guarde o corpo do pedido num ficheiro com o nome request.json,
e execute o seguinte comando:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method POST `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors" | Select-Object -Expand Content
Se o pedido for bem-sucedido, o servidor devolve um código de estado HTTP 200 OK e a resposta no formato JSON. A resposta contém informações sobre o processador recém-criado, como o processEndpoint e o nome completo do processador.
Ambas as strings contêm o ID do processador exclusivo (por exemplo, aa22ec60216f6ccc) necessário para enviar pedidos.
{
"name": "projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID",
"type": "PROCESSOR_TYPE",
"displayName": "DISPLAY_NAME",
"state": "ENABLED",
"processEndpoint": "https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID:process",
"createTime": "2022-03-02T22:50:31.395849Z",
"defaultProcessorVersion": "projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID/processorVersions/pretrained"
}
Python
Para mais informações, consulte a documentação de referência da API Python Document AI.
Para se autenticar no Document AI, configure as Credenciais padrão da aplicação. Para mais informações, consulte o artigo Configure a autenticação para um ambiente de desenvolvimento local.
Go
Para mais informações, consulte a documentação de referência da API Go Document AI.
Para se autenticar no Document AI, configure as Credenciais padrão da aplicação. Para mais informações, consulte o artigo Configure a autenticação para um ambiente de desenvolvimento local.
Java
Para mais informações, consulte a documentação de referência da API Java Document AI.
Para se autenticar no Document AI, configure as Credenciais padrão da aplicação. Para mais informações, consulte o artigo Configure a autenticação para um ambiente de desenvolvimento local.