Skip to main content
GET
/
v1
/
projects
/
{project_id}
/
iterations
/
{iteration_id}
/
documents
/
{document_id}
/
distances
Get Iteration Document Distances
curl --request GET \
  --url https://api.retab.com/v1/projects/{project_id}/iterations/{iteration_id}/documents/{document_id}/distances
{
  "flat_reference_elements": {},
  "per_element_similarity": {},
  "total_similarity": 123,
  "aligned_flat_reference_elements": {},
  "aligned_per_element_similarity": {},
  "aligned_total_similarity": 123
}

Authorizations

​
Api-Key
string
header
required

Path Parameters

​
project_id
string
required
​
iteration_id
string
required
​
document_id
string
required

Query Parameters

​
metric_type
enum<string>
default:levenshtein

Type of similarity metric to use

Available options:
levenshtein,
jaccard,
hamming

Response

Successful Response

​
flat_reference_elements
object
required
​
per_element_similarity
object
required
​
total_similarity
number
required
​
aligned_flat_reference_elements
object
required
​
aligned_per_element_similarity
object
required
​
aligned_total_similarity
number
required