@azure/ai-form-recognizer

Index

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

BeginCopyModelOptions

BeginCopyModelOptions: FormRecognizerOperationOptions & FormTrainingPollOperationOptions<CopyModelOperationState>

Options for begin copy model operation

BeginCopyModelPollerOptions

BeginCopyModelPollerOptions: { client: CopyModelPollerClient; copyAuthorization: CopyAuthorization; modelId: string; onProgress?: undefined | ((state: BeginCopyModelPollState) => void); resultId?: undefined | string; resumeFrom?: undefined | string; targetResourceId: string; targetResourceRegion: string; updateIntervalInMs?: undefined | number } & CopyModelOptions

internal

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[]; resumeFrom?: undefined | string; updateIntervalInMs?: undefined | number }

Options for the start content/layout recognition operation

BeginRecognizeContentPollerOptions

BeginRecognizeContentPollerOptions: { client: RecognizeContentPollerClient; contentType?: FormContentType; onProgress?: undefined | ((state: BeginRecognizeContentPollState) => void); resultId?: undefined | string; resumeFrom?: undefined | string; source: FormRecognizerRequestBody | string; updateIntervalInMs?: undefined | number } & RecognizeContentOptions

internal

BeginRecognizeFormsOptions

BeginRecognizeFormsOptions: RecognizeFormsOptions & { contentType?: FormContentType; onProgress?: undefined | ((state: RecognizeFormsOperationState) => void); resumeFrom?: undefined | string; updateIntervalInMs?: undefined | number }

Shared options for starting form recognition operations.

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

CopyModelOptions: FormRecognizerOperationOptions

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

beginCopyModel: (modelId: string, copyAuthorization: CopyAuthorization, copyModelOptions?: CopyModelOptions) => Promise<CopyCustomModelResponseModel>
- - (modelId: string, copyAuthorization: CopyAuthorization, copyModelOptions?: CopyModelOptions): Promise<CopyCustomModelResponseModel>
  - Parameters
    - modelId: string
    - copyAuthorization: CopyAuthorization
    - Optional copyModelOptions: CopyModelOptions
    Returns Promise<CopyCustomModelResponseModel>
getCopyModelResult: (modelId: string, resultId: string, options: GetCopyModelResultOptions) => Promise<GetCustomModelCopyResultResponse>
- - (modelId: string, resultId: string, options: GetCopyModelResultOptions): Promise<GetCustomModelCopyResultResponse>
  - Parameters
    - modelId: string
    - resultId: string
    - options: GetCopyModelResultOptions
    Returns Promise<GetCustomModelCopyResultResponse>

DeleteModelOptions

DeleteModelOptions: FormRecognizerOperationOptions

Options for the delete model operation.

FieldValueSelectionMark

FieldValueSelectionMark: "selected" | "unselected" | string

Defines values for FieldValueSelectionMark.

FieldValueType

Defines values for FieldValueType.

FormContentType

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

Content types supported by Form Recognizer service.

FormElement

FormElement: FormWord | FormLine | FormSelectionMark

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

FormField

FormField: { confidence?: undefined | number; labelData?: FieldData; name?: undefined | string; valueData?: FieldData } & { value?: undefined | string; valueType?: undefined | "string" } | { value?: undefined | number; valueType?: undefined | "number" } | { value?: Date; valueType?: undefined | "date" } | { value?: undefined | string; valueType?: undefined | "time" } | { value?: undefined | string; valueType?: undefined | "phoneNumber" } | { value?: undefined | number; valueType?: undefined | "integer" } | { value?: FormField[]; valueType?: undefined | "array" } | { value?: Record<string, FormField>; valueType?: undefined | "object" } | { value?: SelectionMarkState; valueType?: undefined | "selectionMark" }

Represents recognized text elements in label-value pairs. For example, "Address": "One Microsoft Way, Redmond, WA"

FormModelResponse

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

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

FormPollerLike

FormPollerLike: PollerLike<RecognizeFormsOperationState, RecognizedFormArray>

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.

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.

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.

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

GetModelOptions: FormRecognizerOperationOptions

Options for the get model operation.

GetRecognizedContentResultOptions

GetRecognizedContentResultOptions: FormRecognizerOperationOptions

Options for retrieving recognized content data

KeyValueType

KeyValueType: "string" | "selectionMark" | string

Defines values for KeyValueType.

Language

Language: "en" | "es" | "de" | "fr" | "it" | "nl" | "pt" | "zh-Hans" | string

Defines values for Language.

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

ListModelsOptions: FormRecognizerOperationOptions

Options for model listing operation.

Locale

Defines values for Locale.

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?: RecognizeContentOptions) => 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

beginRecognize: (source: FormRecognizerRequestBody | string, contentType?: FormContentType, analyzeOptions?: RecognizeContentOptions) => Promise<AnalyzeLayoutAsyncResponseModel>
- - (source: FormRecognizerRequestBody | string, contentType?: FormContentType, analyzeOptions?: RecognizeContentOptions): Promise<AnalyzeLayoutAsyncResponseModel>
  - Parameters
    - source: FormRecognizerRequestBody | string
    - Optional contentType: FormContentType
    - Optional analyzeOptions: RecognizeContentOptions
    Returns Promise<AnalyzeLayoutAsyncResponseModel>
