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

  • AnalyzeResult

Index

Properties

apiVersion

API version used to produce this result. The service API version used to produce this result.

Example: "2020-09-30-preview"

content

content: string

Concatenate string representation of all textual and visual elements in reading order. 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 anc visual content from the document).

Optional documents

documents: Document[]

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

Optional entities

entities: DocumentEntity[]

Extracted entities. Extracted entities.

Optional keyValuePairs

keyValuePairs: DocumentKeyValuePair[]

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

modelId

modelId: string

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

pages

pages: DocumentPage[]

Analyzed pages. Extracted pages.

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