Content Extraction

Accepted values for the scoreFlag parameter

IGNORE_NULL: Evaluation will only be conducted on fields, tables, or documents returned by mostQI that have scores lower than the specified configuration. In other words, returns with null scores will be ignored in the task generation process.

CONSIDER_NULL: Evaluation will be conducted on fields, tables, or documents returned by mostQI that have scores lower than the specified configuration or have a null value. In this case, returns with null scores will be considered in the task generation process.

IGNORE_SCORE: Regardless of the score returned by mostQI, a task will be opened for evaluation of the field, table, or document.

Input validation:

When the webhook parameter is provided, an intermediate call will be triggered when the initial extraction process is completed. This additional call aims to transmit the partial status of the process, indicating which entities (fields, tables, cells, and documents) are pending human evaluation, identified by the 'TO_ANALYSIS' status, and which entities do not require human evaluation, identified by the 'MOSTQIIOCR' status.

Deprecated fields

Deprecated fields are names of discontinued fields in the mostQI field naming standard. Although these fields may still be present in the current version of the extraction result, they are no longer recommended for use.

Deprecated fields are not considered by mostValid for task generation and are not displayed in the analysis tasks.

For clients still using deprecated fields in their operations, we recommend replacing them with the corresponding updated field.

Check the updated listing of documents and their respective fields here.

Requisição

Parâmetros Header

Parâmetros Bodyapplication/json

Exemplo

{
   "webhook" : {
   "url" : "",
   "fallbackUrl" : "",
   "authorization": {
            "headers": [
                {
                    "name": "nomeCabecalho1",
                    "value": "valorCabecalho1"
                },
                {
                    "name": "nomeCabecalho2",
                    "value": "valorCabecalho2"
                }
            ],
               "queryStrings": [
                {
                    "name": "nomeQs1",
                    "value": "valorQs1"
                },
                {
                    "name": "nomeQs2",
                    "value": "valorQs2"
                }
            ]
      }
  },
    "fileBase64": "",
    "fileUrl": "",
    "returnImage": false,
    "returnedImageQuality":""
}

Códigos de solicitação

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200200 Ok

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