getRecognizeResult: (resultId: string, options: { abortSignal?: AbortSignalLike }) => Promise<RecognizeContentResultResponse>
- - (resultId: string, options: { abortSignal?: AbortSignalLike }): Promise<RecognizeContentResultResponse>
  - Parameters
    - resultId: string
    - options: { abortSignal?: AbortSignalLike }
      - Optional abortSignal?: AbortSignalLike
    Returns Promise<RecognizeContentResultResponse>

RecognizeContentResultResponse

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

Contains response data for the Recognize Content operation.

RecognizeFormResultResponse

RecognizeFormResultResponse: RecognizedForms & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: AnalyzeOperationResultModel } }

Contains the response data for recognize form operation using a custom model from training.

RecognizeFormsOptions

RecognizeFormsOptions: FormRecognizerOperationOptions & { includeFieldElements?: undefined | false | true }

Options for recognition of forms

SelectionMarkState

SelectionMarkState: "selected" | "unselected" | string

Defines values for SelectionMarkState.

TextStyle

TextStyle: "other" | "handwriting" | string

Defines values for TextStyle.

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

getCustomModel: (modelId: string, options: GetModelOptions) => Promise<FormModelResponse>
- - (modelId: string, options: GetModelOptions): Promise<FormModelResponse>
  - Parameters
    - modelId: string
    - options: GetModelOptions
    Returns Promise<FormModelResponse>
trainCustomModelInternal: (source: string | string[], useLabelFile?: undefined | false | true, options?: TrainingFileFilter) => Promise<TrainCustomModelAsyncResponse>
- - (source: string | string[], useLabelFile?: undefined | false | true, options?: TrainingFileFilter): Promise<TrainCustomModelAsyncResponse>
  - Parameters
    - source: string | string[]
    - Optional useLabelFile: undefined | false | true
    - Optional options: TrainingFileFilter
    Returns Promise<TrainCustomModelAsyncResponse>

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 MAX_INPUT_DOCUMENT_SIZE

MAX_INPUT_DOCUMENT_SIZE: number = 50 * 1024 * 1024

Maximum size of input documents allowed by the Azure Form Recognizer service.

internal

Const SDK_VERSION

SDK_VERSION: string = "3.1.0-beta.1"

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-beta.1" = "3.1.0-beta.1"

Const serializer

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

Const textPattern

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

Functions

composeModelInternal

composeModelInternal(client: GeneratedClient, modelIds: string[], options?: BeginCreateComposedModelOptions): Promise<GeneratedClientComposeCustomModelsAsyncResponse>

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/formTrainingClient.ts:783
internal

Parameters
- client: GeneratedClient
- modelIds: string[]
- Optional options: BeginCreateComposedModelOptions
Returns Promise<GeneratedClientComposeCustomModelsAsyncResponse>

createFormRecognizerAzureKeyCredentialPolicy

createFormRecognizerAzureKeyCredentialPolicy(credential: KeyCredential): RequestPolicyFactory

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/azureKeyCredentialPolicy.ts:21
Create an HTTP pipeline policy to authenticate a request using an AzureKeyCredential for Azure Form Recognizer

Parameters
- credential: KeyCredential
Returns RequestPolicyFactory

flattenCustomFormSubmodels

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

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/transforms.ts:448
Parameters
- original: GetCustomModelResponse
Returns CustomFormSubmodel[] | undefined

flattenTrainingDocuments

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

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/transforms.ts:371
Parameters
- original: GetCustomModelResponse
Returns TrainingDocumentInfo[] | undefined

getContentType

getContentType(data: Blob | ArrayBuffer | ArrayBufferView | SourcePath): Promise<FormContentType | undefined>

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/common.ts:76
Detects the content type of binary data. See https://en.wikipedia.org/wiki/List_of_file_signatures

internal

Parameters
- data: Blob | ArrayBuffer | ArrayBufferView | SourcePath
Returns Promise<FormContentType | undefined>

getFirstFourBytesFromBlob

getFirstFourBytesFromBlob(_data: Blob): Promise<Uint8Array>

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/utils/utils.node.ts:62
Parameters
- _data: Blob
Returns Promise<Uint8Array>

isArrayBuffer

isArrayBuffer(data: FormRecognizerRequestBody): data is ArrayBuffer

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/common.ts:59
Parameters
- data: FormRecognizerRequestBody
Returns data is ArrayBuffer

isArrayBufferView

isArrayBufferView(data: FormRecognizerRequestBody): data is ArrayBufferView

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/common.ts:63
Parameters
- data: FormRecognizerRequestBody
Returns data is ArrayBufferView

isBlob

isBlob(data: FormRecognizerRequestBody): data is Blob

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/common.ts:55
Parameters
- data: FormRecognizerRequestBody
Returns data is Blob

isReadableStream

isReadableStream(data: FormRecognizerRequestBody): data is NodeJS.ReadableStream

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/common.ts:51
Parameters
- data: FormRecognizerRequestBody
Returns data is NodeJS.ReadableStream

isSourcePath

isSourcePath(data: FormRecognizerRequestBody | SourcePath): data is SourcePath

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/common.ts:67
Parameters
- data: FormRecognizerRequestBody | SourcePath
Returns data is SourcePath

makeFormRecognitionOperation

makeFormRecognitionOperation(description: FormPollerOperationDescription, initialState: RecognizeFormsOperationState): PollOperation<typeof initialState, RecognizedFormArray>

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/lro/analyze/recognitionPoller.ts:77
Create a form recognition poll operation.

This operation handles the creation, polling, and transformation of results.

internal

