Captured Field

Overview

Model Name: CapturedField

Details of a particular field, as captured from the submitted document.

Properties

bbox

Type
List of numbers
Required
true
Min. Item Count
4
Max. Item Count
4

The coordinates of the bounding box (i.e. rectangle) that encloses the original page's text data, in units of pixels. If the document was provided as a PDF, we assume a DPI of 300. Coordinates are given in the order of distances from the left, top, bottom, and right edges. The coordinates of (0, 0) represent the top-left corner of the document.

children

Type
Map of arrays
Required
true
Min. Item Count
0

Fields that are nested within this one, if any. This field follows the same structure as the owning CapturedDocument's fields attribute. Used with certain form types that have complicated structures. Will be empty if this field does not have any children.

confidence

Type
Double (double)
Required
true
Min. Value
0
Max. Value
1

Our model's confidence in this field's captured data, ranged between 0 and 1. Higher values indicate better predictions.

page_index

Type
Integer
Required
true
Min. Value
0

The zero-indexed page of the original Document from which the captured data was extracted. This index is relative to the uploaded file, not to the Document within the file. This value will come from one of the indexes in the parent object's page_indexes field.

value

Type
String
Required
true

The value of this form field, as captured from the original document. Will always be a string, regardless of the semantics of the field. May be empty if the original form field was empty.