Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AnalyzeResult<Document>

Package version

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

Type parameters

  • Document

Hierarchy

Index

Properties

apiVersion

apiVersion: ApiVersion

API version used to produce this result.

content

content: string

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

Optional documents

documents: Document[]

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

Optional keyValuePairs

keyValuePairs: DocumentKeyValuePair[]

Extracted key-value pairs. Extracted key-value pairs.

Optional languages

languages: DocumentLanguage[]

Detected languages. Extracted text languages.

modelId

modelId: string

Document model ID used to produce this result.

pages

pages: DocumentPage[]

Analyzed pages. Extracted pages.

Optional paragraphs

paragraphs: DocumentParagraph[]

Extracted paragraphs. Extracted document paragraphs.

stringIndexType

stringIndexType: StringIndexType

Method used to compute string offset and length.

Optional styles

styles: DocumentStyle[]

Extracted font styles. Extracted font styles.

Optional tables

tables: DocumentTable[]

Extracted tables. Extracted tables.

Generated using TypeDoc