Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DocumentModel<Result>

Package version

A well-known model specification that supports extracting structured documents.

See the beginAnalyzeDocument method of DocumentAnalysisClient, which supports consuming these DocumentModel objects instead of model ID strings to provide stronger result types.

Type parameters

  • Result

Hierarchy

  • DocumentModel

Index

Properties

Properties

Optional apiVersion

apiVersion: FormRecognizerApiVersion

The API version of the model.

modelId

modelId: string

The unique ID of this model.

transformResult

transformResult: (input: AnalyzeResult) => Result

An associated transformation that is used to conver the base (weak) Result type to the strong version.

Type declaration

    • (input: AnalyzeResult): Result

    • Parameters

      • input: AnalyzeResult

      Returns Result

Generated using TypeDoc