FormTrainingClient Class

Definition

Namespace:

Azure.AI.FormRecognizer.Training

Assembly:

Azure.AI.FormRecognizer.dll

Package:

Azure.AI.FormRecognizer v4.1.0

Source:

FormTrainingClient.cs

The client to use to connect with the Form Recognizer Azure Cognitive Service to train models from custom forms. It also supports listing, copying, and deleting trained models, creating composed models, and accessing account properties.

public class FormTrainingClient

type FormTrainingClient = class

Public Class FormTrainingClient

Inheritance

Object

FormTrainingClient

Remarks

This client only supports V2_1 and older. To use a newer service version, see DocumentModelAdministrationClient.

Constructors

FormTrainingClient()	Initializes a new instance of the FormTrainingClient class.
FormTrainingClient(Uri, AzureKeyCredential)	Initializes a new instance of the FormTrainingClient class.
FormTrainingClient(Uri, AzureKeyCredential, FormRecognizerClientOptions)	Initializes a new instance of the FormTrainingClient class.
FormTrainingClient(Uri, TokenCredential)	Initializes a new instance of the FormTrainingClient class.
FormTrainingClient(Uri, TokenCredential, FormRecognizerClientOptions)	Initializes a new instance of the FormTrainingClient class.

Methods

DeleteModel(String, CancellationToken)	Deletes the model with the specified model ID.
DeleteModelAsync(String, CancellationToken)	Deletes the model with the specified model ID.
GetAccountProperties(CancellationToken)	Gets the number of models trained on this Cognitive Services Account and the account limits.
GetAccountPropertiesAsync(CancellationToken)	Gets the number of models trained on this Cognitive Services Account and the account limits.
GetCopyAuthorization(String, String, CancellationToken)	Generate authorization for copying a custom model into the target Form Recognizer resource.
GetCopyAuthorizationAsync(String, String, CancellationToken)	Generate authorization for copying a custom model into the target Form Recognizer resource.
GetCustomModel(String, CancellationToken)	Gets a description of a custom model, including the types of forms it can recognize and the fields it will extract for each form type.
GetCustomModelAsync(String, CancellationToken)	Gets a description of a custom model, including the types of forms it can recognize and the fields it will extract for each form type.
GetCustomModels(CancellationToken)	Gets a collection of items describing the models trained on this Cognitive Services Account and their training status.
GetCustomModelsAsync(CancellationToken)	Gets a collection of items describing the models trained on this Cognitive Services Account and their training status.
GetFormRecognizerClient()	Gets an instance of a FormRecognizerClient that shares the same endpoint, the same credentials and the same set of FormRecognizerClientOptions this client has.
StartCopyModel(String, CopyAuthorization, CancellationToken)	Copy a custom model stored in this resource (the source) to the user specified target Form Recognizer resource.
StartCopyModelAsync(String, CopyAuthorization, CancellationToken)	Copy a custom model stored in this resource (the source) to the user specified target Form Recognizer resource.
StartCreateComposedModel(IEnumerable<String>, String, CancellationToken)	Creates a composed model from a collection of existing models trained with labels.
StartCreateComposedModelAsync(IEnumerable<String>, String, CancellationToken)	Creates a composed model from a collection of existing trained models with labels.
StartTraining(Uri, Boolean, String, TrainingOptions, CancellationToken)	Trains a model from a collection of custom forms in an Azure Blob Storage container.
StartTrainingAsync(Uri, Boolean, String, TrainingOptions, CancellationToken)	Trains a model from a collection of custom forms in an Azure Blob Storage container.