Content Extraction

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.

NOTA

Confira a listagem atualizada de documentos e respectivos campos aqui.

Requisição

Parâmetros Header

Parâmetros Bodyapplication/json

Exemplo

{
    "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"
            ]
        }
    ]
}

Códigos de solicitação

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200OK

application/json

Body

Exemplo

{
    "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

Content Extraction

Valores aceitos para o parâmetro scoreFlag #

Validação das entradas#

Campos depreciados#

Requisição

Códigos de solicitação

Respostas

Valores aceitos para o parâmetro `scoreFlag`

Validação das entradas

Campos depreciados