Package version:

Interface DocumentObjectField<Properties>

A DocumentField that consists of several named properties that have their own DocumentField values.

Type Parameters

  • Properties = {
        [k: string]: DocumentField | undefined;
    }

Hierarchy

Properties

boundingRegions? confidence? content? kind properties spans?

Properties

Optional boundingRegions

boundingRegions?: BoundingRegion[]

Bounding regions covering the field.

Optional confidence

confidence?: number

Confidence of correctly extracting the field.

Optional content

content?: string

The verbatim extracted text content of the field.

kind

kind: "object"

Field kind: "object".

properties

properties: Properties

The extracted object properties. Each property of this object is, itself, a nested DocumentField.

Optional spans

spans?: DocumentSpan[]

Location of the field in the reading order concatenated content.

Settings

Member Visibility

Theme

Generated using TypeDoc