Content Classification [multipart/form-data]
POST/process-image/content-classificationRota síncrona para classificação de documentos.
:::info
Ao chamar a API pelo body em multipart/form-data, para enviar múltiplas tags no parâmetro tags o cliente deve repetir o parâmetro, fornecendo um valor para cada tag desejada. Isso implica em redundância do parâmetro, onde cada valor corresponde a uma tag específica.
:::
Request
Token de autorização obtido no método user/authenticate.
🔸Requerido quando o parâmetro fileUrl não é informado.
Binário do arquivo a ser processado.
🔸Requerido quando o parâmetro file não é informado.
Url pública do arquivo a ser processado.
🔸Requerido caso o arquivo enviado seja um PDF criptografado por senha.
A senha deve ser codificada em uma string base64 (RFC 4648), pois PDFs permitem que as senhas sejam dados binários.
Se verdadeiro, retorna o recorte dos binários das imagens tipificadas com a perspectiva corrigida.
Não obrigatório. Permite definir a qualidade da imagem de deskew retornada na rota de extração. O atributo é opcional, e seu valor padrão (quando não informando) é 75.
Parâmetro opcional que atua como um filtro para os resultados esperados, ajudando a reduzir o tempo de processamento. Por exemplo, ao passar as tags country=bra e type=documento-pessoal, a resposta incluirá apenas a classificação de documentos que correspondam a essas duas tags, mesmo que o arquivo enviado contenha documentos de outras nacionalidades ou tipos. Os valores inseridos no vetor de tags devem ser strings que seguem o padrão Regex. Consulte a lista de documentos lidos para visualizar todas as tags disponíveis.
Request samples
Responses
Lista contendo o resultado do método (consulte na documentação específica de cada um).
Atributo que retorna o tipo de conteúdo identificado. Ex: documento pessoal, certidão, etc.
Atributo que retorna o tipo de conteúdo identificado padronizado. Ex: personal document, certificate, etc.
Lista contendo atributos relacionados à classificação do documento presente no arquivo enviado.
Código único de identificação da solicitação ao servidor, que será registrado no histórico de consumo dos serviços.
Tempo de duração do processamento em milissegundos.
Objeto contendo o código e mensagem de status da resposta.
Código de status interno. Veja os valores possíveis nas mensagens de erro do mostQI.
Mensagem de retorno de status. Veja os valores possíveis nas mensagens de erro do mostQI.
Lista de objetos do tipo Error, o formato é variável.
{
"result": [
{
"type": "extrato",
"stdType": "extract",
"classifications": [
{
"source": "iocr",
"score": 1,
"tags": [
"country=bra",
"id=bra-fgts-2",
"language=pt-BR",
"of=fund",
"process-type=classification",
"std-type=extract",
"subtype=fgts",
"type=extrato"
],
"pages": [
{
"number": 1
}
],
"image": null
}
]
},
{
"type": "documento-pessoal",
"stdType": "personal-document",
"classifications": [
{
"source": "iocr",
"score": 0.93,
"tags": [
"country=bra",
"id=bra-rg-marinha-2",
"language=pt-BR",
"of=armed-forces",
"of=military",
"of=navy",
"person=natural",
"process-type=classification",
"region=back",
"region=verso",
"std-type=personal-document",
"subtype=carteira-funcional",
"subtype=functional-card",
"subtype=identity",
"subtype=rg",
"type=documento-pessoal"
],
"pages": [
{
"number": 2
}
],
"image": null
}
]
},
{
"type": "documento-pessoal",
"stdType": "personal-document",
"classifications": [
{
"source": "iocr",
"score": 1,
"tags": [
"country=bra",
"has=fingerprint",
"has=photo",
"has=signature",
"id=bra-rg-marinha-2",
"language=pt-BR",
"of=armed-forces",
"of=military",
"of=navy",
"person=natural",
"process-type=classification",
"region=frente",
"region=front",
"std-type=personal-document",
"subtype=carteira-funcional",
"subtype=functional-card",
"subtype=identity",
"subtype=rg",
"type=documento-pessoal"
],
"pages": [
{
"number": 2
}
],
"image": null
}
]
}
],
"requestId": "lXP7v8LZL925kRIA3WYOw",
"elapsedMilliseconds": 3186,
"status": {
"message": "Ok",
"code": "200",
"errors": null
}
}