Zum Hauptinhalt springen
Gibt das Layout der erfassten Daten zurück.

​
HTTP-Anfrage

GET https://api-{location-id}.flexicapture.com/v2/training/layout/{taskId}/{fileId}
Ersetzen Sie {location-id} durch Ihre unterstützte Region.

​
Pfadparameter

ParameterTypBeschreibung
taskIdpath, stringErforderlich. Task-ID.
fileIdpath, stringErforderlich. Quelldatei-ID.

​
Antwort

Im Erfolgsfall enthält der Antworttext eine Instanz von 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

FeldTypBeschreibung
task_idstringErforderlich. Task-ID.
file_idstringErforderlich. Datei-ID.
pagesArray[PageViewModel]Optional. Liste der Dokumentseiten.
fieldsArray[FieldViewModel]Erforderlich. Sammlung erfasster Felder.
tablesArray[TableViewModel]Optional. Sammlung erfasster Tabellen.

​
PageViewModel

FeldTypBeschreibung
idinteger($int32)Optional. Schreibgeschützt. Interne Seiten-ID.
numberinteger($int32)Optional. Schreibgeschützt. Seitennummer.
resolutioninteger($int32)Optional. Schreibgeschützt. DPI des Seitenbilds.
heightinteger($int32)Optional. Schreibgeschützt. Höhe des Seitenbilds.
widthinteger($int32)Optional. Schreibgeschützt. Breite des Seitenbilds.

​
FieldViewModel

FeldTypBeschreibung
namestringErforderlich. Name des Felds.
valuestringOptional. Extrahierter Wert.
rectangles[]object(RectangleViewModel)Erforderlich. Rechtecke des Felds.
cellobject(CellReferenceViewModel)Optional. Position der Zelle in der Tabelle.

​
TableViewModel

FeldTypBeschreibung
namestringErforderlich. Name der Tabelle.
regions[]object(RegionViewModel)Erforderlich. Regionen der Tabelle.

​
RectangleViewModel

FeldTypBeschreibung
page_idinteger($int32)Erforderlich. Interne Seiten-ID.
x1integer($int32)Erforderlich. Koordinate x1.
y1integer($int32)Erforderlich. Koordinate y1.
x2integer($int32)Erforderlich. Koordinate x2.
y2integer($int32)Erforderlich. Koordinate y2.

​
CellReferenceViewModel

FeldTypBeschreibung
table_namestringErforderlich. Name der referenzierten Tabelle.
row_numberinteger($int32)Erforderlich. Nummer der referenzierten Zeile.
column_namestringErforderlich. Name der referenzierten Spalte.

​
RegionViewModel

FeldTypBeschreibung
rectangles[]object(RectangleViewModel)Erforderlich. Rechteck des Felds.
columns[]object(ColumnViewModel)Erforderlich. Tabellenspalten.
horizontal_separators[]integer($int32)Erforderlich. Horizontale Tabellentrennlinie.

​
ColumnViewModel

FeldTypBeschreibung
leftinteger($int32)Erforderlich. Linke Begrenzung der Spalte.
rightinteger($int32)Erforderlich. Rechte Begrenzung der Spalte.