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

BeginCopyModelOptions

Options for begin copy model operation

BeginCreateComposedModelOptions

BeginCreateComposedModelOptions: FormRecognizerOperationOptions & FormTrainingPollOperationOptions<TrainingOperationState> & { modelName?: undefined | string }

Options for creating a composed model from submodels.

BeginRecognizeBusinessCardsOptions

BeginRecognizeBusinessCardsOptions: BeginRecognizePrebuiltOptions

Options for starting the Business Card recognition operation

BeginRecognizeContentOptions

BeginRecognizeContentOptions: RecognizeContentOptions & { contentType?: FormContentType; language?: undefined | string; onProgress?: undefined | ((state: RecognizeContentOperationState) => void); pages?: string[]; readingOrder?: FormReadingOrder; resumeFrom?: undefined | string; updateIntervalInMs?: undefined | number }

Options for the start content/layout recognition operation

BeginRecognizeIdentityDocumentsOptions

BeginRecognizeIdentityDocumentsOptions: BeginRecognizePrebuiltOptions

Options for starting the ID document recognition operation

BeginRecognizeInvoicesOptions

BeginRecognizeInvoicesOptions: BeginRecognizePrebuiltOptions

Options for starting the Invoice recognition operation

BeginRecognizeReceiptsOptions

BeginRecognizeReceiptsOptions: BeginRecognizePrebuiltOptions

Options for starting the receipt recognition operation

BeginTrainingOptions

BeginTrainingOptions: TrainingFileFilter & FormTrainingPollOperationOptions<TrainingOperationState> & { modelName?: undefined | string }

Options for starting model training operation.

ContentPollerLike

ContentPollerLike: PollerLike<PollOperationState<FormPageArray>, FormPageArray>

The Long-Running-Operation (LRO) poller that allows you to wait until form content is recognized.

ContentType

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

Defines values for ContentType.

CopyModelOperationState

CopyModelOperationState: PollOperationState<CustomFormModel> & { status: OperationStatus }

The status of a copy model operation

CopyModelOptions

Options for the copy custom model operation.

CopyModelPollerClient

CopyModelPollerClient: { beginCopyModel: (modelId: string, copyAuthorization: CopyAuthorization, copyModelOptions?: CopyModelOptions) => Promise<CopyCustomModelResponseModel>; getCopyModelResult: (modelId: string, resultId: string, options: GetCopyModelResultOptions) => Promise<GetCustomModelCopyResultResponse> }

Defines the operations from a training client that are needed for the poller to work

Type declaration

DeleteModelOptions

DeleteModelOptions: FormRecognizerOperationOptions

Options for the delete model operation.

FieldValueSelectionMark

FieldValueSelectionMark: string

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

Know values supported by the service

selected
unselected

FieldValueType

FieldValueType: "string" | "date" | "time" | "phoneNumber" | "number" | "integer" | "array" | "object" | "selectionMark" | "countryRegion"

Defines values for FieldValueType.

FormContentType

FormContentType: "application/pdf" | "image/jpeg" | "image/png" | "image/tiff" | "image/bmp"

Content types supported by Form Recognizer service.

FormElement

Information about a recognized element in the form. Examples include words, lines, checkbox, etc.

FormField

A field recognized within a form, represented as a tagged union of several different types of form fields, all sharing some common elements.

The valueType property of this object can be used to determine which variation of FormField was recognized. For example, if the valueType property is "number", then the FormField is a FormNumberField, and the value property will be a number.

FormLanguage

FormLanguage: string

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

Know values supported by the service

af
ast
bi
br
ca
ceb
ch
co
crh
cs
csb
da
de
en
es
et
eu
fi
fil
fj
fr
fur
fy
ga
gd
gil
gl
gv
hni
hsb
ht
hu
ia
id
it
iu
ja
jv
kaa
kac
kea
kha
kl
ko
ku
kw
lb
ms
mww
nap
nl
no
oc
pl
pt
quc
rm
sco
sl
sq
sv
sw
tet
tr
tt
uz
vo
wae
yua
za
zh-Hans
zh-Hant
zu

FormLocale

FormLocale: string

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

Know values supported by the service

en-AU
en-CA
en-GB
en-IN
en-US

FormModelResponse

FormModelResponse: CustomFormModel & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: Model } }

Contains the response data for retrieving a model from unlabeled training.

FormPollerLike

Result type of the Recognize Form Long-Running-Operation (LRO)

FormPollerOperationDescription

FormPollerOperationDescription: FormPollerOperationOptions & FormRecognitionOperationClient & { expectedDocType?: undefined | string; modelId?: undefined | string }

Set of intrinsic properties that describe a form recognition polling operation.

FormReadingOrder

FormReadingOrder: "basic" | "natural"

Defines values for FormReadingOrder.

FormRecognizerRequestBody

FormRecognizerRequestBody: Blob | ArrayBuffer | ArrayBufferView | NodeJS.ReadableStream

Types of binary data allowed as input to recognition operations

GeneratedClientAnalyzeBusinessCardAsyncResponse

GeneratedClientAnalyzeBusinessCardAsyncResponse: GeneratedClientAnalyzeBusinessCardAsyncHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: GeneratedClientAnalyzeBusinessCardAsyncHeaders } }

Contains response data for the analyzeBusinessCardAsync operation.

GeneratedClientAnalyzeIdDocumentAsyncResponse

GeneratedClientAnalyzeIdDocumentAsyncResponse: GeneratedClientAnalyzeIdDocumentAsyncHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: GeneratedClientAnalyzeIdDocumentAsyncHeaders } }

Contains response data for the analyzeIdDocumentAsync operation.

GeneratedClientAnalyzeInvoiceAsyncResponse

GeneratedClientAnalyzeInvoiceAsyncResponse: GeneratedClientAnalyzeInvoiceAsyncHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: GeneratedClientAnalyzeInvoiceAsyncHeaders } }

Contains response data for the analyzeInvoiceAsync operation.

GeneratedClientAnalyzeLayoutAsyncResponse

GeneratedClientAnalyzeLayoutAsyncResponse: GeneratedClientAnalyzeLayoutAsyncHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: GeneratedClientAnalyzeLayoutAsyncHeaders } }

