Requête HTTP
GET https://api-{location-id}.flexicapture.com/v2/training/layout/{taskId}/{fileId}
{location-id} par l’emplacement pris en charge.
Paramètres du chemin d’accès
| Paramètre | Type | Description |
|---|---|---|
taskId | path, string | Obligatoire. ID de tâche. |
fileId | path, string | Obligatoire. ID du fichier source. |
Réponse
TrainingDataViewModel.
{
"task_id": "string",
"file_id": "string",
"pages": [
{
"id": 0,
"number": 0,
"resolution": 0,
"height": 0,
"width": 0
}
],
"fields": [
{
"name": "string",
"value": "string",
"rectangles": [
{
"page_id": 0,
"x1": 0,
"y1": 0,
"x2": 0,
"y2": 0
}
],
"cell": {
"table_name": "string",
"row_number": 0,
"column_name": "string"
}
}
],
"tables": [
{
"name": "string",
"regions": [
{
"rectangles": [
{
"page_id": 0,
"x1": 0,
"y1": 0,
"x2": 0,
"y2": 0
}
],
"columns": [
{
"left": 0,
"right": 0
}
],
"horizontal_separators": [
0
]
}
]
}
]
}
TrainingDataViewModel
| Champ | Type | Description |
|---|---|---|
task_id | string | Obligatoire. ID de tâche. |
file_id | string | Obligatoire. ID du fichier. |
pages | Array[PageViewModel] | Facultatif. Liste des pages du document. |
fields | Array[FieldViewModel] | Obligatoire. Ensemble des champs capturés. |
tables | Array[TableViewModel] | Facultatif. Ensemble des tableaux capturés. |
PageViewModel
| Champ | Type | Description |
|---|---|---|
id | integer($int32) | Facultatif. En lecture seule. ID interne de la page. |
number | integer($int32) | Facultatif. En lecture seule. Numéro de page. |
resolution | integer($int32) | Facultatif. En lecture seule. Résolution en PPP de l’image de la page. |
height | integer($int32) | Facultatif. En lecture seule. Hauteur de l’image de la page. |
width | integer($int32) | Facultatif. En lecture seule. Largeur de l’image de la page. |
FieldViewModel
| Champ | Type | Description |
|---|---|---|
name | string | Obligatoire. Nom du champ. |
value | string | Facultatif. Valeur extraite. |
rectangles[] | object(RectangleViewModel) | Obligatoire. Rectangles du champ. |
cell | object(CellReferenceViewModel) | Facultatif. Position de la cellule dans le tableau. |
TableViewModel
| Champ | Type | Description |
|---|---|---|
name | string | Obligatoire. Nom du tableau. |
regions[] | object(RegionViewModel) | Obligatoire. Régions du tableau. |
RectangleViewModel
| Champ | Type | Description |
|---|---|---|
page_id | integer($int32) | Obligatoire. ID interne de la page. |
x1 | integer($int32) | Obligatoire. Coordonnée x1. |
y1 | integer($int32) | Obligatoire. Coordonnée y1. |
x2 | integer($int32) | Obligatoire. Coordonnée x2. |
y2 | integer($int32) | Obligatoire. Coordonnée y2. |
CellReferenceViewModel
| Champ | Type | Description |
|---|---|---|
table_name | string | Obligatoire. Nom du tableau référencé. |
row_number | integer($int32) | Obligatoire. Numéro de la ligne référencée. |
column_name | string | Obligatoire. Nom de la colonne référencée. |
RegionViewModel
| Champ | Type | Description |
|---|---|---|
rectangles[] | object(RectangleViewModel) | Obligatoire. Rectangle du champ. |
columns[] | object(ColumnViewModel) | Obligatoire. Colonnes du tableau. |
horizontal_separators[] | integer($int32) | Obligatoire. Séparateur horizontal du tableau. |
ColumnViewModel
| Champ | Type | Description |
|---|---|---|
left | integer($int32) | Obligatoire. Limite gauche de la colonne. |
right | integer($int32) | Obligatoire. Limite droite de la colonne. |