Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/ai-form-recognizer

Package version

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AnalysisPoller

AnalysisPoller<Result>: PollerLike<DocumentAnalysisPollOperationState<Result>, Result>

A long-running operation (poller) that tracks the state of an analysis operation, eventually producing the result type that corresponds to the model.

Type parameters

  • Result

AnalyzeResultOperationStatus

AnalyzeResultOperationStatus: "notStarted" | "running" | "failed" | "succeeded"

Defines values for AnalyzeResultOperationStatus.

ApiVersion

ApiVersion: string

Defines values for ApiVersion.
KnownApiVersion can be used interchangeably with ApiVersion, this enum contains the known values that the service supports.

Known values supported by the service

2021-09-30-preview

BusinessCard

BusinessCard: ReifyPrebuiltSchema<typeof BusinessCardSchema>

The type of a document extracted using the prebuilt business card model (PrebuiltModels.BusinessCard).

CancellationToken

CancellationToken: Parameters[0]

ContentType

ContentType: "application/octet-stream" | "application/pdf" | "image/bmp" | "image/jpeg" | "image/png" | "image/tiff"

Defines values for ContentType.

DocumentFieldType

DocumentFieldType: string

Defines values for DocumentFieldType.
KnownDocumentFieldType can be used interchangeably with DocumentFieldType, this enum contains the known values that the service supports.

Known values supported by the service

string
date
time
phoneNumber
number
integer
selectionMark
countryRegion
signature
array
object

DocumentSignatureType

DocumentSignatureType: string

Defines values for DocumentSignatureType.
KnownDocumentSignatureType can be used interchangeably with DocumentSignatureType, this enum contains the known values that the service supports.

Known values supported by the service

signed
unsigned

DocumentTableCellKind

DocumentTableCellKind: string

Defines values for DocumentTableCellKind.
KnownDocumentTableCellKind can be used interchangeably with DocumentTableCellKind, this enum contains the known values that the service supports.

Known values supported by the service

content
rowHeader
columnHeader
stubHead
description

FormRecognizerApiVersion

FormRecognizerApiVersion: "2021-09-30-preview"

Valid values of the Form Recognizer service REST API version.

FormRecognizerRequestBody

FormRecognizerRequestBody: NodeJS.ReadableStream | Blob | ArrayBuffer | ArrayBufferView

A request input that can be uploaded to the Form Recognizer service.

GeneratedClientAnalyzeDocumentResponse

GeneratedClientAnalyzeDocumentResponse: GeneratedClientAnalyzeDocumentHeaders

Contains response data for the analyzeDocument operation.

GeneratedClientAuthorizeCopyDocumentModelResponse

GeneratedClientAuthorizeCopyDocumentModelResponse: CopyAuthorization

Contains response data for the authorizeCopyDocumentModel operation.

GeneratedClientBuildDocumentModelResponse

GeneratedClientBuildDocumentModelResponse: GeneratedClientBuildDocumentModelHeaders

Contains response data for the buildDocumentModel operation.

GeneratedClientComposeDocumentModelResponse

GeneratedClientComposeDocumentModelResponse: GeneratedClientComposeDocumentModelHeaders

Contains response data for the composeDocumentModel operation.

GeneratedClientCopyDocumentModelToResponse

GeneratedClientCopyDocumentModelToResponse: GeneratedClientCopyDocumentModelToHeaders

Contains response data for the copyDocumentModelTo operation.

GeneratedClientGetAnalyzeDocumentResultResponse

GeneratedClientGetAnalyzeDocumentResultResponse: AnalyzeResultOperation

Contains response data for the getAnalyzeDocumentResult operation.

GeneratedClientGetInfoResponse

GeneratedClientGetInfoResponse: GetInfoResponse

Contains response data for the getInfo operation.

GeneratedClientGetModelResponse

GeneratedClientGetModelResponse: ModelInfo

Contains response data for the getModel operation.

GeneratedClientGetModelsNextResponse

GeneratedClientGetModelsNextResponse: GetModelsResponse

Contains response data for the getModelsNext operation.

GeneratedClientGetModelsResponse

GeneratedClientGetModelsResponse: GetModelsResponse

Contains response data for the getModels operation.

GeneratedClientGetOperationResponse

GeneratedClientGetOperationResponse: GetOperationResponse

Contains response data for the getOperation operation.

GeneratedClientGetOperationsNextResponse

GeneratedClientGetOperationsNextResponse: GetOperationsResponse

Contains response data for the getOperationsNext operation.

GeneratedClientGetOperationsResponse

GeneratedClientGetOperationsResponse: GetOperationsResponse

Contains response data for the getOperations operation.

GetOperationResponse

GetOperationResponse: OperationInfo & { error?: ErrorModel; result?: ModelInfo }

Get Operation response object.

IdentityDocument

IdentityDocument: ReifyPrebuiltSchema<typeof IdentityDocumentSchema>

The type of a document extracted using the prebuilt identity document model (PrebuiltModels.IdentityDocument).

Invoice

Invoice: ReifyPrebuiltSchema<typeof InvoiceSchema>

The type of a document extracted using the prebuilt invoice model (PrebuiltModels.Invoice).

LengthUnit

LengthUnit: string

Defines values for LengthUnit.
KnownLengthUnit can be used interchangeably with LengthUnit, this enum contains the known values that the service supports.

Known values supported by the service

pixel
inch

ModelInfo

ModelInfo: ModelSummary & { docTypes?: undefined | {} }

Model info.

OperationKind

OperationKind: string

Defines values for OperationKind.
KnownOperationKind can be used interchangeably with OperationKind, this enum contains the known values that the service supports.