Contains response data for the analyzeLayoutAsync operation.

GeneratedClientAnalyzeReceiptAsyncResponse

GeneratedClientAnalyzeReceiptAsyncResponse: GeneratedClientAnalyzeReceiptAsyncHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: GeneratedClientAnalyzeReceiptAsyncHeaders } }

Contains response data for the analyzeReceiptAsync operation.

GeneratedClientAnalyzeWithCustomModelResponse

GeneratedClientAnalyzeWithCustomModelResponse: GeneratedClientAnalyzeWithCustomModelHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: GeneratedClientAnalyzeWithCustomModelHeaders } }

Contains response data for the analyzeWithCustomModel operation.

GeneratedClientComposeCustomModelsAsyncResponse

GeneratedClientComposeCustomModelsAsyncResponse: GeneratedClientComposeCustomModelsAsyncHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: GeneratedClientComposeCustomModelsAsyncHeaders } }

Contains response data for the composeCustomModelsAsync operation.

GeneratedClientCopyCustomModelResponse

GeneratedClientCopyCustomModelResponse: GeneratedClientCopyCustomModelHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: GeneratedClientCopyCustomModelHeaders } }

Contains response data for the copyCustomModel operation.

GeneratedClientGenerateModelCopyAuthorizationResponse

GeneratedClientGenerateModelCopyAuthorizationResponse: GeneratedClientGenerateModelCopyAuthorizationHeaders & CopyAuthorizationResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: CopyAuthorizationResult; parsedHeaders: GeneratedClientGenerateModelCopyAuthorizationHeaders } }

Contains response data for the generateModelCopyAuthorization operation.

GeneratedClientGetAnalyzeBusinessCardResultResponse

GeneratedClientGetAnalyzeBusinessCardResultResponse: AnalyzeOperationResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: AnalyzeOperationResult } }

Contains response data for the getAnalyzeBusinessCardResult operation.

GeneratedClientGetAnalyzeFormResultResponse

GeneratedClientGetAnalyzeFormResultResponse: AnalyzeOperationResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: AnalyzeOperationResult } }

Contains response data for the getAnalyzeFormResult operation.

GeneratedClientGetAnalyzeIdDocumentResultResponse

GeneratedClientGetAnalyzeIdDocumentResultResponse: AnalyzeOperationResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: AnalyzeOperationResult } }

Contains response data for the getAnalyzeIdDocumentResult operation.

GeneratedClientGetAnalyzeInvoiceResultResponse

GeneratedClientGetAnalyzeInvoiceResultResponse: AnalyzeOperationResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: AnalyzeOperationResult } }

Contains response data for the getAnalyzeInvoiceResult operation.

GeneratedClientGetAnalyzeLayoutResultResponse

GeneratedClientGetAnalyzeLayoutResultResponse: AnalyzeOperationResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: AnalyzeOperationResult } }

Contains response data for the getAnalyzeLayoutResult operation.

GeneratedClientGetAnalyzeReceiptResultResponse

GeneratedClientGetAnalyzeReceiptResultResponse: AnalyzeOperationResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: AnalyzeOperationResult } }

Contains response data for the getAnalyzeReceiptResult operation.

GeneratedClientGetCustomModelCopyResultResponse

GeneratedClientGetCustomModelCopyResultResponse: CopyOperationResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: CopyOperationResult } }

Contains response data for the getCustomModelCopyResult operation.

GeneratedClientGetCustomModelResponse

GeneratedClientGetCustomModelResponse: Model & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: Model } }

Contains response data for the getCustomModel operation.

GeneratedClientGetCustomModelsResponse

GeneratedClientGetCustomModelsResponse: Models & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: Models } }

Contains response data for the getCustomModels operation.

GeneratedClientListCustomModelsNextResponse

GeneratedClientListCustomModelsNextResponse: Models & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: Models } }

Contains response data for the listCustomModelsNext operation.

GeneratedClientListCustomModelsResponse

GeneratedClientListCustomModelsResponse: Models & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: Models } }

Contains response data for the listCustomModels operation.

GeneratedClientTrainCustomModelAsyncResponse

GeneratedClientTrainCustomModelAsyncResponse: GeneratedClientTrainCustomModelAsyncHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: GeneratedClientTrainCustomModelAsyncHeaders } }

Contains response data for the trainCustomModelAsync operation.

GetAccountPropertiesOptions

GetAccountPropertiesOptions: FormRecognizerOperationOptions

Options for the get account properties operation.

GetCopyAuthorizationOptions

GetCopyAuthorizationOptions: FormRecognizerOperationOptions

Options for the generate copy model authorization operation.

GetCopyModelResultOptions

GetCopyModelResultOptions: FormRecognizerOperationOptions

Options for the get copy model result operation.

GetModelOptions

Options for the get model operation.

GetRecognizedContentResultOptions

GetRecognizedContentResultOptions: FormRecognizerOperationOptions

Options for retrieving recognized content data

KeyValueType

KeyValueType: string

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

Know values supported by the service

string
selectionMark

LengthUnit

LengthUnit: "pixel" | "inch"

Defines values for LengthUnit.

ListCustomModelsResponse

ListCustomModelsResponse: Models & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: Models } }

Contains response data for the listCustomModels operation.

ListModelsOptions

Options for model listing operation.

ModelStatus

ModelStatus: "creating" | "ready" | "invalid"

Defines values for ModelStatus.

OperationStatus

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

Defines values for OperationStatus.

RecognizeContentOperationState

RecognizeContentOperationState: PollOperationState<FormPageArray> & { status: OperationStatus }

The state of a recognize content operation

RecognizeContentOptions

RecognizeContentOptions: FormRecognizerOperationOptions

Options for content/layout recognition.

RecognizeContentPollerClient

RecognizeContentPollerClient: { beginRecognize: (source: FormRecognizerRequestBody | string, contentType?: FormContentType, analyzeOptions?: BeginRecognizeContentOptions) => Promise<AnalyzeLayoutAsyncResponseModel>; getRecognizeResult: (resultId: string, options: { abortSignal?: AbortSignalLike }) => Promise<RecognizeContentResultResponse> }

