GeneratedClient | @azure/ai-form-recognizer

Hierarchy

GeneratedClientContext
- GeneratedClient

Index

Constructors

constructor

Properties

endpoint

Methods

Constructors

constructor

new GeneratedClient(credentials: coreHttp.TokenCredential | coreHttp.ServiceClientCredentials, endpoint: string, options?: Models.GeneratedClientOptionalParams): GeneratedClient

Overrides GeneratedClientContext.constructor
- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/generated/generatedClient.ts:41
Initializes a new instance of the GeneratedClient class.

Parameters
- credentials: coreHttp.TokenCredential | coreHttp.ServiceClientCredentials
  
  Subscription credentials which uniquely identify client subscription.
- endpoint: string
  
  Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com).
- Optional options: Models.GeneratedClientOptionalParams
  
  The parameter options
Returns GeneratedClient

Properties

endpoint

endpoint: string

Methods

analyzeLayoutAsync

analyzeLayoutAsync(contentType: ContentType, fileStream: coreHttp.HttpRequestBody, options?: GeneratedClientAnalyzeLayoutAsync$binaryOptionalParams): Promise<GeneratedClientAnalyzeLayoutAsyncResponse>
analyzeLayoutAsync(contentType: "application/json", options?: GeneratedClientAnalyzeLayoutAsync$jsonOptionalParams): Promise<GeneratedClientAnalyzeLayoutAsyncResponse>

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/generated/generatedClient.ts:382
Extract text and layout information from a given document. The input document must be of one of the supported content types - 'application/pdf', 'image/jpeg', 'image/png' or 'image/tiff'. Alternatively, use 'application/json' type to specify the location (Uri or local path) of the document to be analyzed.

Parameters
- contentType: ContentType
  
  Upload file type
- fileStream: coreHttp.HttpRequestBody
  
  .json, .pdf, .jpg, .png or .tiff type file stream.
- Optional options: GeneratedClientAnalyzeLayoutAsync$binaryOptionalParams
  
  The options parameters.
Returns Promise<GeneratedClientAnalyzeLayoutAsyncResponse>
- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/generated/generatedClient.ts:395
Extract text and layout information from a given document. The input document must be of one of the supported content types - 'application/pdf', 'image/jpeg', 'image/png' or 'image/tiff'. Alternatively, use 'application/json' type to specify the location (Uri or local path) of the document to be analyzed.

Parameters
- contentType: "application/json"
  
  Body Parameter content-type
- Optional options: GeneratedClientAnalyzeLayoutAsync$jsonOptionalParams
  
  The options parameters.
Returns Promise<GeneratedClientAnalyzeLayoutAsyncResponse>

analyzeReceiptAsync

analyzeReceiptAsync(contentType: ContentType, fileStream: coreHttp.HttpRequestBody, options?: GeneratedClientAnalyzeReceiptAsync$binaryOptionalParams): Promise<GeneratedClientAnalyzeReceiptAsyncResponse>
analyzeReceiptAsync(contentType: "application/json", options?: GeneratedClientAnalyzeReceiptAsync$jsonOptionalParams): Promise<GeneratedClientAnalyzeReceiptAsyncResponse>

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/generated/generatedClient.ts:288
Extract field text and semantic values from a given receipt document. The input document must be of one of the supported content types - 'application/pdf', 'image/jpeg', 'image/png' or 'image/tiff'. Alternatively, use 'application/json' type to specify the location (Uri or local path) of the document to be analyzed.

Parameters
- contentType: ContentType
  
  Upload file type
- fileStream: coreHttp.HttpRequestBody
  
  .json, .pdf, .jpg, .png or .tiff type file stream.
- Optional options: GeneratedClientAnalyzeReceiptAsync$binaryOptionalParams
  
  The options parameters.
Returns Promise<GeneratedClientAnalyzeReceiptAsyncResponse>
- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/generated/generatedClient.ts:301
Extract field text and semantic values from a given receipt document. The input document must be of one of the supported content types - 'application/pdf', 'image/jpeg', 'image/png' or 'image/tiff'. Alternatively, use 'application/json' type to specify the location (Uri or local path) of the document to be analyzed.

Parameters
- contentType: "application/json"
  
  Body Parameter content-type
- Optional options: GeneratedClientAnalyzeReceiptAsync$jsonOptionalParams
  
  The options parameters.
Returns Promise<GeneratedClientAnalyzeReceiptAsyncResponse>

analyzeWithCustomModel

analyzeWithCustomModel(modelId: string, contentType: ContentType, fileStream: coreHttp.HttpRequestBody, options?: GeneratedClientAnalyzeWithCustomModel$binaryOptionalParams): Promise<GeneratedClientAnalyzeWithCustomModelResponse>
analyzeWithCustomModel(modelId: string, contentType: "application/json", options?: GeneratedClientAnalyzeWithCustomModel$jsonOptionalParams): Promise<GeneratedClientAnalyzeWithCustomModelResponse>

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/generated/generatedClient.ts:128
Extract key-value pairs, tables, and semantic values from a given document. The input document must be of one of the supported content types - 'application/pdf', 'image/jpeg', 'image/png' or 'image/tiff'. Alternatively, use 'application/json' type to specify the location (Uri or local path) of the document to be analyzed.