Parameters
- description: FormPollerOperationDescription
- initialState: RecognizeFormsOperationState
Returns PollOperation<typeof initialState, RecognizedFormArray>

makeSpanner

makeSpanner<Options>(prefix: string, options: Options): Spanner<Options>

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/formRecognizerClient.ts:1018
Helper function to create spans for internal polling handlers

The argument is a handler function that will be wrapped in a tracing span, where tracing-updated options will be inserted as its first parameter.
example
```
const spanned = makeSpanner("FormRecognizerClient-beginRecognizeReceipts", {
  ...options,
  // Override any options you need here
});

const autoSpannedFunction = spanner("autoSpannedFunction", (updatedOptions) => {
 // ...
});
```
internal
Type parameters
- Options: OperationOptions
Parameters
- prefix: string
- options: Options
Returns Spanner<Options>

processOperationLocation

processOperationLocation(__namedParameters: { operationLocation: undefined | string }): string

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/formRecognizerClient.ts:966
Validates a remote operation's location is defined and extracts the result ID from it.

internal

Parameters
- __namedParameters: { operationLocation: undefined | string }
  - operationLocation: undefined | string
Returns string

the remote operation ID

recognizeLayoutInternal

recognizeLayoutInternal(client: GeneratedClient, body: FormRecognizerRequestBody | string, contentType?: FormContentType, options?: RecognizeContentOptions, _modelId?: undefined | string): Promise<AnalyzeLayoutAsyncResponseModel>

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/formRecognizerClient.ts:1046
The worker function of layout analysis.

internal

Parameters
- client: GeneratedClient
- body: FormRecognizerRequestBody | string
- Optional contentType: FormContentType
- Optional options: RecognizeContentOptions
- Optional _modelId: undefined | string
Returns Promise<AnalyzeLayoutAsyncResponseModel>

streamToBuffer

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

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/utils/utils.node.ts:15
Reads a readable stream into buffer entirely. NodeJS only. The maximum allowed size is specified in MAX_INPUT_DOCUMENT_SIZE.

export

throws

{Error} If buffer size is not big enough.

Parameters
- stream: NodeJS.ReadableStream
  
  A Node.js Readable stream
- maxSize: number
Returns Promise<Buffer>

The resultant buffer.

toBoundingBox

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

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/transforms.ts:42
Parameters
- original: number[]
Returns Point2D[]

toCustomFormModelProperties

toCustomFormModelProperties(original: Attributes | undefined): CustomFormModelProperties | undefined

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/transforms.ts:465
Parameters
- original: Attributes | undefined
Returns CustomFormModelProperties | undefined

toFieldData

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

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/transforms.ts:113
Parameters
- pageNumber: number
- original: KeyValueElementModel
- Optional readResults: FormPage[]
Returns FieldData

toFieldsFromFieldValue

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

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/transforms.ts:277
Parameters
- original: {}
  - [propertyName: string]: FieldValueModel | null
- readResults: FormPage[]
Returns {}
- [propertyName: string]: FormField

toFieldsFromKeyValuePairs

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

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/transforms.ts:297
Parameters
- pageNumber: number
- original: KeyValuePairModel[]
- pages: FormPage[]
Returns {}
- [propertyName: string]: FormField

toFormContent

toFormContent(element: string, readResults: FormPage[]): FormElement

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/transforms.ts:97
Parameters
- element: string
- readResults: FormPage[]
Returns FormElement

toFormFieldFromFieldValueModel

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

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/transforms.ts:216
Parameters
- original: FieldValueModel
- key: string
- readResults: FormPage[]
Returns FormField

toFormFieldFromKeyValuePairModel

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

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/transforms.ts:126
Parameters
- pageNumber: number
- original: KeyValuePairModel
- Optional readResults: FormPage[]
Returns FormField

toFormFromPageResult

toFormFromPageResult(original: PageResultModel, pages: FormPage[]): RecognizedForm

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/transforms.ts:314
Parameters
- original: PageResultModel
- pages: FormPage[]
Returns RecognizedForm

toFormModelResponse

toFormModelResponse(response: GetCustomModelResponse): FormModelResponse

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/transforms.ts:477
Parameters
- response: GetCustomModelResponse
Returns FormModelResponse

toFormPage

toFormPage(original: ReadResultModel): FormPage

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/transforms.ts:82
Parameters
- original: ReadResultModel
Returns FormPage

toFormPages

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

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/transforms.ts:167
Parameters
- Optional readResults: ReadResultModel[]
- Optional pageResults: PageResultModel[]
Returns FormPage[]

toFormTable

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

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/transforms.ts:141
Parameters
- original: DataTableModel
- readResults: FormPage[]
- pageNumber: number
Returns FormTable

toRecognizeContentResultResponse

toRecognizeContentResultResponse(original: GetAnalyzeLayoutResultResponse): RecognizeContentResultResponse

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/transforms.ts:338
Parameters
- original: GetAnalyzeLayoutResultResponse
Returns RecognizeContentResultResponse

toRecognizedForm

toRecognizedForm(original: DocumentResultModel, pages: FormPage[]): RecognizedForm

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/transforms.ts:325
Parameters
- original: DocumentResultModel
- pages: FormPage[]
Returns RecognizedForm

toRecognizedFormArray

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

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/transforms.ts:187
Parameters
- original: GetAnalyzeFormResultResponse
- Optional expectedDocType: undefined | string
Returns RecognizedFormArray

