Passer au contenu principal
Renvoie la structure des données capturées.

​
Requête HTTP

GET https://api-{location-id}.flexicapture.com/v2/training/layout/{taskId}/{fileId}
Remplacez {location-id} par l’emplacement pris en charge.

​
Paramètres du chemin d’accès

ParamètreTypeDescription
taskIdpath, stringObligatoire. ID de tâche.
fileIdpath, stringObligatoire. ID du fichier source.

​
Réponse

En cas de succès, le corps de la réponse contient une instance de 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

ChampTypeDescription
task_idstringObligatoire. ID de tâche.
file_idstringObligatoire. ID du fichier.
pagesArray[PageViewModel]Facultatif. Liste des pages du document.
fieldsArray[FieldViewModel]Obligatoire. Ensemble des champs capturés.
tablesArray[TableViewModel]Facultatif. Ensemble des tableaux capturés.

​
PageViewModel

ChampTypeDescription
idinteger($int32)Facultatif. En lecture seule. ID interne de la page.
numberinteger($int32)Facultatif. En lecture seule. Numéro de page.
resolutioninteger($int32)Facultatif. En lecture seule. Résolution en PPP de l’image de la page.
heightinteger($int32)Facultatif. En lecture seule. Hauteur de l’image de la page.
widthinteger($int32)Facultatif. En lecture seule. Largeur de l’image de la page.

​
FieldViewModel

ChampTypeDescription
namestringObligatoire. Nom du champ.
valuestringFacultatif. Valeur extraite.
rectangles[]object(RectangleViewModel)Obligatoire. Rectangles du champ.
cellobject(CellReferenceViewModel)Facultatif. Position de la cellule dans le tableau.

​
TableViewModel

ChampTypeDescription
namestringObligatoire. Nom du tableau.
regions[]object(RegionViewModel)Obligatoire. Régions du tableau.

​
RectangleViewModel

ChampTypeDescription
page_idinteger($int32)Obligatoire. ID interne de la page.
x1integer($int32)Obligatoire. Coordonnée x1.
y1integer($int32)Obligatoire. Coordonnée y1.
x2integer($int32)Obligatoire. Coordonnée x2.
y2integer($int32)Obligatoire. Coordonnée y2.

​
CellReferenceViewModel

ChampTypeDescription
table_namestringObligatoire. Nom du tableau référencé.
row_numberinteger($int32)Obligatoire. Numéro de la ligne référencée.
column_namestringObligatoire. Nom de la colonne référencée.

​
RegionViewModel

ChampTypeDescription
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

ChampTypeDescription
leftinteger($int32)Obligatoire. Limite gauche de la colonne.
rightinteger($int32)Obligatoire. Limite droite de la colonne.