Defines the operations from a analyze client that are needed for the poller to work

Type declaration

RecognizeContentResultResponse

RecognizeContentResultResponse: RecognizedContent & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: AnalyzeOperationResultModel } }

Contains response data for the Recognize Content operation.

SelectionMarkState

SelectionMarkState: "selected" | "unselected"

Defines values for SelectionMarkState.

StyleName

StyleName: "other" | "handwriting"

Defines values for StyleName.

TrainPollerClient

TrainPollerClient: { getCustomModel: (modelId: string, options: GetModelOptions) => Promise<FormModelResponse>; trainCustomModelInternal: (source: string | string[], useLabelFile?: undefined | false | true, options?: TrainingFileFilter) => Promise<TrainCustomModelAsyncResponse> }

Defines the operations from a FormRecognizerClient that are needed for the poller returned by {@link FormRecognizerClient.beginTraining} to work.

Type declaration

TrainStatus

TrainStatus: "succeeded" | "partiallySucceeded" | "failed"

Defines values for TrainStatus.

TrainingFileFilter

TrainingFileFilter: FormRecognizerOperationOptions & { includeSubfolders?: undefined | false | true; prefix?: undefined | string }

Options for training models

TrainingOperationState

TrainingOperationState: PollOperationState<CustomFormModelInfo> & { status: ModelStatus }

The status of a form training operation

Variables

Const API_KEY_HEADER_NAME

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

Const DEFAULT_COGNITIVE_SCOPE

DEFAULT_COGNITIVE_SCOPE: "https://cognitiveservices.azure.com/.default" = "https://cognitiveservices.azure.com/.default"

Const DEFAULT_POLLING_INTERVAL

DEFAULT_POLLING_INTERVAL: 5000 = 5000

Const FormRecognizerLoggingAllowedHeaderNames

FormRecognizerLoggingAllowedHeaderNames: string[] = ["apim-request-id","Location","Operation-Location","Strict-Transport-Security","X-Content-Type-Options","x-envoy-upstream-service-time"]

Const FormRecognizerLoggingAllowedQueryParameters

FormRecognizerLoggingAllowedQueryParameters: string[] = ["includeTextDetails","includeKeys","op"]

Const LIB_INFO

LIB_INFO: string = `azsdk-js-ai-formrecognizer/${SDK_VERSION}`

Const SDK_VERSION

SDK_VERSION: string = "3.1.0"

Const SIZE_ONE_MEGA

SIZE_ONE_MEGA: number = 1024 * 1024

Const logger

logger: any = createClientLogger("ai-form-recognizer")

The @azure/logger configuration for this package.

Const packageName

packageName: "@azure/ai-form-recognizer" = "@azure/ai-form-recognizer"

Const packageVersion

packageVersion: "3.1.0" = "3.1.0"

Const serializer

serializer: any = new coreHttp.Serializer(Mappers, /* isXml */ false)

Const textPattern

textPattern: Object = /\/readResults\/(\d+)\/lines\/(\d+)(?:\/words\/(\d+))?/

Functions

createFormRecognizerAzureKeyCredentialPolicy

  • createFormRecognizerAzureKeyCredentialPolicy(credential: KeyCredential): RequestPolicyFactory

flattenCustomFormSubmodels

  • flattenCustomFormSubmodels(original: GetCustomModelResponse): CustomFormSubmodel[] | undefined

flattenTrainingDocuments

  • flattenTrainingDocuments(original: GetCustomModelResponse): TrainingDocumentInfo[] | undefined

getFirstFourBytesFromBlob

  • getFirstFourBytesFromBlob(_data: Blob): Promise<Uint8Array>

isArrayBuffer

isArrayBufferView

isBlob

isReadableStream

isSourcePath

streamToBuffer

  • streamToBuffer(stream: NodeJS.ReadableStream, maxSize: number): Promise<Buffer>

toBoundingBox

  • toBoundingBox(original: number[]): Point2D[]

toCustomFormModelProperties

toFieldData

  • toFieldData(pageNumber: number, original: KeyValueElementModel, readResults?: FormPage[]): FieldData

toFieldsFromFieldValue

  • toFieldsFromFieldValue(original: {}, readResults: FormPage[]): {}

toFieldsFromKeyValuePairs

  • toFieldsFromKeyValuePairs(pageNumber: number, original: KeyValuePairModel[], pages: FormPage[]): {}

toFormContent

toFormFieldFromFieldValueModel

  • toFormFieldFromFieldValueModel(original: FieldValueModel, key: string, readResults: FormPage[]): FormField

toFormFieldFromKeyValuePairModel

  • toFormFieldFromKeyValuePairModel(pageNumber: number, original: KeyValuePairModel, readResults?: FormPage[]): FormField

toFormFromPageResult

toFormModelResponse

toFormPage

  • toFormPage(original: ReadResultModel): FormPage

toFormPages

  • toFormPages(readResults?: ReadResultModel[], pageResults?: PageResultModel[]): FormPage[]

toFormTable

  • toFormTable(original: DataTableModel, readResults: FormPage[], pageNumber: number): FormTable

toRecognizeContentResultResponse

toRecognizedForm

toRecognizedFormArray

  • toRecognizedFormArray(original: GetAnalyzeFormResultResponse, expectedDocTypePrefix?: undefined | string): RecognizedFormArray

toSelectionMark

toSubmodelsFromComposedTrainResults

toSubmodelsFromTrainResultLabeled

toSubmodelsFromTrainResultUnlabeled

toTextLine

  • toTextLine(original: TextLineModel, pageNumber: number): FormLine

Object literals

Const AnalyzeOperationResult

AnalyzeOperationResult: object

type

type: object

className

className: string = "AnalyzeOperationResult"

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"

createdOn

createdOn: object

required

required: boolean = true

serializedName

serializedName: string = "createdDateTime"

type

type: object

name

name: string = "DateTime"

lastModified

lastModified: 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", "succeeded", "failed"]

name

name: string = "Enum"

Const AnalyzeResult

AnalyzeResult: object

