Content Extraction

POST

https://mostvalid.com.br/process-image/content-extraction

webhookregrastarefasextracaoocr

Last modified:2025-02-13 17:11:40

Valores aceitos para o parâmetro `scoreFlag`

IGNORE_NULL: Somente será feita a avaliação de campos, tabelas ou documentos retornados pelo mostQI que possuírem scores menores do que o especificado na configuração, ou seja, o retorno com score nulo será ignorado no processamento da geração de tarefas.
CONSIDER_NULL: Será feita a avaliação de campos, tabelas ou documentos retornados pelo mostQI que possuírem scores menores do que o especificado na configuração ou possuírem seu valor igual a nulo, ou seja, o retorno com score nulo será considerado no processamento da geração de tarefas.
IGNORE_SCORE: Independente do score retornado pelo mostQI será aberto uma tarefa para avaliação do campo, tabela ou documento.

Validação das entradas

Quando o parâmetro webhook é fornecido, uma chamada intermediária será disparada quando o processo inicial de extração for finalizado. Essa chamada adicional tem o propósito de transmitir a situação parcial do processo, indicando quais entidades (campos, tabelas, células e documentos) estão pendentes de avaliação humana, identificadas pelo status 'TO_ANALYSIS', e quais entidades não requerem avaliação humana, identificadas pelo status 'MOSTQIIOCR'.

Campos depreciados

Campos depreciados são nomes de campos descontinuados no padrão de nomenclatura de campos do mostQI. Embora esses campos ainda possam estar presentes na versão atual do resultado da extração, não são mais recomendados para uso.
Os campos depreciados não são considerados pelo mostValid para geração de tarefas e não são exibidos nas tarefas de análise.
Para os clientes que ainda utilizam campos depreciados em suas operações, recomendamos a substituição pelo campo atualizado correspondente.

NOTE

Confira a listagem atualizada de documentos e respectivos campos aqui.

Request

Header Params

Authorization

string

required

Token de autorização obtido no método user/authenticate.

Example:

Bearer {{bearer_token}}

Body Params application/json

fileBase64

string <base64>

optional

🔸Requerido quando o parâmetro fileUrl não é informado. Binário do arquivo a ser processado, codificado em string de texto conforme o padrão RFC3548, usando a codificação base64.

Match pattern:

RFC3548

fileUrl

string

optional

🔸Requerido quando o parâmetro fileBase64 não é informado. Url pública do arquivo a ser processado.

filePassword

string <base64>

optional

🔸Requerido caso o arquivo enviado seja um PDF criptografado por senha. A senha deve ser codificada em uma string base64, pois PDFs permitem que as senhas sejam dados binários.

Match pattern:

RFC3548

returnImage

boolean

optional

Se verdadeiro, retorna o recorte dos binários das imagens tipificadas com a perspectiva corrigida.

Default:

false

returnedImageQuality

integer

optional

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.

>= 0<= 100

Default:

returnCrops

boolean

optional

Se verdadeiro, retorna os recortes dos binários das imagens contidas dentro de um documento tipificado com a perspectiva corrigida, como recortes de foto, assinatura, código de barras e impressão digital. Consulte a lista de documentos lidos para visualizar todos os crops disponíveis.

Default:

false

tags

string

required

Regex que define quais tags serão verificadas nos filtros. É possível utilizar tags específicas para um determinado documento ou definir que todos os documentos enviados ao mostValid sejam revisados, neste segundo caso utilize ^(id=.+)$.

documentConfiguration

object

required

generalFieldConfiguration

object

required

generalTableConfiguration

object

required

specificFieldConfiguration

array [object {3}]

required

Lista de campos específicos, respectivos scores mínimos e scoreFlags para gerar tarefas.

specificTableConfiguration

array [object {3}]

required

Lista de tabelas específicas, respectivos scores mínimos e scoreFlags para gerar tarefas.

fieldsNameWhitelist

array[string]

optional

Estabelece uma whitelist de campos cujas configurações das regras de score serão aplicadas exclusivamente aos campos nela especificados.

tablesNameWhitelist

array[string]

optional

Estabelece uma whitelist de tabelas cujas configurações das regras de score serão aplicadas exclusivamente aos campos nela especificados.

fieldsNameBlacklist

array[string]

optional

Campos que obrigatoriamente não serão revisados, independentemente do score (no caso de geração de tarefa).

tablesNameBlacklist

array[string]

optional

Tabelas que obrigatoriamente não serão revisadas, independentemente do score (no caso de geração de tarefa).

Example

