Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DocumentObjectField<Properties>

Package version

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

Type parameters

  • Properties

Hierarchy

Index

Properties

Optional boundingRegions

boundingRegions: BoundingRegion[]

Bounding regions covering the field.

Optional confidence

confidence: undefined | number

Confidence of correctly extracting the field.

Optional content

content: undefined | 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.

Generated using TypeDoc