Known values supported by the service

documentModelBuild
documentModelCompose
documentModelCopyTo

OperationStatus

OperationStatus: "notStarted" | "running" | "failed" | "succeeded" | "canceled"

Defines values for OperationStatus.

Receipt

Receipt: ReifyPrebuiltSchema<typeof ReceiptSchema>

The type of a document extracted using the prebuilt receipt model (PrebuiltModels.Receipt).

SelectionMarkState

SelectionMarkState: string

Defines values for SelectionMarkState.
KnownSelectionMarkState can be used interchangeably with SelectionMarkState, this enum contains the known values that the service supports.

Known values supported by the service

selected
unselected

StringIndexType

StringIndexType: typeof StringIndexType[keyof typeof StringIndexType]

Defines values for StringIndexType.
KnownStringIndexType can be used interchangeably with StringIndexType, this enum contains the known values that the service supports.

Known values supported by the service

textElements
unicodeCodePoint
utf16CodeUnit Valid string index types supported by the Form Recognizer service and SDK clients.

TrainingPoller

TrainingPoller: PollerLike<TrainingPollOperationState, ModelInfo>

A long-running operation (poller) that tracks the state of a model creation operation, eventually producing a ModelInfo.

Variables

Const APIM_SUBSCRIPTION_KEY_HEADER

APIM_SUBSCRIPTION_KEY_HEADER: "Ocp-Apim-Subscription-Key" = "Ocp-Apim-Subscription-Key"

Const DEFAULT_POLLING_INTERVAL

DEFAULT_POLLING_INTERVAL: 5000 = 5000

Const FormRecognizerApiVersion

