FormRecognizerModelFactory.CustomFormModel Method

Definition

Namespace:

Azure.AI.FormRecognizer.Models

Assembly:

Azure.AI.FormRecognizer.dll

Package:

Azure.AI.FormRecognizer v4.1.0

Source:

FormRecognizerModelFactory.cs

Initializes a new instance of the CustomFormModel class.

public static Azure.AI.FormRecognizer.Training.CustomFormModel CustomFormModel (string modelId, Azure.AI.FormRecognizer.Training.CustomFormModelStatus status, DateTimeOffset trainingStartedOn, DateTimeOffset trainingCompletedOn, System.Collections.Generic.IReadOnlyList<Azure.AI.FormRecognizer.Training.CustomFormSubmodel> submodels, System.Collections.Generic.IReadOnlyList<Azure.AI.FormRecognizer.Training.TrainingDocumentInfo> trainingDocuments, System.Collections.Generic.IReadOnlyList<Azure.AI.FormRecognizer.Models.FormRecognizerError> errors, string modelName, Azure.AI.FormRecognizer.Training.CustomFormModelProperties properties);

static member CustomFormModel : string * Azure.AI.FormRecognizer.Training.CustomFormModelStatus * DateTimeOffset * DateTimeOffset * System.Collections.Generic.IReadOnlyList<Azure.AI.FormRecognizer.Training.CustomFormSubmodel> * System.Collections.Generic.IReadOnlyList<Azure.AI.FormRecognizer.Training.TrainingDocumentInfo> * System.Collections.Generic.IReadOnlyList<Azure.AI.FormRecognizer.Models.FormRecognizerError> * string * Azure.AI.FormRecognizer.Training.CustomFormModelProperties -> Azure.AI.FormRecognizer.Training.CustomFormModel

Public Shared Function CustomFormModel (modelId As String, status As CustomFormModelStatus, trainingStartedOn As DateTimeOffset, trainingCompletedOn As DateTimeOffset, submodels As IReadOnlyList(Of CustomFormSubmodel), trainingDocuments As IReadOnlyList(Of TrainingDocumentInfo), errors As IReadOnlyList(Of FormRecognizerError), modelName As String, properties As CustomFormModelProperties) As CustomFormModel

Parameters

modelId

String

The unique identifier of this model.

status

CustomFormModelStatus

A status indicating this model's readiness for use.

trainingStartedOn

DateTimeOffset

The date and time (UTC) when model training was started.

trainingCompletedOn

DateTimeOffset

The date and time (UTC) when model training completed.

submodels

IReadOnlyList<CustomFormSubmodel>

A list of submodels that are part of this model, each of which can recognize and extract fields from a different type of form.

trainingDocuments

IReadOnlyList<TrainingDocumentInfo>

A list of meta-data about each of the documents used to train the model.

errors

IReadOnlyList<FormRecognizerError>

A list of errors occurred during the training operation.

modelName

String

An optional, user-defined name to associate with your model.

properties

CustomFormModelProperties

Model properties, like for example, if a model is composed.

Returns

CustomFormModel

A new CustomFormModel instance for mocking.