toRequestBody

toRequestBody(body: FormRecognizerRequestBody | string): Promise<Blob | ArrayBuffer | ArrayBufferView | SourcePath>

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/common.ts:34
Translate the content to a format that is understood by Form Recognizer service

internal

Parameters
- body: FormRecognizerRequestBody | string
Returns Promise<Blob | ArrayBuffer | ArrayBufferView | SourcePath>

toSelectionMark

toSelectionMark(original: SelectionMark, pageNumber: number): FormSelectionMark

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/transforms.ts:72
Parameters
- original: SelectionMark
- pageNumber: number
Returns FormSelectionMark

toSubmodelsFromComposedTrainResults

toSubmodelsFromComposedTrainResults(results: TrainResult[]): CustomFormSubmodel[]

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/transforms.ts:397
Parameters
- results: TrainResult[]
Returns CustomFormSubmodel[]

toSubmodelsFromTrainResultLabeled

toSubmodelsFromTrainResultLabeled(result: TrainResult, modelName?: undefined | string): CustomFormSubmodel[]

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/transforms.ts:404
Parameters
- result: TrainResult
- Optional modelName: undefined | string
Returns CustomFormSubmodel[]

toSubmodelsFromTrainResultUnlabeled

toSubmodelsFromTrainResultUnlabeled(keys: KeysResult, modelId: string): CustomFormSubmodel[]

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/transforms.ts:426
Parameters
- keys: KeysResult
- modelId: string
Returns CustomFormSubmodel[]

toTextLine

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

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/transforms.ts:51
Parameters
- original: TextLineModel
- pageNumber: number
Returns FormLine

trainCustomModelInternal

trainCustomModelInternal(client: GeneratedClient, source: string, useLabelFile?: undefined | false | true, options?: BeginTrainingOptions): Promise<GeneratedClientTrainCustomModelAsyncResponse>

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/formTrainingClient.ts:813
internal

Parameters
- client: GeneratedClient
- source: string
- Optional useLabelFile: undefined | false | true
- Optional options: BeginTrainingOptions
Returns Promise<GeneratedClientTrainCustomModelAsyncResponse>

Object literals

Const AnalyzeOperationResult

AnalyzeOperationResult: object

type

type: object

className

className: string = "AnalyzeOperationResult"

name

modelProperties

modelProperties: object

analyzeResult

analyzeResult: object

serializedName

serializedName: string = "analyzeResult"

type

type: object

className

className: string = "AnalyzeResult"

name

createdOn

createdOn: object

required

required: boolean = true

serializedName

serializedName: string = "createdDateTime"

type

type: object

name

lastModified

lastModified: object

required

required: boolean = true

serializedName

serializedName: string = "lastUpdatedDateTime"

type

type: object

name

status

status: object

required

required: boolean = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

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

name

Const AnalyzeResult

AnalyzeResult: object

type

type: object

className

className: string = "AnalyzeResult"

name

modelProperties

modelProperties: object

documentResults

documentResults: object

serializedName

serializedName: string = "documentResults"

type

type: object

name

element

element: object

type

type: object

className

className: string = "DocumentResult"

name

errors

errors: object

serializedName

serializedName: string = "errors"

type

type: object

name

element

element: object

type

type: object

className

className: string = "ErrorInformation"

name

pageResults

pageResults: object

serializedName

serializedName: string = "pageResults"

type

type: object

name

element

element: object

type

type: object

className

className: string = "PageResult"

name

readResults

readResults: object

required

required: boolean = true

serializedName

serializedName: string = "readResults"

type

type: object

name

element

element: object

type

type: object

className

className: string = "ReadResult"

name

version

version: object

required

required: boolean = true

serializedName

serializedName: string = "version"

type

type: object

name

Const Appearance

Appearance: object

type

type: object

className

className: string = "Appearance"

name

modelProperties

modelProperties: object

style

style: object

serializedName

serializedName: string = "style"

type

type: object

className

className: string = "Style"

name

Const Attributes

Attributes: object

type

type: object

className

className: string = "Attributes"

name

modelProperties

modelProperties: object

isComposed

isComposed: object

serializedName

serializedName: string = "isComposed"

type

type: object

name

Const ComposeRequest

ComposeRequest: object

type

type: object

className

className: string = "ComposeRequest"

name

modelProperties

modelProperties: object

modelIds

modelIds: object

required

required: boolean = true

serializedName

serializedName: string = "modelIds"

type

type: object

name

element

element: object

type

type: object

name

modelName

modelName: object

serializedName

serializedName: string = "modelName"

type

type: object

name

Const CopyAuthorizationResult

CopyAuthorizationResult: object

type

type: object

className

className: string = "CopyAuthorizationResult"

name

modelProperties

modelProperties: object

accessToken

accessToken: object

required

required: boolean = true

serializedName

serializedName: string = "accessToken"

type

type: object

name

expirationDateTimeTicks

expirationDateTimeTicks: object

required

required: boolean = true

serializedName

serializedName: string = "expirationDateTimeTicks"

type

type: object

name

modelId

modelId: object

required

required: boolean = true

serializedName

serializedName: string = "modelId"

type

type: object

name

Const CopyOperationResult

CopyOperationResult: object

type

type: object

className

className: string = "CopyOperationResult"

name

modelProperties

modelProperties: object

copyResult

copyResult: object

serializedName

serializedName: string = "copyResult"

type

type: object

className

className: string = "CopyResult"

