Package version:

Interface AnalyzeResult<Document>

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

Type Parameters

Hierarchy

Properties

apiVersion content documents? keyValuePairs? languages? modelId pages? paragraphs? styles? tables?

Properties

apiVersion

apiVersion: string

The service API version used to produce this result.

content

content: string

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).

Optional documents

documents?: Document[]

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

Optional keyValuePairs

keyValuePairs?: DocumentKeyValuePair[]

Extracted key-value pairs.

Optional languages

languages?: DocumentLanguage[]

Extracted text languages.

modelId

modelId: string

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

Optional pages

pages?: DocumentPage[]

Extracted pages.

Optional paragraphs

paragraphs?: DocumentParagraph[]

Extracted document paragraphs.

Optional styles

styles?: DocumentStyle[]

Extracted font styles.

Optional tables

tables?: DocumentTable[]

Extracted tables.

Settings

Member Visibility

Theme

Generated using TypeDoc