Saltar al contenido principal
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ámetroTipoDescripción
taskIdruta, cadenaObligatorio. ID de la tarea.
fileIdruta, cadenaObligatorio. 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

CampoTipoDescripción
task_idcadenaObligatorio. ID de la tarea.
file_idcadenaObligatorio. ID del archivo.
pagesArray[PageViewModel]Opcional. Lista de páginas del documento.
fieldsArray[FieldViewModel]Obligatorio. Conjunto de campos capturados.
tablesArray[TableViewModel]Opcional. Conjunto de tablas capturadas.

PageViewModel

CampoTipoDescripción
idinteger($int32)Opcional. De solo lectura. ID interno de la página.
numberinteger($int32)Opcional. De solo lectura. Número de página.
resolutioninteger($int32)Opcional. De solo lectura. PPP de la imagen de la página.
heightinteger($int32)Opcional. De solo lectura. Altura de la imagen de la página.
widthinteger($int32)Opcional. De solo lectura. Ancho de la imagen de la página.

FieldViewModel

CampoTipoDescripción
namecadenaObligatorio. Nombre del campo.
valuecadenaOpcional. Valor extraído.
rectangles[]object(RectangleViewModel)Obligatorio. Rectángulos del campo.
cellobject(CellReferenceViewModel)Opcional. Posición de la celda en la tabla.

TableViewModel

CampoTipoDescripción
namecadenaObligatorio. Nombre de la tabla.
regions[]object(RegionViewModel)Obligatorio. Regiones de la tabla.

RectangleViewModel

CampoTipoDescripción
page_idinteger($int32)Obligatorio. ID interno de la página.
x1integer($int32)Obligatorio. Coordenada de x1.
y1integer($int32)Obligatorio. Coordenada de y1.
x2integer($int32)Obligatorio. Coordenada de x2.
y2integer($int32)Obligatorio. Coordenada de y2.

CellReferenceViewModel

campoTipoDescripción
table_namecadenaObligatorio. Nombre de la tabla a la que se hace referencia.
row_numberinteger($int32)Obligatorio. Número de la fila a la que se hace referencia.
column_namecadenaObligatorio. Nombre de la columna a la que se hace referencia.

RegionViewModel

CampoTipoDescripció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

CampoTipoDescripción
leftinteger($int32)Obligatorio. Límite izquierdo de la columna.
rightinteger($int32)Obligatorio. Límite derecho de la columna.