name

createdOn

createdOn: object

required

required: boolean = true

serializedName

serializedName: string = "createdDateTime"

type

type: object

name

lastModified

lastModified: object

required

required: boolean = true

serializedName

serializedName: string = "lastUpdatedDateTime"

type

type: object

name

status

status: object

required

required: boolean = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

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

name

Const CopyRequest

CopyRequest: object

type

type: object

className

className: string = "CopyRequest"

name

modelProperties

modelProperties: object

copyAuthorization

copyAuthorization: object

serializedName

serializedName: string = "copyAuthorization"

type

type: object

className

className: string = "CopyAuthorizationResult"

name

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

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

Const CopyResult

CopyResult: object

type

type: object

className

className: string = "CopyResult"

name

modelProperties

modelProperties: object

errors

errors: object

serializedName

serializedName: string = "errors"

type

type: object

name

element

element: object

type

type: object

className

className: string = "ErrorInformation"

name

modelId

modelId: object

required

required: boolean = true

serializedName

serializedName: string = "modelId"

type

type: object

name

Const DataTable

DataTable: object

type

type: object

className

className: string = "DataTable"

name

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

element

element: object

type

type: object

name

cells

cells: object

required

required: boolean = true

serializedName

serializedName: string = "cells"

type

type: object

name

element

element: object

type

type: object

className

className: string = "DataTableCell"

name

columns

columns: object

required

required: boolean = true

serializedName

serializedName: string = "columns"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

rows

rows: object

required

required: boolean = true

serializedName

serializedName: string = "rows"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

Const DataTableCell

DataTableCell: object

type

type: object

className

className: string = "DataTableCell"

name

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

element

element: object

type

type: object

name

columnIndex

columnIndex: object

required

required: boolean = true

serializedName

serializedName: string = "columnIndex"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

columnSpan

columnSpan: object

defaultValue

defaultValue: number = 1

serializedName

serializedName: string = "columnSpan"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

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

elements

elements: object

serializedName

serializedName: string = "elements"

type

type: object

name

element

element: object

type

type: object

name

isFooter

isFooter: object

serializedName

serializedName: string = "isFooter"

type

type: object

name

isHeader

isHeader: object

serializedName

serializedName: string = "isHeader"

type

type: object

name

rowIndex

rowIndex: object

required

required: boolean = true

serializedName

serializedName: string = "rowIndex"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

rowSpan

rowSpan: object

defaultValue

defaultValue: number = 1

serializedName

serializedName: string = "rowSpan"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

text

text: object

required

required: boolean = true

serializedName

serializedName: string = "text"

type

type: object

name

Const DocumentResult

DocumentResult: object

type

type: object

className

className: string = "DocumentResult"

name

modelProperties

modelProperties: object

docType

docType: object

required

required: boolean = true

serializedName

serializedName: string = "docType"

type

type: object

name

docTypeConfidence

docTypeConfidence: object

serializedName

serializedName: string = "docTypeConfidence"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

fields

fields: object

required

required: boolean = true

serializedName

serializedName: string = "fields"

type

type: object

name

value

value: object

type

type: object

className

className: string = "FieldValue"

name

modelId

modelId: object

serializedName

serializedName: string = "modelId"

type

type: object

name

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

element

element: object

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

Const ErrorInformation

ErrorInformation: object

type

type: object

className

className: string = "ErrorInformation"

name

modelProperties

modelProperties: object

code

code: object

required

required: boolean = true

serializedName

serializedName: string = "code"

type

type: object

name

message

message: object

required

required: boolean = true

serializedName

serializedName: string = "message"

type

type: object

name

Const ErrorResponse

ErrorResponse: object

type

type: object

className

className: string = "ErrorResponse"

name

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "ErrorInformation"

name

Const FieldValue

FieldValue: object

type

type: object

className

className: string = "FieldValue"

name

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

element

element: object

type

type: object

name

confidence

confidence: object

serializedName

serializedName: string = "confidence"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

elements

elements: object

serializedName

serializedName: string = "elements"

type

type: object

name

element

element: object

type

type: object

name

pageNumber

pageNumber: object

serializedName

serializedName: string = "page"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

text

text: object

serializedName

serializedName: string = "text"

type

type: object

name

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"]

name

valueArray

valueArray: object

serializedName

serializedName: string = "valueArray"

type

type: object

name

element

element: object

type

type: object

className

className: string = "FieldValue"

name

valueDate

valueDate: object

serializedName

serializedName: string = "valueDate"

type

type: object

name

valueInteger

valueInteger: object

serializedName

serializedName: string = "valueInteger"

type

type: object

name

valueNumber

valueNumber: object

serializedName

serializedName: string = "valueNumber"

type

type: object

name

valueObject

valueObject: object

serializedName

serializedName: string = "valueObject"

type

type: object

name

value

value: object

type

type: object

className

className: string = "FieldValue"

name

valuePhoneNumber

valuePhoneNumber: object

serializedName

serializedName: string = "valuePhoneNumber"

type

type: object

name

valueSelectionMark

valueSelectionMark: object

serializedName

serializedName: string = "valueSelectionMark"

type

type: object

name

valueString

valueString: object

serializedName

serializedName: string = "valueString"

type

type: object

name

valueTime

valueTime: object

serializedName

serializedName: string = "valueTime"

type

type: object

name

Const FormFieldsReport

FormFieldsReport: object

type

type: object

className

className: string = "FormFieldsReport"

