AnalyzeResultOutput interface

Package:

@azure-rest/ai-document-intelligence

Document analysis result.

Properties

apiVersion	API version used to produce this result.
content	Concatenate string representation of all textual and visual elements in reading order.
contentFormat	Format of the analyze result top-level content. Possible values: "text", "markdown"
documents	Extracted documents.
figures	Extracted figures.
keyValuePairs	Extracted key-value pairs.
languages	Detected languages.
modelId	Document model ID used to produce this result.
pages	Analyzed pages.
paragraphs	Extracted paragraphs.
sections	Extracted sections.
stringIndexType	Method used to compute string offset and length. Possible values: "textElements", "unicodeCodePoint", "utf16CodeUnit"
styles	Extracted font styles.
tables	Extracted tables.
warnings	List of warnings encountered.

Property Details

apiVersion

API version used to produce this result.

apiVersion: string

Property Value

string

content

Concatenate string representation of all textual and visual elements in reading order.

content: string

Property Value

string

contentFormat

Format of the analyze result top-level content.

Possible values: "text", "markdown"

contentFormat?: string

Property Value

string

documents

Extracted documents.

documents?: DocumentOutput[]

Property Value

DocumentOutput[]

figures

Extracted figures.

figures?: DocumentFigureOutput[]

Property Value

DocumentFigureOutput[]

keyValuePairs

Extracted key-value pairs.

keyValuePairs?: DocumentKeyValuePairOutput[]

Property Value

DocumentKeyValuePairOutput[]

languages

Detected languages.

languages?: DocumentLanguageOutput[]

Property Value

DocumentLanguageOutput[]

modelId

Document model ID used to produce this result.

modelId: string

Property Value

string

pages

Analyzed pages.

pages: DocumentPageOutput[]

Property Value

DocumentPageOutput[]

paragraphs

Extracted paragraphs.

paragraphs?: DocumentParagraphOutput[]

Property Value

DocumentParagraphOutput[]

sections

Extracted sections.

sections?: DocumentSectionOutput[]

Property Value

DocumentSectionOutput[]

stringIndexType

Method used to compute string offset and length.

Possible values: "textElements", "unicodeCodePoint", "utf16CodeUnit"

stringIndexType: string

Property Value

string

styles

Extracted font styles.

styles?: DocumentStyleOutput[]

Property Value

DocumentStyleOutput[]

tables

Extracted tables.

tables?: DocumentTableOutput[]

Property Value

DocumentTableOutput[]

warnings

List of warnings encountered.

warnings?: WarningOutput[]

Property Value

WarningOutput[]