type

type: object

className

className: string = "AnalyzeResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

documentResults

documentResults: object

serializedName

serializedName: string = "documentResults"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentResult"

name

name: string = "Composite"

errors

errors: object

serializedName

serializedName: string = "errors"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorInformation"

name

name: string = "Composite"

pageResults

pageResults: object

serializedName

serializedName: string = "pageResults"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "PageResult"

name

name: string = "Composite"

readResults

readResults: object

required

required: boolean = true

serializedName

serializedName: string = "readResults"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ReadResult"

name

name: string = "Composite"

version

version: object

required

required: boolean = true

serializedName

serializedName: string = "version"

type

type: object

name

name: string = "String"

Const Attributes

Attributes: object

type

type: object

className

className: string = "Attributes"

name

name: string = "Composite"

modelProperties

modelProperties: object

isComposed

isComposed: object

serializedName

serializedName: string = "isComposed"

type

type: object

name

name: string = "Boolean"

Const ComposeRequest

ComposeRequest: object

type

type: object

className

className: string = "ComposeRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

modelIds

modelIds: object

required

required: boolean = true

serializedName

serializedName: string = "modelIds"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "Uuid"

modelName

modelName: object

serializedName

serializedName: string = "modelName"

type

type: object

name

name: string = "String"

Const CopyAuthorizationResult

CopyAuthorizationResult: object

type

type: object

className

className: string = "CopyAuthorizationResult"

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"

expirationDateTimeTicks

expirationDateTimeTicks: object

required

required: boolean = true

serializedName

serializedName: string = "expirationDateTimeTicks"

type

type: object

name

name: string = "Number"

modelId

modelId: object

required

required: boolean = true

serializedName

serializedName: string = "modelId"

type

type: object

name

name: string = "String"

Const CopyOperationResult

CopyOperationResult: object

type

type: object

className

className: string = "CopyOperationResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

copyResult

copyResult: object

serializedName

serializedName: string = "copyResult"

type

type: object

className

className: string = "CopyResult"

name

name: string = "Composite"

createdOn

createdOn: object

required

required: boolean = true

serializedName

serializedName: string = "createdDateTime"

type

type: object

name

name: string = "DateTime"

lastModified

lastModified: 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", "succeeded", "failed"]

name

name: string = "Enum"

Const CopyRequest

CopyRequest: object

type

type: object

className

className: string = "CopyRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

copyAuthorization

copyAuthorization: object

serializedName

serializedName: string = "copyAuthorization"

type

type: object

className

className: string = "CopyAuthorizationResult"

name

name: string = "Composite"

targetResourceId

targetResourceId: object

required

required: boolean = true

serializedName

serializedName: string = "targetResourceId"

constraints

constraints: object

MaxLength

MaxLength: number = 1024

Pattern

Pattern: any = new RegExp("^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.CognitiveServices/accounts/[^/]*$")

type

type: object

name

name: string = "String"

targetResourceRegion

targetResourceRegion: object

required

required: boolean = true

serializedName

serializedName: string = "targetResourceRegion"

constraints

constraints: object

MaxLength

MaxLength: number = 24

MinLength

MinLength: number = 1

Pattern

Pattern: any = new RegExp("^[a-z0-9]+$")

type

type: object

name

name: string = "String"

Const CopyResult

CopyResult: object

type

type: object

className

className: string = "CopyResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

errors

errors: object

serializedName

serializedName: string = "errors"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorInformation"

name

name: string = "Composite"

modelId

modelId: object

required

required: boolean = true

serializedName

serializedName: string = "modelId"

type

type: object

name

name: string = "Uuid"

Const DataTable

DataTable: object

type

type: object

className

className: string = "DataTable"

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

type

type: object

name

name: string = "Number"

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 = "DataTableCell"

name

name: string = "Composite"

columns

columns: object

required

required: boolean = true

serializedName

serializedName: string = "columns"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: string = "Number"

rows

rows: object

required

required: boolean = true

serializedName

serializedName: string = "rows"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: string = "Number"

Const DataTableCell

DataTableCell: object

type

type: object

className

className: string = "DataTableCell"

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

type

type: object

name

name: string = "Number"

columnIndex

columnIndex: object

required

required: boolean = true

serializedName

serializedName: string = "columnIndex"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

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"

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"

elements

elements: object

serializedName

serializedName: string = "elements"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

isFooter

isFooter: object

serializedName

serializedName: string = "isFooter"

type

type: object

name

name: string = "Boolean"

isHeader

isHeader: object

serializedName

serializedName: string = "isHeader"

type

type: object

name

name: string = "Boolean"

rowIndex

rowIndex: object

required

required: boolean = true

serializedName

serializedName: string = "rowIndex"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

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"

text

text: object

required

required: boolean = true

serializedName

serializedName: string = "text"

type

type: object

name

name: string = "String"

Const DocumentResult

DocumentResult: object

type

type: object

className

className: string = "DocumentResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

docType

docType: object

required

required: boolean = true

serializedName

serializedName: string = "docType"

type

type: object

name

name: string = "String"

docTypeConfidence

docTypeConfidence: object

serializedName

serializedName: string = "docTypeConfidence"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: string = "Number"

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 = "FieldValue"

name

name: string = "Composite"

modelId

modelId: object

serializedName

serializedName: string = "modelId"

type

type: object

name

name: string = "Uuid"

pageRange

pageRange: object

required

required: boolean = true

serializedName

serializedName: string = "pageRange"

constraints

constraints: object

MaxItems

MaxItems: number = 2

MinItems

MinItems: number = 2

type

type: object

name

name: string = "Sequence"

element

element: object

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: string = "Number"

Const ErrorInformation

ErrorInformation: object

type

type: object

className

className: string = "ErrorInformation"

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"

message

message: object

required

required: boolean = true

serializedName

serializedName: string = "message"

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 = "ErrorInformation"

name

name: string = "Composite"

Const FieldValue

FieldValue: object

type

type: object

className

className: string = "FieldValue"

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

type

type: object

name

name: string = "Number"

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"

elements

elements: object

serializedName

serializedName: string = "elements"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