name

modelProperties

modelProperties: object

accuracy

accuracy: object

required

required: boolean = true

serializedName

serializedName: string = "accuracy"

type

type: object

name

fieldName

fieldName: object

required

required: boolean = true

serializedName

serializedName: string = "fieldName"

type

type: object

name

Const GeneratedClientAnalyzeBusinessCardAsyncHeaders

GeneratedClientAnalyzeBusinessCardAsyncHeaders: object

type

type: object

className

className: string = "GeneratedClientAnalyzeBusinessCardAsyncHeaders"

name

modelProperties

modelProperties: object

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

Const GeneratedClientAnalyzeInvoiceAsyncHeaders

GeneratedClientAnalyzeInvoiceAsyncHeaders: object

type

type: object

className

className: string = "GeneratedClientAnalyzeInvoiceAsyncHeaders"

name

modelProperties

modelProperties: object

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

Const GeneratedClientAnalyzeLayoutAsyncHeaders

GeneratedClientAnalyzeLayoutAsyncHeaders: object

type

type: object

className

className: string = "GeneratedClientAnalyzeLayoutAsyncHeaders"

name

modelProperties

modelProperties: object

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

Const GeneratedClientAnalyzeReceiptAsyncHeaders

GeneratedClientAnalyzeReceiptAsyncHeaders: object

type

type: object

className

className: string = "GeneratedClientAnalyzeReceiptAsyncHeaders"

name

modelProperties

modelProperties: object

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

Const GeneratedClientAnalyzeWithCustomModelHeaders

GeneratedClientAnalyzeWithCustomModelHeaders: object

type

type: object

className

className: string = "GeneratedClientAnalyzeWithCustomModelHeaders"

name

modelProperties

modelProperties: object

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

Const GeneratedClientComposeCustomModelsAsyncHeaders

GeneratedClientComposeCustomModelsAsyncHeaders: object

type

type: object

className

className: string = "GeneratedClientComposeCustomModelsAsyncHeaders"

name

modelProperties

modelProperties: object

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

Const GeneratedClientCopyCustomModelHeaders

GeneratedClientCopyCustomModelHeaders: object

type

type: object

className

className: string = "GeneratedClientCopyCustomModelHeaders"

name

modelProperties

modelProperties: object

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

Const GeneratedClientGenerateModelCopyAuthorizationHeaders

GeneratedClientGenerateModelCopyAuthorizationHeaders: object

type

type: object

className

className: string = "GeneratedClientGenerateModelCopyAuthorizationHeaders"

name

modelProperties

modelProperties: object

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

Const GeneratedClientTrainCustomModelAsyncHeaders

GeneratedClientTrainCustomModelAsyncHeaders: object

type

type: object

className

className: string = "GeneratedClientTrainCustomModelAsyncHeaders"

name

modelProperties

modelProperties: object

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

Const KeyValueElement

KeyValueElement: object

type

type: object

className

className: string = "KeyValueElement"

name

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

element

element: object

type

type: object

name

elements

elements: object

serializedName

serializedName: string = "elements"

type

type: object

name

element

element: object

type

type: object

name

text

text: object

required

required: boolean = true

serializedName

serializedName: string = "text"

type

type: object

name

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

Const KeyValuePair

KeyValuePair: object

type

type: object

className

className: string = "KeyValuePair"

name

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

key

key: object

serializedName

serializedName: string = "key"

type

type: object

className

className: string = "KeyValueElement"

name

label

label: object

serializedName

serializedName: string = "label"

type

type: object

name

value

value: object

serializedName

serializedName: string = "value"

type

type: object

className

className: string = "KeyValueElement"

name

Const KeysResult

KeysResult: object

type

type: object

className

className: string = "KeysResult"

name

modelProperties

modelProperties: object

clusters

clusters: object

required

required: boolean = true

serializedName

serializedName: string = "clusters"

type

type: object

name

value

value: object

constraints

constraints: object

UniqueItems

UniqueItems: boolean = true

type

type: object

name

element

element: object

type

type: object

name

Const Model

Model: object

type

type: object

className

className: string = "Model"

name

modelProperties

modelProperties: object

composedTrainResults

composedTrainResults: object

serializedName

serializedName: string = "composedTrainResults"

type

type: object

name

element

element: object

type

type: object

className

className: string = "TrainResult"

name

keys

keys: object

serializedName

serializedName: string = "keys"

type

type: object

className

className: string = "KeysResult"

name

modelInfo

modelInfo: object

serializedName

serializedName: string = "modelInfo"

type

type: object

className

className: string = "ModelInfo"

name

trainResult

trainResult: object

serializedName

serializedName: string = "trainResult"

type

type: object

className

className: string = "TrainResult"

name

Const ModelInfo

ModelInfo: object

type

type: object

className

className: string = "ModelInfo"

name

modelProperties

modelProperties: object

attributes

attributes: object

serializedName

serializedName: string = "attributes"

type

type: object

className

className: string = "Attributes"

name

modelId

modelId: object

required

required: boolean = true

serializedName

serializedName: string = "modelId"

type

type: object

name

modelName

modelName: object

serializedName

serializedName: string = "modelName"

type

type: object

name

status

status: object

required

required: boolean = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

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

name

trainingCompletedOn

trainingCompletedOn: object

required

required: boolean = true

serializedName

serializedName: string = "lastUpdatedDateTime"

type

type: object

name

trainingStartedOn

