Comparação de Similaridade de Documentos - Content Extraction Distance

Rota para comparar a similaridade (distância) entre os resultados obtidos na rota de extração Content Extraction (JSONs) de dois documentos.

Request

Header Params

Authorization

string

required

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

Example:

Bearer {{bearer_token}}

Body Params application/json

document1

object

required

Objeto cujo tipo é o mesmo dos itens da lista result no resultado da rota Content Extraction.

document2

object

required

Objeto cujo tipo é o mesmo dos itens da lista result no resultado da rota Content Extraction.

Example

{
  "document1": {},
  "document2": {}
}

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).

globalDistance

number <float> | null

optional

Distância entre dos dois documentos para inferência da similaridade global.

>= 0<= 1

maxLocalDistance

number <float> | null

optional

Apresenta o maior valor de distância calculado localmente.

>= 0<= 1

fields

array [object {4}] | null

optional

Lista contendo cada um dos campos do primeiro documento enviado na requisição (document1) e o resultado do cálculo da distância de seu valor com o respectivo campo no segundo documento (document2).

tables

array [object {3}] | null

optional

Lista contendo cada uma das tabelas do primeiro documento enviado na requisição (document1) e o resultado do cálculo da distância de seu valor com a respectiva tabela no segundo documento (document2).

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

message

string | null

required

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

code

string

required

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

errors

array [object {2}] | null

required

Example

{
  "result": {
    "globalDistance": 1,
    "maxLocalDistance": 1,
    "fields": [
      {
        "name": "nome",
        "distance": 1,
        "value1": "LORENZO RIBEIRO",
        "value2": ""
      },
      {
        "name": "data_primeira_habilitacao",
        "distance": 0,
        "value1": "2021-06-02",
        "value2": "2021-06-02"
      },
      {
        "name": "orgao_emissor",
        "distance": 0,
        "value1": "ORGAO DE TRANSITO",
        "value2": "ORGAO DE TRANSITO"
      },
      {
        "name": "data_nascimento",
        "distance": 0,
        "value1": "2001-03-08",
        "value2": "2001-03-08"
      },
      {
        "name": "local_nascimento",
        "distance": 0,
        "value1": "BELO HORIZONTE / MG",
        "value2": "BELO HORIZONTE / MG"
      },
      {
        "name": "data_emissao",
        "distance": 0,
        "value1": "2022-06-07",
        "value2": "2022-06-07"
      },
      {
        "name": "data_validade",
        "distance": 0,
        "value1": "2024-12-14",
        "value2": "2024-12-14"
      },
      {
        "name": "tipo_habilitacao",
        "distance": 0,
        "value1": "D",
        "value2": "D"
      },
      {
        "name": "numero_espelho_frente",
        "distance": 0,
        "value1": "4603413290",
        "value2": "4603413290"
      },
      {
        "name": "rg",
        "distance": 0,
        "value1": "MG15905255",
        "value2": "MG15905255"
      },
      {
        "name": "doc",
        "distance": 0,
        "value1": "MG15905255 SSP MG",
        "value2": "MG15905255 SSP MG"
      },
      {
        "name": "tipo_identidade",
        "distance": 0,
        "value1": "RG",
        "value2": "RG"
      },
      {
        "name": "numero_identidade",
        "distance": 0,
        "value1": "MG15905255",
        "value2": "MG15905255"
      },
      {
        "name": "orgao_emissor_identidade",
        "distance": 0,
        "value1": "SSP",
        "value2": "SSP"
      },
      {
        "name": "estado_emissao_identidade",
        "distance": 0,
        "value1": "MG",
        "value2": "MG"
      },
      {
        "name": "cpf",
        "distance": 1,
        "value1": "38663431082",
        "value2": ""
      },
      {
        "name": "registro",
        "distance": 1,
        "value1": "76719610303",
        "value2": ""
      },
      {
        "name": "cat_hab",
        "distance": 0,
        "value1": "B",
        "value2": "B"
      },
      {
        "name": "nacionalidade",
        "distance": 0,
        "value1": "BRASILEIRO",
        "value2": "BRASILEIRO"
      },
      {
        "name": "filiacao_2",
        "distance": 0,
        "value1": "SERGIO MIRANDA RIBEIRO",
        "value2": "SERGIO MIRANDA RIBEIRO"
      },
      {
        "name": "filiacao_1",
        "distance": 0,
        "value1": "LEIA RIBEIRO",
        "value2": "LEIA RIBEIRO"
      },
      {
        "name": "numero_espelho_verso",
        "distance": 0,
        "value1": "4603413290",
        "value2": "4603413290"
      },
      {
        "name": "observacoes",
        "distance": 0,
        "value1": null,
        "value2": null
      },
      {
        "name": "local_cidade",
        "distance": 0,
        "value1": null,
        "value2": null
      },
      {
        "name": "local_uf",
        "distance": 0,
        "value1": null,
        "value2": null
      },
      {
        "name": "renach",
        "distance": 0,
        "value1": null,
        "value2": null
      },
      {
        "name": "codigo_seguranca",
        "distance": 0,
        "value1": null,
        "value2": null
      },
      {
        "name": "estado_emissor",
        "distance": 0,
        "value1": null,
        "value2": null
      }
    ],
    "tables": [
      {
        "name": "tabela_categorias",
        "headers": [
          {
            "name": "categoria"
          },
          {
            "name": "data_inicio"
          },
          {
            "name": "data_fim"
          },
          {
            "name": "restricoes"
          }
        ],
        "values": []
      }
    ]
  },
  "requestId": "RaEyckn8IE2Y4AavyK3cK",
  "elapsedMilliseconds": 15,
  "status": {
    "message": "Ok",
    "code": "200",
    "errors": null
  }
}

🟠401R117 Invalid authorization data

🔴500E100 The request could not be processed

Content Extraction Distance [application/json]

Request

Request samples

Responses