pageNumber

pageNumber: object

serializedName

serializedName: string = "page"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: string = "Number"

text

text: object

serializedName

serializedName: string = "text"

type

type: object

name

name: string = "String"

type

type: object

required

required: boolean = true

serializedName

serializedName: string = "type"

type

type: object

allowedValues

allowedValues: string[] = ["string","date","time","phoneNumber","number","integer","array","object","selectionMark","countryRegion"]

name

name: string = "Enum"

valueArray

valueArray: object

serializedName

serializedName: string = "valueArray"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "FieldValue"

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 = "FieldValue"

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"

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 FormFieldsReport

FormFieldsReport: object

type

type: object

className

className: string = "FormFieldsReport"

name

name: string = "Composite"

modelProperties

modelProperties: object

accuracy

accuracy: object

required

required: boolean = true

serializedName

serializedName: string = "accuracy"

type

type: object

name

name: string = "Number"

fieldName

fieldName: object

required

required: boolean = true

serializedName

serializedName: string = "fieldName"

type

type: object

name

name: string = "String"

Const GeneratedClientAnalyzeBusinessCardAsyncHeaders

GeneratedClientAnalyzeBusinessCardAsyncHeaders: object

type

type: object

className

className: string = "GeneratedClientAnalyzeBusinessCardAsyncHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

name: string = "String"

Const GeneratedClientAnalyzeIdDocumentAsyncHeaders

GeneratedClientAnalyzeIdDocumentAsyncHeaders: object

type

type: object

className

className: string = "GeneratedClientAnalyzeIdDocumentAsyncHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

name: string = "String"

Const GeneratedClientAnalyzeInvoiceAsyncHeaders

GeneratedClientAnalyzeInvoiceAsyncHeaders: object

type

type: object

className

className: string = "GeneratedClientAnalyzeInvoiceAsyncHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

name: string = "String"

Const GeneratedClientAnalyzeLayoutAsyncHeaders

GeneratedClientAnalyzeLayoutAsyncHeaders: object

type

type: object

className

className: string = "GeneratedClientAnalyzeLayoutAsyncHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

name: string = "String"

Const GeneratedClientAnalyzeReceiptAsyncHeaders

GeneratedClientAnalyzeReceiptAsyncHeaders: object

type

type: object

className

className: string = "GeneratedClientAnalyzeReceiptAsyncHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

name: string = "String"

Const GeneratedClientAnalyzeWithCustomModelHeaders

GeneratedClientAnalyzeWithCustomModelHeaders: object

type

type: object

className

className: string = "GeneratedClientAnalyzeWithCustomModelHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

name: string = "String"

Const GeneratedClientComposeCustomModelsAsyncHeaders

GeneratedClientComposeCustomModelsAsyncHeaders: object

type

type: object

className

className: string = "GeneratedClientComposeCustomModelsAsyncHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: string = "String"

Const GeneratedClientCopyCustomModelHeaders

GeneratedClientCopyCustomModelHeaders: object

type

type: object

className

className: string = "GeneratedClientCopyCustomModelHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

name: string = "String"

Const GeneratedClientGenerateModelCopyAuthorizationHeaders

GeneratedClientGenerateModelCopyAuthorizationHeaders: object

type

type: object

className

className: string = "GeneratedClientGenerateModelCopyAuthorizationHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: string = "String"

Const GeneratedClientTrainCustomModelAsyncHeaders

GeneratedClientTrainCustomModelAsyncHeaders: object

type

type: object

className

className: string = "GeneratedClientTrainCustomModelAsyncHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: string = "String"

Const KeyValueElement

KeyValueElement: object

type

type: object

className

className: string = "KeyValueElement"

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

type

type: object

name

name: string = "Number"

elements

elements: object

serializedName

serializedName: string = "elements"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

text

text: object

required

required: boolean = true

serializedName

serializedName: string = "text"

type

type: object

name

name: string = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: string = "String"

Const KeyValuePair

KeyValuePair: object

type

type: object

className

className: string = "KeyValuePair"

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 = "KeyValueElement"

name

name: string = "Composite"

label

label: object

serializedName

serializedName: string = "label"

type

type: object

name

name: string = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

className

className: string = "KeyValueElement"

name

name: string = "Composite"

Const KeysResult

KeysResult: object

type

type: object

className

className: string = "KeysResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

clusters

clusters: object

required

required: boolean = true

serializedName

serializedName: string = "clusters"

type

type: object

name

name: string = "Dictionary"

value

value: object

constraints

constraints: object

UniqueItems

UniqueItems: boolean = true

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const Model

Model: object

type

type: object

className

className: string = "Model"

name

name: string = "Composite"

modelProperties

modelProperties: object

composedTrainResults

composedTrainResults: object

serializedName

serializedName: string = "composedTrainResults"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "TrainResult"

name

name: string = "Composite"

keys

keys: object

serializedName

serializedName: string = "keys"

type

type: object

className

className: string = "KeysResult"

name

name: string = "Composite"

modelInfo

modelInfo: object

serializedName

serializedName: string = "modelInfo"

type

type: object

className

className: string = "ModelInfo"

name

name: string = "Composite"

trainResult

trainResult: object

serializedName

serializedName: string = "trainResult"

type

type: object

className

className: string = "TrainResult"

name

name: string = "Composite"

Const ModelInfo

ModelInfo: object

type

type: object

className

className: string = "ModelInfo"

name

name: string = "Composite"

modelProperties

modelProperties: object

attributes

attributes: object

serializedName

serializedName: string = "attributes"

type

type: object

className

className: string = "Attributes"

name

name: string = "Composite"

modelId

modelId: object

required

required: boolean = true

serializedName

serializedName: string = "modelId"

type

type: object

name

name: string = "Uuid"

modelName

modelName: object

serializedName

serializedName: string = "modelName"

type

type: object

name

name: string = "String"

status

status: object

required

required: boolean = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["creating", "ready", "invalid"]

name

name: string = "Enum"

trainingCompletedOn

trainingCompletedOn: object

required

required: boolean = true

serializedName

serializedName: string = "lastUpdatedDateTime"

type

type: object