trainingStartedOn: object

required

required: boolean = true

serializedName

serializedName: string = "createdDateTime"

type

type: object

name

Const Models

Models: object

type

type: object

className

className: string = "Models"

name

modelProperties

modelProperties: object

modelList

modelList: object

serializedName

serializedName: string = "modelList"

type

type: object

name

element

element: object

type

type: object

className

className: string = "ModelInfo"

name

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

summary

summary: object

serializedName

serializedName: string = "summary"

type

type: object

className

className: string = "ModelsSummary"

name

Const ModelsSummary

ModelsSummary: object

type

type: object

className

className: string = "ModelsSummary"

name

modelProperties

modelProperties: object

count

required

required: boolean = true

serializedName

serializedName: string = "count"

type

type: object

name

lastModified

lastModified: object

required

required: boolean = true

serializedName

serializedName: string = "lastUpdatedDateTime"

type

type: object

name

limit

limit: object

required

required: boolean = true

serializedName

serializedName: string = "limit"

type

type: object

name

Const PageResult

PageResult: object

type

type: object

className

className: string = "PageResult"

name

modelProperties

modelProperties: object

clusterId

clusterId: object

serializedName

serializedName: string = "clusterId"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

keyValuePairs

keyValuePairs: object

serializedName

serializedName: string = "keyValuePairs"

type

type: object

name

element

element: object

type

type: object

className

className: string = "KeyValuePair"

name

pageNumber

pageNumber: object

required

required: boolean = true

serializedName

serializedName: string = "page"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

tables

tables: object

serializedName

serializedName: string = "tables"

type

type: object

name

element

element: object

type

type: object

className

className: string = "DataTable"

name

Const ReadResult

ReadResult: object

type

type: object

className

className: string = "ReadResult"

name

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

height

height: object

required

required: boolean = true

serializedName

serializedName: string = "height"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

language

language: object

serializedName

serializedName: string = "language"

type

type: object

name

lines

lines: object

serializedName

serializedName: string = "lines"

type

type: object

name

element

element: object

type

type: object

className

className: string = "TextLine"

name

pageNumber

pageNumber: object

required

required: boolean = true

serializedName

serializedName: string = "page"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

selectionMarks

selectionMarks: object

serializedName

serializedName: string = "selectionMarks"

type

type: object

name

element

element: object

type

type: object

className

className: string = "SelectionMark"

name

unit

unit: object

required

required: boolean = true

serializedName

serializedName: string = "unit"

type

type: object

allowedValues

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

name

width

width: object

required

required: boolean = true

serializedName

serializedName: string = "width"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

Const SelectionMark

SelectionMark: object

type

type: object

className

className: string = "SelectionMark"

name

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

element

element: object

type

type: object

name

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

state

state: object

required

required: boolean = true

serializedName

serializedName: string = "state"

type

type: object

name

Const SourcePath

SourcePath: object

type

type: object

className

className: string = "SourcePath"

name

modelProperties

modelProperties: object

source

source: object

serializedName

serializedName: string = "source"

constraints

constraints: object

MaxLength

MaxLength: number = 2048

type

type: object

name

Const Style

Style: object

type

type: object

className

className: string = "Style"

name

modelProperties

modelProperties: object

confidence

confidence: object

required

required: boolean = true

serializedName

serializedName: string = "confidence"

type

type: object

name

name

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

Const TextLine

TextLine: object

type

type: object

className

className: string = "TextLine"

name

modelProperties

modelProperties: object

appearance

appearance: object

serializedName

serializedName: string = "appearance"

type

type: object

className

className: string = "Appearance"

name

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

element

element: object

type

type: object

name

language

language: object

serializedName

serializedName: string = "language"

type

type: object

name

text

text: object

required

required: boolean = true

serializedName

serializedName: string = "text"

type

type: object

name

words

words: object

required

required: boolean = true

serializedName

serializedName: string = "words"

type

type: object

name

element

element: object

type

type: object

className

className: string = "TextWord"

name

Const TextWord

TextWord: object

type

type: object

className

className: string = "TextWord"

name

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

element

element: object

type

type: object

name

confidence

confidence: object

serializedName

serializedName: string = "confidence"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

text

text: object

required

required: boolean = true

serializedName

serializedName: string = "text"

type

type: object

name

Const TrainRequest

TrainRequest: object

type

type: object

className

className: string = "TrainRequest"

name

modelProperties

modelProperties: object

modelName

modelName: object

serializedName

serializedName: string = "modelName"

type

type: object

name

source

source: object

required

required: boolean = true

serializedName

serializedName: string = "source"

constraints

constraints: object

MaxLength

MaxLength: number = 2048

type

type: object

name

sourceFilter

sourceFilter: object

serializedName

serializedName: string = "sourceFilter"

type

type: object

className

className: string = "TrainSourceFilter"

name

useLabelFile

useLabelFile: object

serializedName

serializedName: string = "useLabelFile"

type

type: object

name

Const TrainResult

TrainResult: object

type

type: object

className

className: string = "TrainResult"

name

modelProperties

modelProperties: object

averageModelAccuracy

averageModelAccuracy: object

serializedName

serializedName: string = "averageModelAccuracy"

type

type: object

name

errors

errors: object

serializedName

serializedName: string = "errors"

type

type: object

name

element

element: object

type

type: object

className

className: string = "ErrorInformation"

name

fields

fields: object

serializedName

serializedName: string = "fields"

type