FormRecognizerApiVersion: { Latest: "2021-09-30-preview"; Preview: "2021-09-30-preview" } = {/*** The newest version of the service known to be supported by the client (default).** If using a beta package version, this will be identical to the latest preview version. Otherwise, it will be* identical to the latest stable version.*/Latest: "2021-09-30-preview",/*** The newest preview version of the service known to be supported by the client.*/Preview: "2021-09-30-preview",// Stable: when we have a GA version and a stable REST API} as const

Supported and common values of FormRecognizerApiVersion.

Type declaration

  • Latest: "2021-09-30-preview"

    The newest version of the service known to be supported by the client (default).

    If using a beta package version, this will be identical to the latest preview version. Otherwise, it will be identical to the latest stable version.

  • Preview: "2021-09-30-preview"

    The newest preview version of the service known to be supported by the client.

Const INTERRUPTED

INTERRUPTED: "The local operation (timer) was interrupted or cancelled." = "The local operation (timer) was interrupted or cancelled."

Const SERIALIZER

SERIALIZER: any = createSerializer(Mappers, false)

Const StringIndexType

StringIndexType: { UnicodeCodePoint: "unicodeCodePoint"; Utf16CodeUnit: "utf16CodeUnit" } = {/*** UTF-16 code units*/Utf16CodeUnit: "utf16CodeUnit",/*** Unicode code points*/UnicodeCodePoint: "unicodeCodePoint",} as const

Supported values of StringIndexType.

Type declaration

  • UnicodeCodePoint: "unicodeCodePoint"

    Unicode code points

  • Utf16CodeUnit: "utf16CodeUnit"

    UTF-16 code units

Const __assert_prebuiltmodels_has_correct_type

__assert_prebuiltmodels_has_correct_type: {} = PrebuiltModels

Type declaration

Const fromDocument

fromDocument: keyof symbol = Symbol("fromDocument")

Const serializer

serializer: any = coreClient.createSerializer(Mappers, /* isXml */ false)

Functions

empty

  • empty(): Generator<never>

  • Make an empty generator. This might seem silly, but it's useful for satisfying invariants.

    Returns Generator<never>

iterFrom

  • iterFrom<T>(items: T[], idx: number): Generator<T>

  • Produces an iterator of the given items starting from the given index.

    Type parameters

    • T

    Parameters

    • items: T[]

      the items to iterate over

    • idx: number

      the index of the first item to begin iterating from

    Returns Generator<T>

toDocumentLineFromGenerated

  • toDocumentLineFromGenerated(generated: GeneratedDocumentLine, page: GeneratedDocumentPage): DocumentLine

  • Transforms a REST-level document line into a convenience layer version.

    Parameters

    • generated: GeneratedDocumentLine

      a REST-level DocumentLine

    • page: GeneratedDocumentPage

      the page where the DocumentLine appeared

    Returns DocumentLine

    a convenience layer DocumentLine

Object literals

Const AnalyzeDocumentRequest

AnalyzeDocumentRequest: object

type

type: object

className

className: string = "AnalyzeDocumentRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

base64Source

base64Source: object

serializedName

serializedName: string = "base64Source"

type

type: object

name

name: string = "ByteArray"

urlSource

urlSource: object

serializedName

serializedName: string = "urlSource"

type

type: object

name

name: string = "String"

Const AnalyzeResult

AnalyzeResult: object

type

type: object

className

className: string = "AnalyzeResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

apiVersion

apiVersion: object

required

required: boolean = true

serializedName

serializedName: string = "apiVersion"

type

type: object

name

name: string = "String"

content

content: object

required

required: boolean = true

serializedName

serializedName: string = "content"

type

type: object

name

name: string = "String"

documents

documents: object

serializedName

serializedName: string = "documents"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "Document"

name

name: string = "Composite"

entities

entities: object

serializedName

serializedName: string = "entities"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentEntity"

name

name: string = "Composite"

keyValuePairs

keyValuePairs: object

serializedName

serializedName: string = "keyValuePairs"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentKeyValuePair"

name

name: string = "Composite"

modelId

modelId: object

required

required: boolean = true

serializedName

serializedName: string = "modelId"

constraints

constraints: object

Pattern

Pattern: any = new RegExp("[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}")

type

type: object

name

name: string = "String"

pages

pages: object

required

required: boolean = true

serializedName

serializedName: string = "pages"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentPage"

name

name: string = "Composite"

stringIndexType

stringIndexType: object

required

required: boolean = true

serializedName

serializedName: string = "stringIndexType"

type

type: object

name

name: string = "String"

styles

styles: object

serializedName

serializedName: string = "styles"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentStyle"

name

name: string = "Composite"

tables

tables: object

serializedName

serializedName: string = "tables"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentTable"

name

name: string = "Composite"

Const AnalyzeResultOperation

AnalyzeResultOperation: object

type

type: object

className

className: string = "AnalyzeResultOperation"

name

name: string = "Composite"

modelProperties

modelProperties: object

analyzeResult

analyzeResult: object

serializedName

serializedName: string = "analyzeResult"

type

type: object

className

className: string = "AnalyzeResult"

name

name: string = "Composite"

createdDateTime

createdDateTime: object

required

required: boolean = true

serializedName

serializedName: string = "createdDateTime"

type

type: object

name

name: string = "DateTime"

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "ErrorModel"

name

name: string = "Composite"

lastUpdatedDateTime

lastUpdatedDateTime: object

required

required: boolean = true

serializedName

serializedName: string = "lastUpdatedDateTime"

type

type: object

name

name: string = "DateTime"

status

status: object

required

required: boolean = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["notStarted", "running", "failed", "succeeded"]

name

name: string = "Enum"

Const AuthorizeCopyRequest

AuthorizeCopyRequest: object

type

type: object

className

className: string = "AuthorizeCopyRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

constraints

constraints: object

MaxLength

MaxLength: number = 4096

type

type: object

name

name: string = "String"

modelId

modelId: object

required

required: boolean = true

serializedName

serializedName: string = "modelId"

constraints

constraints: object

Pattern

Pattern: any = new RegExp("[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}")

type

type: object

name

name: string = "String"

Const AzureBlobContentSource

AzureBlobContentSource: object

type

type: object

className

className: string = "AzureBlobContentSource"

name

name: string = "Composite"

modelProperties

modelProperties: object

containerUrl

containerUrl: object

required

required: boolean = true

serializedName

serializedName: string = "containerUrl"

type

type: object

name

name: string = "String"

prefix

prefix: object

serializedName

serializedName: string = "prefix"

type

type: object

name

name: string = "String"

Const BoundingRegion

BoundingRegion: object

type

type: object

className

className: string = "BoundingRegion"

name

name: string = "Composite"

modelProperties

modelProperties: object

boundingBox

boundingBox: object

required

required: boolean = true

serializedName

serializedName: string = "boundingBox"

constraints

constraints: object

MaxItems

MaxItems: number = 8

MinItems

MinItems: number = 8

type

type: object

name

name: string = "Sequence"

element

element: object

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: string = "Number"

pageNumber

pageNumber: object

required

required: boolean = true

serializedName

serializedName: string = "pageNumber"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: string = "Number"

Const BuildDocumentModelRequest

BuildDocumentModelRequest: object

type

type: object

className

className: string = "BuildDocumentModelRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

azureBlobSource

azureBlobSource: object

serializedName

serializedName: string = "azureBlobSource"

type

type: object

className

className: string = "AzureBlobContentSource"

name

name: string = "Composite"

description

description: object

serializedName

serializedName: string = "description"

constraints

constraints: object

MaxLength

MaxLength: number = 4096

type

type: object

name

name: string = "String"

modelId

modelId: object

required

required: boolean = true

serializedName

serializedName: string = "modelId"

constraints

constraints: object

Pattern

Pattern: any = new RegExp("[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}")

type

type: object

name

name: string = "String"

Const ComponentModelInfo

ComponentModelInfo: object

type

type: object

className

className: string = "ComponentModelInfo"

name

name: string = "Composite"

modelProperties

modelProperties: object

modelId

modelId: object

required

required: boolean = true

serializedName

serializedName: string = "modelId"

constraints

constraints: object

Pattern

Pattern: any = new RegExp("[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}")

type

type: object

name

name: string = "String"

Const ComposeDocumentModelRequest

ComposeDocumentModelRequest: object

type

type: object

className

className: string = "ComposeDocumentModelRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

componentModels

componentModels: object

required

required: boolean = true

serializedName

serializedName: string = "componentModels"

constraints

constraints: object

UniqueItems

UniqueItems: boolean = true

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ComponentModelInfo"

name

name: string = "Composite"

description

description: object

serializedName

serializedName: string = "description"

constraints

constraints: object

MaxLength

MaxLength: number = 4096

type

type: object

name

name: string = "String"

modelId

modelId: object

required

required: boolean = true

serializedName

serializedName: string = "modelId"

constraints

constraints: object

Pattern

Pattern: any = new RegExp("[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}")

type

type: object

name

name: string = "String"

Const CopyAuthorization

CopyAuthorization: object

type

type: object

className

className: string = "CopyAuthorization"

name

name: string = "Composite"

modelProperties

modelProperties: object

accessToken

accessToken: object

required

required: boolean = true

serializedName

serializedName: string = "accessToken"

type

type: object

name

name: string = "String"

expirationDateTime

expirationDateTime: object

required

required: boolean = true

serializedName

serializedName: string = "expirationDateTime"

type

type: object

name

name: string = "DateTime"

targetModelId

targetModelId: object

required

required: boolean = true

serializedName

serializedName: string = "targetModelId"

constraints

constraints: object

Pattern

Pattern: any = new RegExp("[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}")

type

type: object

name

name: string = "String"

targetModelLocation

targetModelLocation: object

required

required: boolean = true

serializedName

serializedName: string = "targetModelLocation"

type

type: object

name

name: string = "String"

targetResourceId

targetResourceId: object

required

required: boolean = true

serializedName

serializedName: string = "targetResourceId"

type

type: object

name

name: string = "String"

targetResourceRegion

targetResourceRegion: object

required

required: boolean = true

serializedName

serializedName: string = "targetResourceRegion"

type

type: object

name

name: string = "String"

Const CustomDocumentModelsInfo

CustomDocumentModelsInfo: object

type

type: object

className

className: string = "CustomDocumentModelsInfo"

name

name: string = "Composite"

modelProperties

modelProperties: object

count

count: object

required

required: boolean = true

serializedName

serializedName: string = "count"

type

type: object

name

name: string = "Number"

limit

limit: object

required

required: boolean = true

serializedName

serializedName: string = "limit"

type

type: object

name

name: string = "Number"

Const DocTypeInfo

DocTypeInfo: object

type

type: object

className

className: string = "DocTypeInfo"

name

name: string = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

constraints

constraints: object

MaxLength

MaxLength: number = 4096

type

type: object

name

name: string = "String"

fieldConfidence

fieldConfidence: object

serializedName

serializedName: string = "fieldConfidence"

type

type: object

name

name: string = "Dictionary"

value

value: object

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: string = "Number"

fieldSchema

fieldSchema: object

required

required: boolean = true

serializedName

serializedName: string = "fieldSchema"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

className

className: string = "DocumentFieldSchema"

name

name: string = "Composite"

Const Document

Document: object

type

type: object

className

className: string = "Document"

name

name: string = "Composite"

modelProperties

modelProperties: object

boundingRegions

boundingRegions: object

serializedName

serializedName: string = "boundingRegions"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "BoundingRegion"

name

name: string = "Composite"

confidence

confidence: object

required

required: boolean = true

serializedName

serializedName: string = "confidence"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: string = "Number"

docType

docType: object

required

required: boolean = true

serializedName

serializedName: string = "docType"

constraints

constraints: object

MaxLength

MaxLength: number = 64

MinLength

MinLength: number = 2

type

type: object

name

name: string = "String"

fields

fields: object

required

required: boolean = true

serializedName

serializedName: string = "fields"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

className

className: string = "DocumentField"

name

name: string = "Composite"

spans

spans: object

required

required: boolean = true

serializedName

serializedName: string = "spans"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentSpan"

name

name: string = "Composite"

Const DocumentEntity

DocumentEntity: object

type

type: object

className

className: string = "DocumentEntity"

name

name: string = "Composite"

modelProperties

modelProperties: object

boundingRegions

boundingRegions: object

serializedName

serializedName: string = "boundingRegions"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "BoundingRegion"

name

name: string = "Composite"

category

category: object

required

required: boolean = true

serializedName

serializedName: string = "category"

type

type: object

name

name: string = "String"

confidence

confidence: object

required

required: boolean = true

serializedName

serializedName: string = "confidence"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: string = "Number"

content

content: object

required

required: boolean = true

serializedName

serializedName: string = "content"

type

type: object

name

name: string = "String"

spans

spans: object

required

required: boolean = true

serializedName

serializedName: string = "spans"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentSpan"

name

name: string = "Composite"

subCategory

subCategory: object

serializedName

serializedName: string = "subCategory"

type

type: object

name

name: string = "String"

Const DocumentField

DocumentField: object

type

type: object

className

className: string = "DocumentField"

name

name: string = "Composite"

modelProperties

modelProperties: object

boundingRegions

boundingRegions: object

serializedName

serializedName: string = "boundingRegions"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "BoundingRegion"

name

name: string = "Composite"

confidence

confidence: object

serializedName

serializedName: string = "confidence"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: string = "Number"

content

content: object

serializedName

serializedName: string = "content"

type

type: object

name

name: string = "String"

spans

spans: object

serializedName

serializedName: string = "spans"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentSpan"

name

name: string = "Composite"

type

type: object

required

required: boolean = true

serializedName

serializedName: string = "type"

type

type: object

name

name: string = "String"

valueArray

valueArray: object

serializedName

serializedName: string = "valueArray"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentField"

name

name: string = "Composite"

valueCountryRegion

valueCountryRegion: object

serializedName

serializedName: string = "valueCountryRegion"

type

type: object

name

name: string = "String"

valueDate

valueDate: object

serializedName

serializedName: string = "valueDate"

type

type: object

name

name: string = "Date"

valueInteger

valueInteger: object

serializedName

serializedName: string = "valueInteger"

type

type: object

name

name: string = "Number"

valueNumber

valueNumber: object

serializedName

serializedName: string = "valueNumber"

type

type: object

name

name: string = "Number"

valueObject

valueObject: object

serializedName

serializedName: string = "valueObject"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

className

className: string = "DocumentField"

name

name: string = "Composite"

valuePhoneNumber

valuePhoneNumber: object

serializedName

serializedName: string = "valuePhoneNumber"

type

type: object

name

name: string = "String"

valueSelectionMark

valueSelectionMark: object

serializedName

serializedName: string = "valueSelectionMark"

type

type: object

name

name: string = "String"

valueSignature

valueSignature: object

serializedName

serializedName: string = "valueSignature"

type

type: object

name

name: string = "String"

valueString

valueString: object

serializedName

serializedName: string = "valueString"

type

type: object

name

name: string = "String"

valueTime

valueTime: object

serializedName

serializedName: string = "valueTime"

type

type: object

name

name: string = "String"

Const DocumentFieldSchema

DocumentFieldSchema: object

type

type: object

className

className: string = "DocumentFieldSchema"

name

name: string = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: string = "String"

example

example: object

serializedName

serializedName: string = "example"

type

type: object

name

name: string = "String"

items

items: object

serializedName

serializedName: string = "items"

type

type: object

className

className: string = "DocumentFieldSchema"

name

name: string = "Composite"

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

className

className: string = "DocumentFieldSchema"

name

name: string = "Composite"

type

type: object

required

required: boolean = true

serializedName

serializedName: string = "type"

type

type: object

name

name: string = "String"

Const DocumentKeyValueElement

DocumentKeyValueElement: object

type

type: object

className

className: string = "DocumentKeyValueElement"

name

name: string = "Composite"

modelProperties

modelProperties: object

boundingRegions

boundingRegions: object

serializedName

serializedName: string = "boundingRegions"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "BoundingRegion"

name

name: string = "Composite"

content

content: object

required

required: boolean = true

serializedName

serializedName: string = "content"

type

type: object

name

name: string = "String"

spans

spans: object

required

required: boolean = true

serializedName

serializedName: string = "spans"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentSpan"

name

name: string = "Composite"

Const DocumentKeyValuePair

DocumentKeyValuePair: object

type

type: object

className

className: string = "DocumentKeyValuePair"

name

name: string = "Composite"

modelProperties

modelProperties: object

confidence

confidence: object

required

required: boolean = true

serializedName

serializedName: string = "confidence"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: string = "Number"

key

key: object

serializedName

serializedName: string = "key"

type

type: object

className

className: string = "DocumentKeyValueElement"

name

name: string = "Composite"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

className

className: string = "DocumentKeyValueElement"

name

name: string = "Composite"

Const DocumentLine

DocumentLine: object

type

type: object

className

className: string = "DocumentLine"

name

name: string = "Composite"

modelProperties

modelProperties: object

boundingBox

boundingBox: object

serializedName

serializedName: string = "boundingBox"

constraints

constraints: object

MaxItems

MaxItems: number = 8

MinItems

MinItems: number = 8

type

type: object

name

name: string = "Sequence"

element

element: object

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: string = "Number"

content

content: object

required

required: boolean = true

serializedName

serializedName: string = "content"

type

type: object

name

name: string = "String"

spans

spans: object

required

required: boolean = true

serializedName

serializedName: string = "spans"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentSpan"

name

name: string = "Composite"

Const DocumentPage

DocumentPage: object

type

type: object

className

className: string = "DocumentPage"

name

name: string = "Composite"

modelProperties

modelProperties: object

angle

angle: object

required

required: boolean = true

serializedName

serializedName: string = "angle"

constraints

constraints: object

ExclusiveMinimum

ExclusiveMinimum: number = -180

InclusiveMaximum

InclusiveMaximum: number = 180

type

type: object

name

name: string = "Number"

height

height: object

required

required: boolean = true

serializedName

serializedName: string = "height"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: string = "Number"

lines

lines: object

required

required: boolean = true

serializedName

serializedName: string = "lines"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentLine"

name

name: string = "Composite"

pageNumber

pageNumber: object

required

required: boolean = true

serializedName

serializedName: string = "pageNumber"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: string = "Number"

selectionMarks

selectionMarks: object

serializedName

serializedName: string = "selectionMarks"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentSelectionMark"

name

name: string = "Composite"

spans

spans: object

required

required: boolean = true

serializedName

serializedName: string = "spans"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentSpan"

name

name: string = "Composite"

unit

unit: object

required

required: boolean = true

serializedName

serializedName: string = "unit"

type

type: object

name

name: string = "String"

width

width: object

required

required: boolean = true

serializedName

serializedName: string = "width"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: string = "Number"

words

words: object

required

required: boolean = true

serializedName

serializedName: string = "words"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentWord"

name

name: string = "Composite"

Const DocumentSelectionMark

DocumentSelectionMark: object

type

type: object

className

className: string = "DocumentSelectionMark"

name

name: string = "Composite"

modelProperties

modelProperties: object

boundingBox

boundingBox: object

serializedName

serializedName: string = "boundingBox"

constraints

constraints: object

MaxItems

MaxItems: number = 8

MinItems

MinItems: number = 8

type

type: object

name

name: string = "Sequence"

element

element: object

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: string = "Number"

confidence

confidence: object

required

required: boolean = true

serializedName

serializedName: string = "confidence"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: string = "Number"

span

span: object

serializedName

serializedName: string = "span"

type

type: object

className

className: string = "DocumentSpan"

name

name: string = "Composite"

state

state: object

required

required: boolean = true

serializedName

serializedName: string = "state"

type

type: object

name

name: string = "String"

Const DocumentSpan

DocumentSpan: object

type

type: object

className

className: string = "DocumentSpan"

name

name: string = "Composite"

modelProperties

modelProperties: object

length

length: object

required

required: boolean = true

serializedName

serializedName: string = "length"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: string = "Number"

offset

offset: object

required

required: boolean = true

serializedName

serializedName: string = "offset"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: string = "Number"

Const DocumentStyle

DocumentStyle: object

type

type: object

className

className: string = "DocumentStyle"

name

name: string = "Composite"

modelProperties

modelProperties: object

confidence

confidence: object

required

required: boolean = true

serializedName

serializedName: string = "confidence"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: string = "Number"

isHandwritten

isHandwritten: object

serializedName

serializedName: string = "isHandwritten"

type

type: object

name

name: string = "Boolean"

spans

spans: object

required

required: boolean = true

serializedName

serializedName: string = "spans"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentSpan"

name

name: string = "Composite"

Const DocumentTable

DocumentTable: object

type

type: object

className

className: string = "DocumentTable"

name

name: string = "Composite"

modelProperties

modelProperties: object

boundingRegions

boundingRegions: object

serializedName

serializedName: string = "boundingRegions"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "BoundingRegion"

name

name: string = "Composite"

cells

cells: object

required

required: boolean = true

serializedName

serializedName: string = "cells"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentTableCell"

name

name: string = "Composite"

columnCount

columnCount: object

required

required: boolean = true

serializedName

serializedName: string = "columnCount"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: string = "Number"

rowCount

rowCount: object

required

required: boolean = true

serializedName

serializedName: string = "rowCount"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: string = "Number"

spans

spans: object

required

required: boolean = true

serializedName

serializedName: string = "spans"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentSpan"

name

name: string = "Composite"

Const DocumentTableCell

DocumentTableCell: object

type

type: object

className

className: string = "DocumentTableCell"

name

name: string = "Composite"

modelProperties

modelProperties: object

boundingRegions

boundingRegions: object

serializedName

serializedName: string = "boundingRegions"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "BoundingRegion"

name

name: string = "Composite"

columnIndex

columnIndex: object

required

required: boolean = true

serializedName

serializedName: string = "columnIndex"

type

type: object

name

name: string = "Number"

columnSpan

columnSpan: object

defaultValue

defaultValue: number = 1

serializedName

serializedName: string = "columnSpan"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: string = "Number"

content

content: object

required

required: boolean = true

serializedName

serializedName: string = "content"

type

type: object

name

name: string = "String"

kind

kind: object

defaultValue

defaultValue: string = "content"

serializedName

serializedName: string = "kind"

type

type: object

name

name: string = "String"

rowIndex

rowIndex: object

required

required: boolean = true

serializedName

serializedName: string = "rowIndex"

type

type: object

name

name: string = "Number"

rowSpan

rowSpan: object

defaultValue

defaultValue: number = 1

serializedName

serializedName: string = "rowSpan"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: string = "Number"

spans

spans: object

required

required: boolean = true

serializedName

serializedName: string = "spans"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentSpan"

name

name: string = "Composite"

Const DocumentWord

DocumentWord: object

type

type: object

className

className: string = "DocumentWord"

name

name: string = "Composite"

modelProperties

modelProperties: object

boundingBox

boundingBox: object

serializedName

serializedName: string = "boundingBox"

constraints

constraints: object

MaxItems

MaxItems: number = 8

MinItems

MinItems: number = 8

type

type: object

name

name: string = "Sequence"

element

element: object

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: string = "Number"

confidence

confidence: object

required

required: boolean = true

serializedName

serializedName: string = "confidence"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: string = "Number"

content

content: object

required

required: boolean = true

serializedName

serializedName: string = "content"

type

type: object

name

name: string = "String"

span

span: object

serializedName

serializedName: string = "span"

type

type: object

className

className: string = "DocumentSpan"

name

name: string = "Composite"

Const ErrorModel

ErrorModel: object

type

type: object

className

className: string = "ErrorModel"

name

name: string = "Composite"

modelProperties

modelProperties: object

code

code: object

required

required: boolean = true

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

details

details: object

serializedName

serializedName: string = "details"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorModel"

name

name: string = "Composite"

innererror

innererror: object

serializedName

serializedName: string = "innererror"

type

type: object

className

className: string = "InnerError"

name

name: string = "Composite"

message

message: object

required

required: boolean = true

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

target

target: object

serializedName

serializedName: string = "target"

type

type: object

name

name: string = "String"

Const ErrorResponse

ErrorResponse: object

type

type: object

className

className: string = "ErrorResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "ErrorModel"

name

name: string = "Composite"

Const GeneratedClientAnalyzeDocumentHeaders

GeneratedClientAnalyzeDocumentHeaders: object

type

type: object

className

className: string = "GeneratedClientAnalyzeDocumentHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

name: string = "String"

Const GeneratedClientBuildDocumentModelHeaders

GeneratedClientBuildDocumentModelHeaders: object

type

type: object

className

className: string = "GeneratedClientBuildDocumentModelHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

name: string = "String"

Const GeneratedClientComposeDocumentModelHeaders

GeneratedClientComposeDocumentModelHeaders: object

type

type: object

className

className: string = "GeneratedClientComposeDocumentModelHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

name: string = "String"

Const GeneratedClientCopyDocumentModelToHeaders

GeneratedClientCopyDocumentModelToHeaders: object

type

type: object

className

className: string = "GeneratedClientCopyDocumentModelToHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

name: string = "String"

Const GetInfoResponse

GetInfoResponse: object

type

type: object

className

className: string = "GetInfoResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

customDocumentModels

customDocumentModels: object

serializedName

serializedName: string = "customDocumentModels"

type

type: object

className

className: string = "CustomDocumentModelsInfo"

name

name: string = "Composite"

Const GetModelsResponse

GetModelsResponse: object

type

type: object

className

className: string = "GetModelsResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

value

value: object

required

required: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ModelSummary"

name

name: string = "Composite"

Const GetOperationResponse

GetOperationResponse: object

type

type: object

className

className: string = "GetOperationResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "ErrorModel"

name

name: string = "Composite"

result

result: object

serializedName

serializedName: string = "result"

type

type: object

className

className: string = "ModelInfo"

name

name: string = "Composite"

Const GetOperationsResponse

GetOperationsResponse: object

type

type: object

className

className: string = "GetOperationsResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

value

value: object

required

required: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "OperationInfo"

name

name: string = "Composite"

Const InnerError

InnerError: object

type

type: object

className

className: string = "InnerError"

name

name: string = "Composite"

modelProperties

modelProperties: object

code

code: object

required

required: boolean = true

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

innererror

innererror: object

serializedName

serializedName: string = "innererror"

type

type: object

className

className: string = "InnerError"

name

name: string = "Composite"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

Const ModelInfo

ModelInfo: object

type

type: object

className

className: string = "ModelInfo"

name

name: string = "Composite"

modelProperties

modelProperties: object

docTypes

docTypes: object

serializedName

serializedName: string = "docTypes"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

className

className: string = "DocTypeInfo"

name

name: string = "Composite"

Const ModelSummary

ModelSummary: object

type

type: object

className

className: string = "ModelSummary"

name

name: string = "Composite"

modelProperties

modelProperties: object

createdDateTime

createdDateTime: object

required

required: boolean = true

serializedName

serializedName: string = "createdDateTime"

type

type: object

name

name: string = "DateTime"

description

description: object

serializedName

serializedName: string = "description"

constraints

constraints: object

MaxLength

MaxLength: number = 4096

type

type: object

name

name: string = "String"

modelId

modelId: object

required

required: boolean = true

serializedName

serializedName: string = "modelId"

constraints

constraints: object

Pattern

Pattern: any = new RegExp("[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}")

type

type: object

name

name: string = "String"

Const OperationInfo

OperationInfo: object

type

type: object

className

className: string = "OperationInfo"

name

name: string = "Composite"

modelProperties

modelProperties: object

createdDateTime

createdDateTime: object

required

required: boolean = true

serializedName

serializedName: string = "createdDateTime"

type

type: object

name

name: string = "DateTime"

kind

kind: object

required

required: boolean = true

serializedName

serializedName: string = "kind"

type

type: object

name

name: string = "String"

lastUpdatedDateTime

lastUpdatedDateTime: object

required

required: boolean = true

serializedName

serializedName: string = "lastUpdatedDateTime"

type

type: object

name

name: string = "DateTime"

operationId

operationId: object

required

required: boolean = true

serializedName

serializedName: string = "operationId"

type

type: object

name

name: string = "String"

percentCompleted

percentCompleted: object

serializedName

serializedName: string = "percentCompleted"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 100

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: string = "Number"

resourceLocation

resourceLocation: object

required

required: boolean = true

serializedName

serializedName: string = "resourceLocation"

type

type: object

name

name: string = "String"

status

status: object

required

required: boolean = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["notStarted","running","failed","succeeded","canceled"]

name

name: string = "Enum"

Const PrebuiltModels

PrebuiltModels: object

Prebuilt models with well-known document types and corresponding field schemas.

These prebuilt DocumentModel objects can be used with the beginAnalyzeDocuments method to extract documents with a stronger TypeScript result type and property names that have been converted to use a JavaScript naming convention.

Example:

 
import { AzureKeyCredential, DocumentAnalysisClient, PrebuiltModels } from "@azure/ai-form-recognizer";

const credential = new AzureKeyCredential("<API key>">);
const client = new DocumentAnalysisClient("<endpoint>", credential);

const poller = await client.beginAnalyzeDocuments(PrebuiltModels.Receipt, "<receipt file URL>");

// Extract the first document from the response, which should be a receipt
const { documents: [receipt] } = await poller.pollUntilDone();

// If we had used the model ID "prebuilt-receipt" instead of the `PrebuiltModels.Receipt` data structure, then the
// fields of the receipt would be in PascalCase (rather than camelCase), and the TypeScript type of the fields would
// not be as strict. This reduces the burden of casting fields to the appropriate types.

console.log("The type of this receipt is:", receipt.fields.receiptType?.value)

BusinessCard

BusinessCard: DocumentModel<{}> = createModelFromSchema(BusinessCardSchema) as DocumentModel<BusinessCard>

IdentityDocument

IdentityDocument: DocumentModel<{}> = createModelFromSchema(IdentityDocumentSchema) as DocumentModel<IdentityDocument>

Invoice

Invoice: DocumentModel<{}> = createModelFromSchema(InvoiceSchema) as DocumentModel<Invoice>

Receipt

Receipt: DocumentModel<{}> = createModelFromSchema(ReceiptSchema) as DocumentModel<Receipt>

Const accept

accept: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

name: string = "String"

Const accept1

accept1: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

name: string = "String"

Const analyzeDocument$binaryOperationSpec

analyzeDocument$binaryOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "binary"

path

path: string = "/documentModels/{modelId}:analyze"

queryParameters

queryParameters: any[] = [Parameters.pages,Parameters.locale,Parameters.stringIndexType,Parameters.apiVersion]

requestBody

requestBody: any = Parameters.analyzeRequest

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.modelId]