name

name: string = "DateTime"

trainingStartedOn

trainingStartedOn: object

required

required: boolean = true

serializedName

serializedName: string = "createdDateTime"

type

type: object

name

name: string = "DateTime"

Const Models

Models: object

type

type: object

className

className: string = "Models"

name

name: string = "Composite"

modelProperties

modelProperties: object

modelList

modelList: object

serializedName

serializedName: string = "modelList"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ModelInfo"

name

name: string = "Composite"

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

summary

summary: object

serializedName

serializedName: string = "summary"

type

type: object

className

className: string = "ModelsSummary"

name

name: string = "Composite"

Const ModelsSummary

ModelsSummary: object

type

type: object

className

className: string = "ModelsSummary"

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"

lastModified

lastModified: object

required

required: boolean = true

serializedName

serializedName: string = "lastUpdatedDateTime"

type

type: object

name

name: string = "DateTime"

limit

limit: object

required

required: boolean = true

serializedName

serializedName: string = "limit"

type

type: object

name

name: string = "Number"

Const PageResult

PageResult: object

type

type: object

className

className: string = "PageResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

clusterId

clusterId: object

serializedName

serializedName: string = "clusterId"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: string = "Number"

keyValuePairs

keyValuePairs: object

serializedName

serializedName: string = "keyValuePairs"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "KeyValuePair"

name

name: string = "Composite"

pageNumber

pageNumber: object

required

required: boolean = true

serializedName

serializedName: string = "page"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: string = "Number"

tables

tables: object

serializedName

serializedName: string = "tables"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DataTable"

name

name: string = "Composite"

Const ReadResult

ReadResult: object

type

type: object

className

className: string = "ReadResult"

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

serializedName

serializedName: string = "lines"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "TextLine"

name

name: string = "Composite"

pageNumber

pageNumber: object

required

required: boolean = true

serializedName

serializedName: string = "page"

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 = "SelectionMark"

name

name: string = "Composite"

unit

unit: object

required

required: boolean = true

serializedName

serializedName: string = "unit"

type

type: object

allowedValues

allowedValues: string[] = ["pixel", "inch"]

name

name: string = "Enum"

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"

Const SelectionMark

SelectionMark: object

type

type: object

className

className: string = "SelectionMark"

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

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"

state

state: object

required

required: boolean = true

serializedName

serializedName: string = "state"

type

type: object

allowedValues

allowedValues: string[] = ["selected", "unselected"]

name

name: string = "Enum"

Const SourcePath

SourcePath: object

type

type: object

className

className: string = "SourcePath"

name

name: string = "Composite"

modelProperties

modelProperties: object

source

source: object

serializedName

serializedName: string = "source"

constraints

constraints: object

MaxLength

MaxLength: number = 2048

type

type: object

name

name: string = "String"

Const TextAppearance

TextAppearance: object

type

type: object

className

className: string = "TextAppearance"

name

name: string = "Composite"

modelProperties

modelProperties: object

style

style: object

serializedName

serializedName: string = "style"

type

type: object

className

className: string = "TextStyle"

name

name: string = "Composite"

Const TextLine

TextLine: object

type

type: object

className

className: string = "TextLine"

name

name: string = "Composite"

modelProperties

modelProperties: object

appearance

appearance: object

serializedName

serializedName: string = "appearance"

type

type: object

className

className: string = "TextAppearance"

name

name: string = "Composite"

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

type

type: object

name

name: string = "Number"

text

text: object

required

required: boolean = true

serializedName

serializedName: string = "text"

type

type: object

name

name: string = "String"

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 = "TextWord"

name

name: string = "Composite"

Const TextStyle

TextStyle: object

type

type: object

className

className: string = "TextStyle"

name

name: string = "Composite"

modelProperties

modelProperties: object

confidence

confidence: object

required

required: boolean = true

serializedName

serializedName: string = "confidence"

type

type: object

name

name: string = "Number"

name

name: object

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

allowedValues

allowedValues: string[] = ["other", "handwriting"]

name

name: string = "Enum"

Const TextWord

TextWord: object

type

type: object

className

className: string = "TextWord"

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

type

type: object

name

name: string = "Number"

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"

text

text: object

required

required: boolean = true

serializedName

serializedName: string = "text"

type

type: object

name

name: string = "String"

Const TrainRequest

TrainRequest: object

type

type: object

className

className: string = "TrainRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

modelName

modelName: object

serializedName

serializedName: string = "modelName"

type

type: object

name

name: string = "String"

source

source: object

required

required: boolean = true

serializedName

serializedName: string = "source"

constraints

constraints: object

MaxLength

MaxLength: number = 2048

type

type: object

name

name: string = "String"

sourceFilter

sourceFilter: object

serializedName

serializedName: string = "sourceFilter"

type

type: object

className

className: string = "TrainSourceFilter"

name

name: string = "Composite"

useLabelFile

useLabelFile: object

serializedName

serializedName: string = "useLabelFile"

type

type: object

name

name: string = "Boolean"

Const TrainResult

TrainResult: object

type

type: object

className

className: string = "TrainResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

averageModelAccuracy

averageModelAccuracy: object

serializedName

serializedName: string = "averageModelAccuracy"

type

type: object

name

name: string = "Number"

errors

errors: object

serializedName

serializedName: string = "errors"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorInformation"

name

name: string = "Composite"

fields

fields: object

serializedName

serializedName: string = "fields"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "FormFieldsReport"

name

name: string = "Composite"

modelId

modelId: object

serializedName

serializedName: string = "modelId"

type

type: object

name

name: string = "Uuid"

trainingDocuments

trainingDocuments: object

required

required: boolean = true

serializedName

serializedName: string = "trainingDocuments"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "TrainingDocumentInfo"

name

name: string = "Composite"

Const TrainSourceFilter

TrainSourceFilter: object

type

type: object

className

className: string = "TrainSourceFilter"

name

name: string = "Composite"

modelProperties

modelProperties: object

includeSubfolders

includeSubfolders: object

serializedName

serializedName: string = "includeSubFolders"

type

type: object

name

name: string = "Boolean"

prefix

prefix: object

