Represents a detection of a field value in a form. A field is identified by a field_name, optionally component_name and component_type if the field belongs to a subcomponent. The bounding_box indicates the position of the detection. The content of the field is given by the value, and optionally an unnormalized_value and the unit.

interface AnnotationsDetection {
    boundingBox: AnnotationsBoundingBox;
    componentName?: string;
    componentType?: string;
    confidence?: number;
    fieldName: string;
    pageNumber?: number;
    unit?: string;
    value: string;
    valueUnnormalized?: string;
}

Properties

Bounding box of the detection area

componentName?: string

Name of subcomponent that the detection belongs to

componentType?: string

Type of subcomponent that the detection belongs to

confidence?: number

The confidence score for the primitive. It should be between 0 and 1.

0

1

fieldName: string

Name of field that has been detected

pageNumber?: number

The number of the page on which this annotation is located. The first page has number 1.

1

100000

unit?: string

The unit of the value field. Optional.

value: string

The value that has been detected

valueUnnormalized?: string

The value that has been detected, before normalization. Optional.