Serviço de Extração de Conteúdo Textual de Arquivos de Imagem

Rota para acompanhamento do status de um processo assíncrono, conforme o código de um processo gerado na rota Content Extraction Async [multipart/form-data].

INFO

O resultado enviado ao servidor de callback segue o mesmo padrão do resultado é o mesmo da rota Content Extraction [multipart/form-data], com a adição do processId.

Tabela com possíveis status do processo:

Status	Descrição
NOT_STARTED	Processo não iniciado.
PROCESSING	Processo em andamento.
PROCESSED	Processo finalizado com sucesso.
FAILED	Processo finalizado com erro.

Request

Header Params

Authorization

string

required

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

Example:

Bearer {{bearer_token}}

Body Params multipart/form-data

processId

string

required

Código de um processo assíncrono previamente iniciado na rota process-image/content-extraction (async)

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

result

object

required

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

createdAt

string

required

Data de criação do processo.

updatedAt

string

required

Data da última atualização.

processId

string

required

Código do processo (redundância).

requestId

string

required

Código de requisição (requestId) originário.

status

string

required

Status do processo.

Examples:

NOT_STARTEDPROCESSINGPROCESSEDFAILED

requestId

string

required

Código único de identificação da solicitação ao servidor, que será registrado no histórico de consumo dos serviços.

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

object | null

required

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

Example

{
  "result": {
    "createdAt": "2022-12-23T13:05:39.889Z",
    "updatedAt": "2022-12-23T13:05:43.313Z",
    "processId": "f2b9968f-2c1e-4892-839d-90bfd3f4189t",
    "requestId": "9AIOA6ywZEa9ff8LjAefg",
    "status": "PROCESSED"
  },
  "requestId": "QgB7iYLoOkCljwrvn5hbp",
  "elapsedMilliseconds": 92,
  "status": {
    "message": "Ok",
    "code": "200",
    "errors": null
  }
}

🟠401R117 Invalid authorization data

🔴500E100 The request could not be processed

Content Extraction Async Status [multipart/form-data]

Tabela com possíveis status do processo:#

Request

Request samples

Responses

Tabela com possíveis status do processo: