Content Extraction

POST

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

Última modificação:2024-07-26 18:00:04

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

Authorization

string

requerido

Authorization token obtained from the user/authenticate method.

Exemplo:

Bearer {{bearer_token}}

Parâmetros Bodyapplication/json

fileBase64

string <base64>

opcional

Binary file to be processed, encoded as a text string according to the RFC3548 standard using base64 encoding.

Padrão de combinação:

RFC3548

fileUrl

string

opcional

Public URL of the file to be processed.

filePassword

string <base64>

opcional

Password encoded in a base64 string, as PDFs allow passwords to be binary data.

Padrão de combinação:

RFC3548

returnImage

boolean

opcional

If true, returns the binary clipping of the typified images with the corrected perspective

Padrão:

false

returnedImageQuality

integer

opcional

Allows you to set the quality of the returned deskew image in the extraction path. The attribute is optional, and its default value (when not reporting) is 75.

>= 0<= 100

Padrão:

tags

string

opcional

Regex that defines for which tags the filters will be applied. It is possible to specify tags for a particular document or to choose that all documents sent to mostValid must be evaluated. For the latter, use the tag ^(id=.+)$.

documentConfiguration

object

opcional

generalFieldConfiguration

object

opcional

generalTableConfiguration

object

opcional

specificFieldConfiguration

object

opcional

List of specific fields, their respective minimum scores, and scoreFlags to generate tasks.

specificTableConfiguration

object

opcional

List of specific tables, their respective minimum scores, and scoreFlags to generate tasks.

fieldsNameWhitelist

array[string]

opcional

Establishes a whitelist of fields whose score rule configurations will be applied exclusively to the fields specified in it.

tablesNameWhitelist

array[string]

opcional

Establishes a whitelist of tables whose score rule configurations will be applied exclusively to the fields specified in it.

fieldsNameBlacklist

array[string]

opcional

Fields that will not be reviewed under any circumstances, regardless of the score (in the case of task generation).

tablesNameBlacklist

array[string]

opcional

Tables that will not be reviewed under any circumstances, regardless of the score (in the case of task generation).

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":""
}

Exemplos de Requisição

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 '{
   "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":""
}'

Respostas

🟢200200 Ok

application/json

Body

result

object

requerido

List containing the result of the method (see the documentation for each one).

processId

string

requerido

ID referring to the asynchronous extraction process started from this request. This ID is a reference, and will be sent in asynchronous requests that will be made by the mostValid to the endpoint specified in the webhook header.

operationId

string

requerido

Unique operation identifier to be created and provided by the client, which must be a GUID - Globally Unique Identifier.

requestId

string

requerido

Unique identifier of the request.

elapsedMilliseconds

integer

requerido

Processing duration time in milliseconds.

status

object

requerido

Object containing the response status code and message.

message

string | null

opcional

Status return message. See possible values in mostQI error messages.

code

string

requerido

Internal status code. See possible values in mostQI error messages.

errors

array [object {2}]

opcional

List of objects of type Error, format is variable.

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

Modificado em 2024-07-26 18:00:04

Página anterior

Authenticate (Get JWT)

Próxima página

Process Status