AnalyzeResult interface

Package:

@azure/ai-form-recognizer

The result of an analysis operation. The type of the Document may be determined by the model used to perform the analysis.

Extends

AnalyzeResultCommon

Properties

documents	Extracted documents (instances of any of the model's document types and corresponding field schemas).
keyValuePairs	Extracted key-value pairs.
languages	Extracted text languages.
pages	Extracted pages.
paragraphs	Extracted document paragraphs.
styles	Extracted font styles.
tables	Extracted tables.

Inherited Properties

apiVersion	The service API version used to produce this result.
content	A string representation of all textual and visual elements in the input, concatenated by reading order (the order in which the service "reads" or extracts the textual and visual content from the document).
modelId	The unique ID of the model that was used to produce this result.

Property Details

documents

Extracted documents (instances of any of the model's document types and corresponding field schemas).

documents?: Document[]

Property Value

Document[]

keyValuePairs

Extracted key-value pairs.

keyValuePairs?: DocumentKeyValuePair[]

Property Value

DocumentKeyValuePair[]

languages

Extracted text languages.

languages?: DocumentLanguage[]

Property Value

DocumentLanguage[]

pages

Extracted pages.

pages?: DocumentPage[]

Property Value

DocumentPage[]

paragraphs

Extracted document paragraphs.

paragraphs?: DocumentParagraph[]

Property Value

DocumentParagraph[]

styles

Extracted font styles.

styles?: DocumentStyle[]

Property Value

DocumentStyle[]

tables

Extracted tables.

tables?: DocumentTable[]

Property Value

DocumentTable[]

Inherited Property Details

apiVersion

The service API version used to produce this result.

apiVersion: string

Property Value

string

Inherited From AnalyzeResultCommon.apiVersion

content

A string representation of all textual and visual elements in the input, concatenated by reading order (the order in which the service "reads" or extracts the textual and visual content from the document).

content: string

Property Value

string

Inherited From AnalyzeResultCommon.content

modelId

The unique ID of the model that was used to produce this result.

modelId: string

Property Value

string

Inherited From AnalyzeResultCommon.modelId