type: object

name

element

element: object

type

type: object

className

className: string = "FormFieldsReport"

name

modelId

modelId: object

serializedName

serializedName: string = "modelId"

type

type: object

name

trainingDocuments

trainingDocuments: object

required

required: boolean = true

serializedName

serializedName: string = "trainingDocuments"

type

type: object

name

element

element: object

type

type: object

className

className: string = "TrainingDocumentInfo"

name

Const TrainSourceFilter

TrainSourceFilter: object

type

type: object

className

className: string = "TrainSourceFilter"

name

modelProperties

modelProperties: object

includeSubfolders

includeSubfolders: object

serializedName

serializedName: string = "includeSubFolders"

type

type: object

name

prefix

prefix: object

serializedName

serializedName: string = "prefix"

constraints

constraints: object

MaxLength

MaxLength: number = 1024

type

type: object

name

Const TrainingDocumentInfo

TrainingDocumentInfo: object

type

type: object

className

className: string = "TrainingDocumentInfo"

name

modelProperties

modelProperties: object

errors

errors: object

required

required: boolean = true

serializedName

serializedName: string = "errors"

type

type: object

name

element

element: object

type

type: object

className

className: string = "ErrorInformation"

name

name

required

required: boolean = true

serializedName

serializedName: string = "documentName"

type

type: object

name

pageCount

pageCount: object

required

required: boolean = true

serializedName

serializedName: string = "pages"

type

type: object

name

status

status: object

required

required: boolean = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

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

name

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

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

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

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.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.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 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.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.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.language, 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.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.language, 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.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.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.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]

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]

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

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

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

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

Const fileStream

fileStream: object

parameterPath

parameterPath: string = "fileStream"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "fileStream"

type

type: object

name

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 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

Const includeTextDetails

includeTextDetails: object

parameterPath

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

mapper

mapper: object

serializedName

serializedName: string = "includeTextDetails"

type

type: object

name

Const language

language: object

parameterPath

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

mapper

mapper: object

serializedName

serializedName: string = "language"

type

type: object

name

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

Const modelId

modelId: object

parameterPath

parameterPath: string = "modelId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "modelId"

type

type: object

name

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

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

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

Const pages

pages: object

collectionFormat

collectionFormat: any = QueryCollectionFormat.Csv

parameterPath

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

mapper

mapper: object

serializedName

serializedName: string = "Pages"

type

type: object

name

element

element: object

constraints

constraints: object

Pattern

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

type

type: object

name

Const resultId

resultId: object

parameterPath

parameterPath: string = "resultId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "resultId"

type

type: object

name

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"

Index

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

BeginCopyModelOptions

BeginCopyModelPollerOptions

BeginCreateComposedModelOptions

BeginRecognizeBusinessCardsOptions

BeginRecognizeContentOptions

BeginRecognizeContentPollerOptions

BeginRecognizeFormsOptions

BeginRecognizeInvoicesOptions

BeginRecognizeReceiptsOptions

BeginTrainingOptions

ContentPollerLike

ContentType

CopyModelOperationState

CopyModelOptions

CopyModelPollerClient

Type declaration

beginCopyModel: (modelId: string, copyAuthorization: CopyAuthorization, copyModelOptions?: CopyModelOptions) => Promise<CopyCustomModelResponseModel>

Parameters

modelId: string

copyAuthorization: CopyAuthorization

Optional copyModelOptions: CopyModelOptions

Returns Promise<CopyCustomModelResponseModel>

getCopyModelResult: (modelId: string, resultId: string, options: GetCopyModelResultOptions) => Promise<GetCustomModelCopyResultResponse>

Parameters

modelId: string

resultId: string

options: GetCopyModelResultOptions

Returns Promise<GetCustomModelCopyResultResponse>

DeleteModelOptions

FieldValueSelectionMark

FieldValueType

FormContentType

FormElement

FormField

FormModelResponse

FormPollerLike

FormPollerOperationDescription

FormRecognizerRequestBody

GeneratedClientAnalyzeBusinessCardAsyncResponse

GeneratedClientAnalyzeInvoiceAsyncResponse

GeneratedClientAnalyzeLayoutAsyncResponse

GeneratedClientAnalyzeReceiptAsyncResponse

GeneratedClientAnalyzeWithCustomModelResponse

GeneratedClientComposeCustomModelsAsyncResponse

GeneratedClientCopyCustomModelResponse

GeneratedClientGenerateModelCopyAuthorizationResponse

GeneratedClientGetAnalyzeBusinessCardResultResponse

GeneratedClientGetAnalyzeFormResultResponse

GeneratedClientGetAnalyzeInvoiceResultResponse

GeneratedClientGetAnalyzeLayoutResultResponse

GeneratedClientGetAnalyzeReceiptResultResponse

GeneratedClientGetCustomModelCopyResultResponse

GeneratedClientGetCustomModelResponse

GeneratedClientGetCustomModelsResponse

GeneratedClientListCustomModelsNextResponse

GeneratedClientListCustomModelsResponse

GeneratedClientTrainCustomModelAsyncResponse

GetAccountPropertiesOptions

GetCopyAuthorizationOptions

GetCopyModelResultOptions

GetModelOptions

GetRecognizedContentResultOptions

KeyValueType

Language

LengthUnit

ListCustomModelsResponse

ListModelsOptions

Locale

ModelStatus

OperationStatus

RecognizeContentOperationState

RecognizeContentOptions