AnalyzedDocument interface

Package:

@azure/ai-form-recognizer

An extracted document object.

An AnalyzedDocument is an instance of one of the document types within a model. Its fields correspond to the field schema of the document type.

Properties

boundingRegions	Bounding regions covering the document.
confidence	The service's confidence that it has correctly extracted the document.
docType	The type of the document that was extracted. A model can have multiple document types (for example, in a composed model), so this property indicates which document type the fields of this document correspond to.
fields	The extracted fields, which correspond to the document type's field schema.
spans	Locations of the document's elements in the content text (reading-order-concatenated content).

Property Details

boundingRegions

Bounding regions covering the document.

boundingRegions?: BoundingRegion[]

Property Value

BoundingRegion[]

confidence

The service's confidence that it has correctly extracted the document.

confidence: number

Property Value

number

docType

The type of the document that was extracted. A model can have multiple document types (for example, in a composed model), so this property indicates which document type the fields of this document correspond to.

docType: string

Property Value

string

fields

The extracted fields, which correspond to the document type's field schema.

fields: {[field: string]: DocumentField}

Property Value

{[field: string]: DocumentField}

spans

Locations of the document's elements in the content text (reading-order-concatenated content).

spans: DocumentSpan[]

Property Value

DocumentSpan[]