responses

responses: object

202

202: object

headersMapper

headersMapper: any = Mappers.GeneratedClientAnalyzeDocumentHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const analyzeDocument$jsonOperationSpec

analyzeDocument$jsonOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType1, Parameters.accept1]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/documentModels/{modelId}:analyze"

queryParameters

queryParameters: any[] = [Parameters.pages,Parameters.locale,Parameters.stringIndexType,Parameters.apiVersion]

requestBody

requestBody: any = Parameters.analyzeRequest1

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.modelId]

responses

responses: object

202

202: object

headersMapper

headersMapper: any = Mappers.GeneratedClientAnalyzeDocumentHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const analyzeRequest

analyzeRequest: object

parameterPath

parameterPath: string[] = ["options", "analyzeRequest"]

mapper

mapper: object

serializedName

serializedName: string = "analyzeRequest"

type

type: object

name

name: string = "Stream"

Const analyzeRequest1

analyzeRequest1: object

mapper

mapper: any = AnalyzeDocumentRequestMapper

parameterPath

parameterPath: string[] = ["options", "analyzeRequest"]

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2021-09-30-preview"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: string = "String"

Const authorizeCopyDocumentModelOperationSpec

authorizeCopyDocumentModelOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept1, Parameters.contentType2]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/documentModels:authorizeCopy"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.authorizeCopyRequest

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.CopyAuthorization

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const authorizeCopyRequest

