Layout

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

Parameter	Typ	Beschreibung
taskId	path, string	Erforderlich. Task-ID.
fileId	path, string	Erforderlich. 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

Feld	Typ	Beschreibung
task_id	string	Erforderlich. Task-ID.
file_id	string	Erforderlich. Datei-ID.
pages	Array[PageViewModel]	Optional. Liste der Dokumentseiten.
fields	Array[FieldViewModel]	Erforderlich. Sammlung erfasster Felder.
tables	Array[TableViewModel]	Optional. Sammlung erfasster Tabellen.

​

PageViewModel

Feld	Typ	Beschreibung
id	integer($int32)	Optional. Schreibgeschützt. Interne Seiten-ID.
number	integer($int32)	Optional. Schreibgeschützt. Seitennummer.
resolution	integer($int32)	Optional. Schreibgeschützt. DPI des Seitenbilds.
height	integer($int32)	Optional. Schreibgeschützt. Höhe des Seitenbilds.
width	integer($int32)	Optional. Schreibgeschützt. Breite des Seitenbilds.

​

FieldViewModel

Feld	Typ	Beschreibung
name	string	Erforderlich. Name des Felds.
value	string	Optional. Extrahierter Wert.
rectangles[]	object(RectangleViewModel)	Erforderlich. Rechtecke des Felds.
cell	object(CellReferenceViewModel)	Optional. Position der Zelle in der Tabelle.

​

TableViewModel

Feld	Typ	Beschreibung
name	string	Erforderlich. Name der Tabelle.
regions[]	object(RegionViewModel)	Erforderlich. Regionen der Tabelle.

​

RectangleViewModel

Feld	Typ	Beschreibung
page_id	integer($int32)	Erforderlich. Interne Seiten-ID.
x1	integer($int32)	Erforderlich. Koordinate x1.
y1	integer($int32)	Erforderlich. Koordinate y1.
x2	integer($int32)	Erforderlich. Koordinate x2.
y2	integer($int32)	Erforderlich. Koordinate y2.

​

CellReferenceViewModel

Feld	Typ	Beschreibung
table_name	string	Erforderlich. Name der referenzierten Tabelle.
row_number	integer($int32)	Erforderlich. Nummer der referenzierten Zeile.
column_name	string	Erforderlich. Name der referenzierten Spalte.

​

RegionViewModel

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

​

ColumnViewModel

Feld	Typ	Beschreibung
left	integer($int32)	Erforderlich. Linke Begrenzung der Spalte.
right	integer($int32)	Erforderlich. Rechte Begrenzung der Spalte.