serializedName

serializedName: string = "prefix"

constraints

constraints: object

MaxLength

MaxLength: number = 1024

type

type: object

name

name: string = "String"

Const TrainingDocumentInfo

TrainingDocumentInfo: object

type

type: object

className

className: string = "TrainingDocumentInfo"

name

name: string = "Composite"

modelProperties

modelProperties: object

errors

errors: object

required

required: boolean = true

serializedName

serializedName: string = "errors"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorInformation"

name

name: string = "Composite"

name

name: object

required

required: boolean = true

serializedName

serializedName: string = "documentName"

type

type: object

name

name: string = "String"

pageCount

pageCount: object

required

required: boolean = true

serializedName

serializedName: string = "pages"

type

type: object

name

name: string = "Number"

status

status: object

required

required: boolean = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["succeeded", "partiallySucceeded", "failed"]

name

name: string = "Enum"

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 accept2

accept2: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/json, text/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

name: string = "String"

Const analyzeBusinessCardAsync$binaryOperationSpec

analyzeBusinessCardAsync$binaryOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "binary"

path

path: string = "/prebuilt/businessCard/analyze"

queryParameters

queryParameters: any[] = [Parameters.includeTextDetails,Parameters.pages,Parameters.locale]

requestBody

requestBody: any = Parameters.fileStream

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

202

202: object

headersMapper

headersMapper: any = Mappers.GeneratedClientAnalyzeBusinessCardAsyncHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const analyzeBusinessCardAsync$jsonOperationSpec

analyzeBusinessCardAsync$jsonOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/prebuilt/businessCard/analyze"

queryParameters

queryParameters: any[] = [Parameters.includeTextDetails,Parameters.pages,Parameters.locale]

requestBody

requestBody: any = Parameters.fileStream1

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

202

202: object

headersMapper

headersMapper: any = Mappers.GeneratedClientAnalyzeBusinessCardAsyncHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const analyzeIdDocumentAsync$binaryOperationSpec

analyzeIdDocumentAsync$binaryOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "binary"

path

path: string = "/prebuilt/idDocument/analyze"

queryParameters

queryParameters: any[] = [Parameters.includeTextDetails, Parameters.pages]

requestBody

requestBody: any = Parameters.fileStream

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

202

202: object

headersMapper

headersMapper: any = Mappers.GeneratedClientAnalyzeIdDocumentAsyncHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const analyzeIdDocumentAsync$jsonOperationSpec

analyzeIdDocumentAsync$jsonOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/prebuilt/idDocument/analyze"

queryParameters

queryParameters: any[] = [Parameters.includeTextDetails, Parameters.pages]

requestBody

requestBody: any = Parameters.fileStream1

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

202

202: object

headersMapper

headersMapper: any = Mappers.GeneratedClientAnalyzeIdDocumentAsyncHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const analyzeInvoiceAsync$binaryOperationSpec

analyzeInvoiceAsync$binaryOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "binary"

path

path: string = "/prebuilt/invoice/analyze"

queryParameters

queryParameters: any[] = [Parameters.includeTextDetails,Parameters.pages,Parameters.locale]

requestBody

requestBody: any = Parameters.fileStream

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

202

202: object

headersMapper

headersMapper: any = Mappers.GeneratedClientAnalyzeInvoiceAsyncHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const analyzeInvoiceAsync$jsonOperationSpec

analyzeInvoiceAsync$jsonOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/prebuilt/invoice/analyze"

queryParameters

queryParameters: any[] = [Parameters.includeTextDetails,Parameters.pages,Parameters.locale]

requestBody

requestBody: any = Parameters.fileStream1

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

202

202: object

headersMapper

headersMapper: any = Mappers.GeneratedClientAnalyzeInvoiceAsyncHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const analyzeLayoutAsync$binaryOperationSpec

analyzeLayoutAsync$binaryOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "binary"

path

path: string = "/layout/analyze"

queryParameters

queryParameters: any[] = [Parameters.pages,Parameters.language,Parameters.readingOrder]

requestBody

requestBody: any = Parameters.fileStream

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

202

202: object

headersMapper

headersMapper: any = Mappers.GeneratedClientAnalyzeLayoutAsyncHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const analyzeLayoutAsync$jsonOperationSpec

analyzeLayoutAsync$jsonOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/layout/analyze"

queryParameters

queryParameters: any[] = [Parameters.pages,Parameters.language,Parameters.readingOrder]

requestBody

requestBody: any = Parameters.fileStream1

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

202

202: object

headersMapper

headersMapper: any = Mappers.GeneratedClientAnalyzeLayoutAsyncHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const analyzeReceiptAsync$binaryOperationSpec

analyzeReceiptAsync$binaryOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "binary"

path

path: string = "/prebuilt/receipt/analyze"

queryParameters

queryParameters: any[] = [Parameters.includeTextDetails,Parameters.pages,Parameters.locale]

requestBody

requestBody: any = Parameters.fileStream

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

202

202: object

headersMapper

headersMapper: any = Mappers.GeneratedClientAnalyzeReceiptAsyncHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const analyzeReceiptAsync$jsonOperationSpec

analyzeReceiptAsync$jsonOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/prebuilt/receipt/analyze"

queryParameters

queryParameters: any[] = [Parameters.includeTextDetails,Parameters.pages,Parameters.locale]

requestBody

requestBody: any = Parameters.fileStream1

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

202

202: object

headersMapper

headersMapper: any = Mappers.GeneratedClientAnalyzeReceiptAsyncHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const analyzeWithCustomModel$binaryOperationSpec

analyzeWithCustomModel$binaryOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "binary"

path

path: string = "/custom/models/{modelId}/analyze"

queryParameters

queryParameters: any[] = [Parameters.includeTextDetails, Parameters.pages]

requestBody

requestBody: any = Parameters.fileStream

serializer

serializer: any

urlParameters

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

responses

responses: object

202

202: object

headersMapper

headersMapper: any = Mappers.GeneratedClientAnalyzeWithCustomModelHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const analyzeWithCustomModel$jsonOperationSpec

analyzeWithCustomModel$jsonOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/custom/models/{modelId}/analyze"