authorizeCopyRequest: object

mapper

mapper: any = AuthorizeCopyRequestMapper

parameterPath

parameterPath: string = "authorizeCopyRequest"

Const buildDocumentModelOperationSpec

buildDocumentModelOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept1, Parameters.contentType2]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/documentModels:build"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.buildRequest

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

202

202: object

headersMapper

headersMapper: any = Mappers.GeneratedClientBuildDocumentModelHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const buildRequest

buildRequest: object

mapper

mapper: any = BuildDocumentModelRequestMapper

parameterPath

parameterPath: string = "buildRequest"

Const composeDocumentModelOperationSpec

composeDocumentModelOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept1, Parameters.contentType2]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/documentModels:compose"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.composeRequest

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

202

202: object

headersMapper

headersMapper: any = Mappers.GeneratedClientComposeDocumentModelHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const composeRequest

composeRequest: object

mapper

mapper: any = ComposeDocumentModelRequestMapper

parameterPath

parameterPath: string = "composeRequest"

Const contentType

contentType: object

parameterPath

parameterPath: string = "contentType"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

allowedValues

allowedValues: string[] = ["application/octet-stream","application/pdf","image/bmp","image/jpeg","image/png","image/tiff"]

name

name: string = "Enum"

Const contentType1

contentType1: object