{
  "fileBase64": "SGVsbG8gd29ybGQh...",
  "fileUrl": "https://example.com/file.pdf",
  "returnImage": true,
  "returnedImageQuality": 90,
  "webhook": {
    "url": "https://example.com/webhook",
    "fallbackUrl": "https://fallback.example.com/webhook",
    "authorization": {
      "headers": [
        {
          "name": "Authorization",
          "value": "Bearer token"
        }
      ],
      "queryStrings": [
        {
          "name": "apiKey",
          "value": "123456789"
        }
      ]
    }
  },
  "operation": {
    "id": "d2cbc642-9912-4a12-9931-653a17a6afef",
    "maxRetries": 3,
    "timeoutSeconds": 60
  },
  "generationRules": [
    {
      "documentConfiguration": {
        "score": 0.8,
        "scoreFlag": "IGNORE_NULL"
      },
      "generalFieldConfiguration": {
        "score": 0.7,
        "scoreFlag": "CONSIDER_NULL"
      },
      "generalTableConfiguration": {
        "score": 0.5,
        "scoreFlag": "IGNORE_SCORE"
      },
      "specificFieldConfiguration": [
        {
          "name": "cpf",
          "score": 0.9,
          "scoreFlag": "IGNORE_NULL"
        }
      ],
      "specificTableConfiguration": [
        {
          "name": "tabela_categorias",
          "score": 0.6,
          "scoreFlag": "IGNORE_NULL"
        }
      ],
      "fieldsNameWhitelist": [
        "cpf",
        "data_emissao"
      ],
      "tablesNameWhitelist": [
        "tabela_categorias"
      ]
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://mostvalid.com.br/process-image/content-extraction' \
--header 'Authorization: Bearer {{bearer_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fileBase64": "SGVsbG8gd29ybGQh...",
    "fileUrl": "https://example.com/file.pdf",
    "returnImage": true,
    "returnedImageQuality": 90,
    "webhook": {
        "url": "https://example.com/webhook",
        "fallbackUrl": "https://fallback.example.com/webhook",
        "authorization": {
            "headers": [
                {
                    "name": "Authorization",
                    "value": "Bearer token"
                }
            ],
            "queryStrings": [
                {
                    "name": "apiKey",
                    "value": "123456789"
                }
            ]
        }
    },
    "operation": {
        "id": "d2cbc642-9912-4a12-9931-653a17a6afef",
        "maxRetries": 3,
        "timeoutSeconds": 60
    },
    "generationRules": [
        {
            "documentConfiguration": {
                "score": 0.8,
                "scoreFlag": "IGNORE_NULL"
            },
            "generalFieldConfiguration": {
                "score": 0.7,
                "scoreFlag": "CONSIDER_NULL"
            },
            "generalTableConfiguration": {
                "score": 0.5,
                "scoreFlag": "IGNORE_SCORE"
            },
            "specificFieldConfiguration": [
                {
                    "name": "cpf",
                    "score": 0.9,
                    "scoreFlag": "IGNORE_NULL"
                }
            ],
            "specificTableConfiguration": [
                {
                    "name": "tabela_categorias",
                    "score": 0.6,
                    "scoreFlag": "IGNORE_NULL"
                }
            ],
            "fieldsNameWhitelist": [
                "cpf",
                "data_emissao"
            ],
            "tablesNameWhitelist": [
                "tabela_categorias"
            ]
        }
    ]
}'

Responses

🟢200OK

application/json

Body

result

object

required

Lista contendo o resultado do método (consulte na documentação específica de cada um).

processId

string

required

ID referente ao processo assíncrono de extração iniciado a partir desta requisição. Este ID é uma referência, e será enviado nas requisições assíncronas que serão feitas pelo servidor do mostValid ao endpoint especificado no cabeçalho webhook.

operationId

string

optional

Identificador único da operação, a ser criado e fornecido pelo cliente, devendo ser um GUID - Globally Unique Identifier.

requestId

string

required

Identificador único da solicitação.

elapsedMilliseconds

integer

required

Tempo de duração do processamento em milissegundos.

status

object

required

Objeto contendo o código de status e a mensagem de resposta.

message

string | null

required

Mensagem de retorno de status. Veja os valores possíveis nas mensagens de erro do mostQI.

code

string

required

Código de status interno. Veja os valores possíveis nas mensagens de erro do mostQI.

errors

array [object {2}] | null

required

Lista de objetos do tipo Error, o formato é variável.

Example

{
  "result": {
    "processId": "1ccbdf64-f13b-4bf2-0d33-eade1e85c598",
    "operationId": "8b024a8c-c7e8-4bb4-9fb6-08304d278388"
  },
  "requestId": "VOUj0Ay9DESqp2RowoaItt",
  "elapsedMilliseconds": 100,
  "status": {
    "message": "Ok",
    "code": "201",
    "errors": null
  }
}

🟠400R101 A specified parameter is wrong

🟠400R300 Client isn't registered yet or has a invalid token

🔴500E100 The request could not be processed

Modified at 2025-02-13 17:11:40

Authenticate (Get JWT)

Process Status

Content Extraction

Valores aceitos para o parâmetro scoreFlag #

Validação das entradas#

Campos depreciados#

Request

Request samples

Responses

Valores aceitos para o parâmetro `scoreFlag`

Validação das entradas

Campos depreciados