L'API Dataleon est structurée autour de REST. Notre API a des URLs orientées ressources prévisibles, accepte des corps de requête encodés en formulaire, renvoie des réponses encodées en JSON et utilise des codes de réponse HTTP standard, l'authentification et les méthodes HTTP.
Identifiants de demande
Chaque demande d'API a un identifiant de demande associé. Vous pouvez trouver cette valeur dans les en-têtes de réponse, sous Request-Id. Vous pouvez également trouver les identifiants de demande dans les URL des journaux de demande individuels dans votre console Dataleon.
Si vous avez besoin de nous contacter au sujet d'une demande spécifique, fournir l'identifiant de demande assurera une résolution la plus rapide possible.
Champs disponibles
|
Field |
Type |
Description |
|
blocks |
Array |
List of raw block text extracted by OCR |
|
fulltext |
Text |
Raw text |
|
entities |
Array |
Keys-pairs values cleaned from document or image |
|
class |
Array |
Classification type of document |
|
tables |
Array |
Tables extracted with columns and rows |
|
metadata |
Object |
General information on document and request
|
|
validations |
Array |
Lists of validations data |
{
"blocks": [
{
"id": uuid,
"text": string,
"confidence": number,
"bounding_box": [
[number, number],
[number, number],
[number, number],
[number, number]
]
},
],
"fulltext": string,
"entities": [
{
"id": uuid,
"name": string,
"text": string,
"value": string | float,
"type": string,
"color": string,
"confidence": number,
"page": number,
"document_number": number,
"document_name": number,
"bounding_box": [
[number, number],
[number, number],
[number, number],
[number, number]
]
},
],
"validations": [
{
"id": uuid,
"name": string,
"validate": boolean,
"code": string,
"page": number,
"document_number": number,
"document_name": number
},
],
"class": [
{
"id": uuid,
"name": string,,
"color": string,
"confidence": number,
"page": number,
"document_number": number,
"document_name": number
},
],
"tables": [
{
"blocks": [
{
"id": uuid,
"text": string,
"confidence": number,
"bounding_box": [
[number, number],
[number, number],
[number, number],
[number, number]
]
}
],
"fulltext": [string],
"id": uuid,
"page": number,
"name": string,
"color": string,
"document_number": number,
"document_name": number,
"header_names": [string],
"header_widths": [number],
"rows": [
{
"id": uuid,
"bounding_box": [
[number, number],
[number, number],
[number, number],
[number, number]
],
"cells": [
{
"id": uuid,
"name": string,
"type": string,
"color": string,
"text": string,
"value": string | float,
"confidence": number,
"bounding_box": [
[number, number],
[number, number],
[number, number],
[number, number]
]
}
]
}
]
}
],
"metadata": {
"request_id": string,
"status": string,
"total_pages": number,
"task_id": uuid,
"processing_time": string
},
}