Layout

Devuelve el Layout de los datos capturados.

​

Solicitud HTTP

GET https://api-{location-id}.flexicapture.com/v2/training/layout/{taskId}/{fileId}

Reemplace {location-id} por la ubicación admitida.

​

Parámetros de ruta

Parámetro	Tipo	Descripción
taskId	ruta, cadena	Obligatorio. ID de la tarea.
fileId	ruta, cadena	Obligatorio. ID del archivo de origen.

​

Respuesta

Si la operación se realiza correctamente, el cuerpo de la respuesta contiene una instancia 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

Campo	Tipo	Descripción
task_id	cadena	Obligatorio. ID de la tarea.
file_id	cadena	Obligatorio. ID del archivo.
pages	Array[PageViewModel]	Opcional. Lista de páginas del documento.
fields	Array[FieldViewModel]	Obligatorio. Conjunto de campos capturados.
tables	Array[TableViewModel]	Opcional. Conjunto de tablas capturadas.

​

PageViewModel

Campo	Tipo	Descripción
id	integer($int32)	Opcional. De solo lectura. ID interno de la página.
number	integer($int32)	Opcional. De solo lectura. Número de página.
resolution	integer($int32)	Opcional. De solo lectura. PPP de la imagen de la página.
height	integer($int32)	Opcional. De solo lectura. Altura de la imagen de la página.
width	integer($int32)	Opcional. De solo lectura. Ancho de la imagen de la página.

​

FieldViewModel

Campo	Tipo	Descripción
name	cadena	Obligatorio. Nombre del campo.
value	cadena	Opcional. Valor extraído.
rectangles[]	object(RectangleViewModel)	Obligatorio. Rectángulos del campo.
cell	object(CellReferenceViewModel)	Opcional. Posición de la celda en la tabla.

​

TableViewModel

Campo	Tipo	Descripción
name	cadena	Obligatorio. Nombre de la tabla.
regions[]	object(RegionViewModel)	Obligatorio. Regiones de la tabla.

​

RectangleViewModel

Campo	Tipo	Descripción
page_id	integer($int32)	Obligatorio. ID interno de la página.
x1	integer($int32)	Obligatorio. Coordenada de x1.
y1	integer($int32)	Obligatorio. Coordenada de y1.
x2	integer($int32)	Obligatorio. Coordenada de x2.
y2	integer($int32)	Obligatorio. Coordenada de y2.

​

CellReferenceViewModel

campo	Tipo	Descripción
table_name	cadena	Obligatorio. Nombre de la tabla a la que se hace referencia.
row_number	integer($int32)	Obligatorio. Número de la fila a la que se hace referencia.
column_name	cadena	Obligatorio. Nombre de la columna a la que se hace referencia.

​

RegionViewModel

Campo	Tipo	Descripción
rectangles[]	object(RectangleViewModel)	Obligatorio. Rectángulo del campo.
columns[]	object(ColumnViewModel)	Obligatorio. Columnas de la tabla.
horizontal_separators[]	integer($int32)	Obligatorio. Separador horizontal de la tabla.

​

ColumnViewModel

Campo	Tipo	Descripción
left	integer($int32)	Obligatorio. Límite izquierdo de la columna.
right	integer($int32)	Obligatorio. Límite derecho de la columna.