Parameters
- modelId: string
  
  Model identifier.
- contentType: ContentType
  
  Upload file type
- fileStream: coreHttp.HttpRequestBody
  
  .json, .pdf, .jpg, .png or .tiff type file stream.
- Optional options: GeneratedClientAnalyzeWithCustomModel$binaryOptionalParams
  
  The options parameters.
Returns Promise<GeneratedClientAnalyzeWithCustomModelResponse>
- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/generated/generatedClient.ts:143
Extract key-value pairs, tables, and semantic values from a given document. The input document must be of one of the supported content types - 'application/pdf', 'image/jpeg', 'image/png' or 'image/tiff'. Alternatively, use 'application/json' type to specify the location (Uri or local path) of the document to be analyzed.

Parameters
- modelId: string
  
  Model identifier.
- contentType: "application/json"
  
  Body Parameter content-type
- Optional options: GeneratedClientAnalyzeWithCustomModel$jsonOptionalParams
  
  The options parameters.
Returns Promise<GeneratedClientAnalyzeWithCustomModelResponse>

copyCustomModel

copyCustomModel(modelId: string, copyRequest: CopyRequest, options?: coreHttp.OperationOptions): Promise<GeneratedClientCopyCustomModelResponse>

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/generated/generatedClient.ts:229
Copy custom model stored in this resource (the source) to user specified target Form Recognizer resource.

Parameters
- modelId: string
  
  Model identifier.
- copyRequest: CopyRequest
  
  Copy request parameters.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<GeneratedClientCopyCustomModelResponse>

deleteCustomModel

deleteCustomModel(modelId: string, options?: coreHttp.OperationOptions): Promise<coreHttp.RestResponse>

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/generated/generatedClient.ts:105
Mark model for deletion. Model artifacts will be permanently removed within a predetermined period.

Parameters
- modelId: string
  
  Model identifier.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<coreHttp.RestResponse>

generateModelCopyAuthorization

generateModelCopyAuthorization(options?: coreHttp.OperationOptions): Promise<GeneratedClientGenerateModelCopyAuthorizationResponse>

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/generated/generatedClient.ts:267
Generate authorization to copy a model into the target Form Recognizer resource.

Parameters
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<GeneratedClientGenerateModelCopyAuthorizationResponse>

getAnalyzeFormResult

getAnalyzeFormResult(modelId: string, resultId: string, options?: coreHttp.OperationOptions): Promise<GeneratedClientGetAnalyzeFormResultResponse>

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/generated/generatedClient.ts:208
Obtain current status and the result of the analyze form operation.

Parameters
- modelId: string
  
  Model identifier.
- resultId: string
  
  Analyze operation result identifier.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<GeneratedClientGetAnalyzeFormResultResponse>

getAnalyzeLayoutResult

getAnalyzeLayoutResult(resultId: string, options?: coreHttp.OperationOptions): Promise<GeneratedClientGetAnalyzeLayoutResultResponse>

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/generated/generatedClient.ts:454
Track the progress and obtain the result of the analyze layout operation

Parameters
- resultId: string
  
  Analyze operation result identifier.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<GeneratedClientGetAnalyzeLayoutResultResponse>

getAnalyzeReceiptResult

getAnalyzeReceiptResult(resultId: string, options?: coreHttp.OperationOptions): Promise<GeneratedClientGetAnalyzeReceiptResultResponse>

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/generated/generatedClient.ts:360
Track the progress and obtain the result of the analyze receipt operation.

Parameters
- resultId: string
  
  Analyze operation result identifier.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<GeneratedClientGetAnalyzeReceiptResultResponse>

getCustomModel

getCustomModel(modelId: string, options?: GeneratedClientGetCustomModelOptionalParams): Promise<GeneratedClientGetCustomModelResponse>

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/generated/generatedClient.ts:87
Get detailed information about a custom model.

Parameters
- modelId: string
  
  Model identifier.
- Optional options: GeneratedClientGetCustomModelOptionalParams
  
  The options parameters.
Returns Promise<GeneratedClientGetCustomModelResponse>

getCustomModelCopyResult

getCustomModelCopyResult(modelId: string, resultId: string, options?: coreHttp.OperationOptions): Promise<GeneratedClientGetCustomModelCopyResultResponse>

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/generated/generatedClient.ts:249
Obtain current status and the result of a custom model copy operation.

Parameters
- modelId: string
  
  Model identifier.
- resultId: string
  
  Copy operation result identifier.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<GeneratedClientGetCustomModelCopyResultResponse>

