Share via

DocumentModel interface

Package:
@azure/ai-form-recognizer

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.

Properties

apiVersion

The API version of the model.
modelId

The unique ID of this model.
transformResult

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

Property Details

apiVersion

The API version of the model.

apiVersion?: string

Property Value

string

modelId

The unique ID of this model.

modelId: string

Property Value

string

transformResult

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

transformResult: (input: AnalyzeResult<AnalyzedDocument>) => Result

Property Value

(input: AnalyzeResult<AnalyzedDocument>) => Result