queryParameters

queryParameters: any[] = [Parameters.includeTextDetails, Parameters.pages]

requestBody

requestBody: any = Parameters.fileStream1

serializer

serializer: any

urlParameters

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

responses

responses: object

202

202: object

headersMapper

headersMapper: any = Mappers.GeneratedClientAnalyzeWithCustomModelHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const composeCustomModelsAsyncOperationSpec

composeCustomModelsAsyncOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/custom/models/compose"

requestBody

requestBody: any = Parameters.composeRequest

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

201

201: object

headersMapper

headersMapper: any = Mappers.GeneratedClientComposeCustomModelsAsyncHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const composeRequest

composeRequest: object

mapper

mapper: any = ComposeRequestMapper

parameterPath

parameterPath: string = "composeRequest"

Const contentType

contentType: 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 contentType1

contentType1: object

parameterPath

parameterPath: string = "contentType"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

allowedValues

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

name

name: string = "Enum"

Const contentType2

contentType2: 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 copyCustomModelOperationSpec

copyCustomModelOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/custom/models/{modelId}/copy"

requestBody

requestBody: any = Parameters.copyRequest

serializer

serializer: any

urlParameters

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

responses

responses: object

202

202: object

headersMapper

headersMapper: any = Mappers.GeneratedClientCopyCustomModelHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const copyRequest

copyRequest: object

mapper

mapper: any = CopyRequestMapper

parameterPath

parameterPath: string = "copyRequest"

Const deleteCustomModelOperationSpec

deleteCustomModelOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/custom/models/{modelId}"

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 fileStream

fileStream: object

parameterPath

parameterPath: string = "fileStream"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "fileStream"

type

type: object

name

name: string = "Stream"

Const fileStream1

fileStream1: object

mapper

mapper: any = SourcePathMapper

parameterPath

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

Const generateModelCopyAuthorizationOperationSpec

generateModelCopyAuthorizationOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "POST"

path

path: string = "/custom/models/copyAuthorization"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

201

201: object

bodyMapper

bodyMapper: any = Mappers.CopyAuthorizationResult

headersMapper

headersMapper: any = Mappers.GeneratedClientGenerateModelCopyAuthorizationHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getAnalyzeBusinessCardResultOperationSpec

getAnalyzeBusinessCardResultOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/prebuilt/businessCard/analyzeResults/{resultId}"

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.AnalyzeOperationResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getAnalyzeFormResultOperationSpec

getAnalyzeFormResultOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/custom/models/{modelId}/analyzeResults/{resultId}"

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.AnalyzeOperationResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getAnalyzeIdDocumentResultOperationSpec

getAnalyzeIdDocumentResultOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/prebuilt/idDocument/analyzeResults/{resultId}"

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.AnalyzeOperationResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getAnalyzeInvoiceResultOperationSpec

getAnalyzeInvoiceResultOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/prebuilt/invoice/analyzeResults/{resultId}"

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.AnalyzeOperationResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getAnalyzeLayoutResultOperationSpec

getAnalyzeLayoutResultOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/layout/analyzeResults/{resultId}"

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.AnalyzeOperationResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getAnalyzeReceiptResultOperationSpec

getAnalyzeReceiptResultOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/prebuilt/receipt/analyzeResults/{resultId}"

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.AnalyzeOperationResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getCustomModelCopyResultOperationSpec

getCustomModelCopyResultOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/custom/models/{modelId}/copyResults/{resultId}"

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.CopyOperationResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getCustomModelOperationSpec

getCustomModelOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/custom/models/{modelId}"

queryParameters

queryParameters: any[] = [Parameters.includeKeys]

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.Model

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getCustomModelsOperationSpec

getCustomModelsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/custom/models"

queryParameters

queryParameters: any[] = [Parameters.op1]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.Models

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const includeKeys

includeKeys: object

parameterPath

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

mapper

mapper: object

serializedName

serializedName: string = "includeKeys"

type

type: object

name

name: string = "Boolean"

Const includeTextDetails

includeTextDetails: object

parameterPath

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

mapper

mapper: object

serializedName

serializedName: string = "includeTextDetails"

type

type: object

name

name: string = "Boolean"

Const language

language: object

parameterPath

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

mapper

mapper: object

serializedName

serializedName: string = "language"

type

type: object

name

name: string = "String"

Const listCustomModelsNextOperationSpec

listCustomModelsNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.op]

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.Models

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const listCustomModelsOperationSpec

listCustomModelsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/custom/models"

queryParameters

queryParameters: any[] = [Parameters.op]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.Models

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"

type

type: object

name

name: string = "Uuid"

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 op

op: object

parameterPath

parameterPath: string = "op"

mapper

mapper: object

defaultValue

defaultValue: string = "full"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "op"

type

type: object

name

name: string = "String"

Const op1

op1: object

parameterPath

parameterPath: string = "op"

mapper

mapper: object

defaultValue

defaultValue: string = "summary"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "op"

type

type: object

name

name: string = "String"

Const pages

pages: object

parameterPath

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

mapper

mapper: object

serializedName

serializedName: string = "pages"

type

type: object

name

name: string = "Sequence"

element

element: object

constraints

constraints: object

Pattern

Pattern: any = new RegExp("(^[0-9]+-[0-9]+$)|(^[0-9]+$)")

type

type: object

name

name: string = "String"

Const readingOrder

readingOrder: object

parameterPath

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

mapper

mapper: object

defaultValue

defaultValue: string = "basic"

serializedName

serializedName: string = "readingOrder"

type

type: object

allowedValues

allowedValues: string[] = ["basic", "natural"]

name

name: string = "Enum"

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 = "Uuid"

Const trainCustomModelAsyncOperationSpec

trainCustomModelAsyncOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/custom/models"

requestBody

requestBody: any = Parameters.trainRequest

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

201

201: object

headersMapper

headersMapper: any = Mappers.GeneratedClientTrainCustomModelAsyncHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const trainRequest

trainRequest: object

mapper

mapper: any = TrainRequestMapper

parameterPath

parameterPath: string = "trainRequest"

Generated using TypeDoc