getCustomModels

getCustomModels(options?: coreHttp.OperationOptions): Promise<GeneratedClientGetCustomModelsResponse>

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/generated/generatedClient.ts:487
Get information about all custom models

Parameters
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<GeneratedClientGetCustomModelsResponse>

listCustomModels

listCustomModels(options?: coreHttp.OperationOptions): Promise<GeneratedClientListCustomModelsResponse>

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/generated/generatedClient.ts:471
Get information about all custom models

Parameters
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<GeneratedClientListCustomModelsResponse>

listCustomModelsNext

listCustomModelsNext(nextLink: string, options?: coreHttp.OperationOptions): Promise<GeneratedClientListCustomModelsNextResponse>

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/generated/generatedClient.ts:504
ListCustomModelsNext

Parameters
- nextLink: string
  
  The nextLink from the previous successful call to the ListCustomModels method.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<GeneratedClientListCustomModelsNextResponse>

trainCustomModelAsync

trainCustomModelAsync(trainRequest: TrainRequest, options?: coreHttp.OperationOptions): Promise<GeneratedClientTrainCustomModelAsyncResponse>

- Defined in home/vsts/work/1/s/sdk/formrecognizer/ai-form-recognizer/src/generated/generatedClient.ts:69
Create and train a custom model. The request must include a source parameter that is either an externally accessible Azure storage blob container Uri (preferably a Shared Access Signature Uri) or valid path to a data folder in a locally mounted drive. When local paths are specified, they must follow the Linux/Unix path format and be an absolute path rooted to the input mount configuration setting value e.g., if '{Mounts:Input}' configuration setting value is '/input' then a valid source path would be '/input/contosodataset'. All data to be trained is expected to be under the source folder or sub folders under it. Models are trained using documents that are of the following content type - 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff'. Other type of content is ignored.

Parameters
- trainRequest: TrainRequest
  
  Training request parameters.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<GeneratedClientTrainCustomModelAsyncResponse>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

credentials: coreHttp.TokenCredential | coreHttp.ServiceClientCredentials

endpoint: string

Optional options: Models.GeneratedClientOptionalParams

Returns GeneratedClient

Properties

endpoint

Methods

analyzeLayoutAsync

Parameters

contentType: ContentType

fileStream: coreHttp.HttpRequestBody

Optional options: GeneratedClientAnalyzeLayoutAsync$binaryOptionalParams

Returns Promise<GeneratedClientAnalyzeLayoutAsyncResponse>

Parameters

contentType: "application/json"

Optional options: GeneratedClientAnalyzeLayoutAsync$jsonOptionalParams

Returns Promise<GeneratedClientAnalyzeLayoutAsyncResponse>

analyzeReceiptAsync

Parameters

contentType: ContentType

fileStream: coreHttp.HttpRequestBody

Optional options: GeneratedClientAnalyzeReceiptAsync$binaryOptionalParams

Returns Promise<GeneratedClientAnalyzeReceiptAsyncResponse>

Parameters

contentType: "application/json"

Optional options: GeneratedClientAnalyzeReceiptAsync$jsonOptionalParams

Returns Promise<GeneratedClientAnalyzeReceiptAsyncResponse>

analyzeWithCustomModel

Parameters

modelId: string

contentType: ContentType

fileStream: coreHttp.HttpRequestBody

Optional options: GeneratedClientAnalyzeWithCustomModel$binaryOptionalParams

Returns Promise<GeneratedClientAnalyzeWithCustomModelResponse>

Parameters

modelId: string

contentType: "application/json"

Optional options: GeneratedClientAnalyzeWithCustomModel$jsonOptionalParams

Returns Promise<GeneratedClientAnalyzeWithCustomModelResponse>

copyCustomModel

Parameters

modelId: string

copyRequest: CopyRequest

Optional options: coreHttp.OperationOptions

Returns Promise<GeneratedClientCopyCustomModelResponse>

deleteCustomModel

Parameters

modelId: string

Optional options: coreHttp.OperationOptions

Returns Promise<coreHttp.RestResponse>

generateModelCopyAuthorization

Parameters

Optional options: coreHttp.OperationOptions

Returns Promise<GeneratedClientGenerateModelCopyAuthorizationResponse>

getAnalyzeFormResult

Parameters

modelId: string

resultId: string

Optional options: coreHttp.OperationOptions

Returns Promise<GeneratedClientGetAnalyzeFormResultResponse>

getAnalyzeLayoutResult

Parameters

resultId: string

Optional options: coreHttp.OperationOptions

Returns Promise<GeneratedClientGetAnalyzeLayoutResultResponse>

getAnalyzeReceiptResult

Parameters

resultId: string

Optional options: coreHttp.OperationOptions

Returns Promise<GeneratedClientGetAnalyzeReceiptResultResponse>

getCustomModel

Parameters