Train

Train a data capture model.

HTTP request

POST https://api-{location-id}.flexicapture.com/v2/training

where {location-id} is the supported location.

Request body

The request body contains data with the following structure:

JSON representation

{

 "task_id": "string",

 "file_id": "string",

 "fields": [

   {

     "name": "string",

     "rectangles": [

       {

         "page_id": 0,

         "x1": 0,

         "y1": 0,

         "x2": 0,

         "y2": 0

       }

     ]

   }

 ]

}

Fields
model

body, object(TrainingCommandViewModel)

Required. Model used for training.

TrainingCommandViewModel
task_id

string

Required. Task ID.

file_id

string

Required. File ID.

fields[]

object(FieldCommandViewModel)

Required. Set of fields for train.

FieldCommandViewModel
name

string

Required. Field name.

rectangles[]

object(RectangleViewModel)

Required. Field rectangles.

RectangleViewModel
page_id

integer($int32)

Required. Internal page ID.

x1

integer($int32)

Required. Coordinate of x1.

y1

integer($int32)

Required. Coordinate of y1.

x2

integer($int32)

Required. Coordinate of x2.

y2

integer($int32)

Required. Coordinate of y2.

Response

If successful, the server returns a 204 OK HTTP status.

5/18/2023 9:30:10 AM

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.