parameterPath

parameterPath: string = "contentType"

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

name: string = "String"

Const contentType2

contentType2: object

parameterPath

parameterPath: string[] = ["options", "contentType"]

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

name: string = "String"

Const copyDocumentModelToOperationSpec

copyDocumentModelToOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept1, Parameters.contentType2]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/documentModels/{modelId}:copyTo"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.copyToRequest

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.modelId]

responses

responses: object

202

202: object

headersMapper

headersMapper: any = Mappers.GeneratedClientCopyDocumentModelToHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const copyToRequest

copyToRequest: object

mapper

mapper: any = CopyAuthorizationMapper

parameterPath

parameterPath: string = "copyToRequest"

Const deleteModelOperationSpec

deleteModelOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept1]

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/documentModels/{modelId}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.modelId]

responses

responses: object

204

204: {}

Type declaration

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const endpoint

endpoint: object

parameterPath

parameterPath: string = "endpoint"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "endpoint"

type

type: object

name

name: string = "String"

Const getAnalyzeDocumentResultOperationSpec

getAnalyzeDocumentResultOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept1]

httpMethod

httpMethod: string = "GET"

path

path: string = "/documentModels/{modelId}/analyzeResults/{resultId}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.modelId, Parameters.resultId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.AnalyzeResultOperation

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getInfoOperationSpec

getInfoOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept1]

httpMethod

httpMethod: string = "GET"

path

path: string = "/info"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.GetInfoResponse

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getModelOperationSpec

getModelOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept1]

httpMethod

httpMethod: string = "GET"

path

path: string = "/documentModels/{modelId}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.modelId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.ModelInfo

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getModelsNextOperationSpec

getModelsNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept1]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.GetModelsResponse

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getModelsOperationSpec

getModelsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept1]

httpMethod

httpMethod: string = "GET"

path

path: string = "/documentModels"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.GetModelsResponse

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getOperationOperationSpec

getOperationOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept1]

httpMethod

httpMethod: string = "GET"

path

path: string = "/operations/{operationId}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.operationId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.GetOperationResponse

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getOperationsNextOperationSpec

getOperationsNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept1]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.GetOperationsResponse

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getOperationsOperationSpec

getOperationsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept1]

httpMethod

httpMethod: string = "GET"

path

path: string = "/operations"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.GetOperationsResponse

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const locale

locale: object

parameterPath

parameterPath: string[] = ["options", "locale"]

mapper

mapper: object

serializedName

serializedName: string = "locale"

type

type: object

name

name: string = "String"

Const modelId

modelId: object

parameterPath

parameterPath: string = "modelId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "modelId"

constraints

constraints: object

Pattern

Pattern: any = new RegExp("[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}")

type

type: object

name

name: string = "String"

Const nextLink

nextLink: object

parameterPath

parameterPath: string = "nextLink"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

Const operationId

operationId: object

parameterPath

parameterPath: string = "operationId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "operationId"

type

type: object

name

name: string = "String"

Const pages

pages: object

parameterPath

parameterPath: string[] = ["options", "pages"]

mapper

mapper: object

serializedName

serializedName: string = "pages"

constraints

constraints: object

Pattern

Pattern: any = new RegExp("^(\\d+(-\\d+)?)(,\\s*(\\d+(-\\d+)?))*$")

type

type: object

name

name: string = "String"

Const resultId

resultId: object

parameterPath

parameterPath: string = "resultId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "resultId"

type

type: object

name

name: string = "String"

Const stringIndexType

stringIndexType: object

parameterPath

parameterPath: string = "stringIndexType"

mapper

mapper: object

serializedName

serializedName: string = "stringIndexType"

type

type: object

name

name: string = "String"

Generated using TypeDoc