150 строки
12 KiB
YAML
150 строки
12 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.ai.formrecognizer.training.models.CustomFormModel"
|
|
fullName: "com.azure.ai.formrecognizer.training.models.CustomFormModel"
|
|
name: "CustomFormModel"
|
|
nameWithType: "CustomFormModel"
|
|
summary: "The Custom<wbr>Form<wbr>Model"
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **CustomFormModel**"
|
|
constructors:
|
|
- uid: "com.azure.ai.formrecognizer.training.models.CustomFormModel.CustomFormModel(java.lang.String,com.azure.ai.formrecognizer.training.models.CustomFormModelStatus,java.time.OffsetDateTime,java.time.OffsetDateTime,java.util.List<com.azure.ai.formrecognizer.training.models.CustomFormSubmodel>,java.util.List<com.azure.ai.formrecognizer.models.FormRecognizerError>,java.util.List<com.azure.ai.formrecognizer.training.models.TrainingDocumentInfo>)"
|
|
fullName: "com.azure.ai.formrecognizer.training.models.CustomFormModel.CustomFormModel(String modelId, CustomFormModelStatus modelStatus, OffsetDateTime trainingStartedOn, OffsetDateTime trainingCompletedOn, List<CustomFormSubmodel> submodels, List<FormRecognizerError> modelError, List<TrainingDocumentInfo> trainingDocuments)"
|
|
name: "CustomFormModel(String modelId, CustomFormModelStatus modelStatus, OffsetDateTime trainingStartedOn, OffsetDateTime trainingCompletedOn, List<CustomFormSubmodel> submodels, List<FormRecognizerError> modelError, List<TrainingDocumentInfo> trainingDocuments)"
|
|
nameWithType: "CustomFormModel.CustomFormModel(String modelId, CustomFormModelStatus modelStatus, OffsetDateTime trainingStartedOn, OffsetDateTime trainingCompletedOn, List<CustomFormSubmodel> submodels, List<FormRecognizerError> modelError, List<TrainingDocumentInfo> trainingDocuments)"
|
|
summary: "Constructs a Custom<wbr>Form<wbr>Model object."
|
|
parameters:
|
|
- description: "Model identifier."
|
|
name: "modelId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Status of the model."
|
|
name: "modelStatus"
|
|
type: "<xref href=\"com.azure.ai.formrecognizer.training.models.CustomFormModelStatus?alt=com.azure.ai.formrecognizer.training.models.CustomFormModelStatus&text=CustomFormModelStatus\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Date and time (UTC) when the training of model was started."
|
|
name: "trainingStartedOn"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
- description: "Date and time (UTC) when the model training was completed."
|
|
name: "trainingCompletedOn"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
- description: "List of sub model that are part of this model, each of which can recognize and extract fields\n from a different type of form."
|
|
name: "submodels"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.formrecognizer.training.models.CustomFormSubmodel?alt=com.azure.ai.formrecognizer.training.models.CustomFormSubmodel&text=CustomFormSubmodel\" data-throw-if-not-resolved=\"False\" />>"
|
|
- description: "List of errors returned during the training operation."
|
|
name: "modelError"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.formrecognizer.models.FormRecognizerError?alt=com.azure.ai.formrecognizer.models.FormRecognizerError&text=FormRecognizerError\" data-throw-if-not-resolved=\"False\" />>"
|
|
- description: "List of the documents used to train the model."
|
|
name: "trainingDocuments"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.formrecognizer.training.models.TrainingDocumentInfo?alt=com.azure.ai.formrecognizer.training.models.TrainingDocumentInfo&text=TrainingDocumentInfo\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public CustomFormModel(String modelId, CustomFormModelStatus modelStatus, OffsetDateTime trainingStartedOn, OffsetDateTime trainingCompletedOn, List<CustomFormSubmodel> submodels, List<FormRecognizerError> modelError, List<TrainingDocumentInfo> trainingDocuments)"
|
|
desc: "Constructs a CustomFormModel object."
|
|
methods:
|
|
- uid: "com.azure.ai.formrecognizer.training.models.CustomFormModel.getCustomModelProperties()"
|
|
fullName: "com.azure.ai.formrecognizer.training.models.CustomFormModel.getCustomModelProperties()"
|
|
name: "getCustomModelProperties()"
|
|
nameWithType: "CustomFormModel.getCustomModelProperties()"
|
|
summary: "Get model metadata properties."
|
|
syntax: "public CustomFormModelProperties getCustomModelProperties()"
|
|
desc: "Get model metadata properties."
|
|
returns:
|
|
description: "the custom model metadata properties."
|
|
type: "<xref href=\"com.azure.ai.formrecognizer.training.models.CustomFormModelProperties?alt=com.azure.ai.formrecognizer.training.models.CustomFormModelProperties&text=CustomFormModelProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.ai.formrecognizer.training.models.CustomFormModel.getModelError()"
|
|
fullName: "com.azure.ai.formrecognizer.training.models.CustomFormModel.getModelError()"
|
|
name: "getModelError()"
|
|
nameWithType: "CustomFormModel.getModelError()"
|
|
summary: "Get the errors returned during the training operation."
|
|
syntax: "public List<FormRecognizerError> getModelError()"
|
|
desc: "Get the errors returned during the training operation."
|
|
returns:
|
|
description: "the unmodifiable list of model errors returned during the training operation."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.formrecognizer.models.FormRecognizerError?alt=com.azure.ai.formrecognizer.models.FormRecognizerError&text=FormRecognizerError\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.ai.formrecognizer.training.models.CustomFormModel.getModelId()"
|
|
fullName: "com.azure.ai.formrecognizer.training.models.CustomFormModel.getModelId()"
|
|
name: "getModelId()"
|
|
nameWithType: "CustomFormModel.getModelId()"
|
|
summary: "Get the Model identifier."
|
|
syntax: "public String getModelId()"
|
|
desc: "Get the Model identifier."
|
|
returns:
|
|
description: "the <code>modelId</code> value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.ai.formrecognizer.training.models.CustomFormModel.getModelName()"
|
|
fullName: "com.azure.ai.formrecognizer.training.models.CustomFormModel.getModelName()"
|
|
name: "getModelName()"
|
|
nameWithType: "CustomFormModel.getModelName()"
|
|
summary: "Get the user defined model display name."
|
|
syntax: "public String getModelName()"
|
|
desc: "Get the user defined model display name."
|
|
returns:
|
|
description: "the modelName value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.ai.formrecognizer.training.models.CustomFormModel.getModelStatus()"
|
|
fullName: "com.azure.ai.formrecognizer.training.models.CustomFormModel.getModelStatus()"
|
|
name: "getModelStatus()"
|
|
nameWithType: "CustomFormModel.getModelStatus()"
|
|
summary: "Get the status of the model."
|
|
syntax: "public CustomFormModelStatus getModelStatus()"
|
|
desc: "Get the status of the model."
|
|
returns:
|
|
description: "the <code>modelStatus</code> value."
|
|
type: "<xref href=\"com.azure.ai.formrecognizer.training.models.CustomFormModelStatus?alt=com.azure.ai.formrecognizer.training.models.CustomFormModelStatus&text=CustomFormModelStatus\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.ai.formrecognizer.training.models.CustomFormModel.getSubmodels()"
|
|
fullName: "com.azure.ai.formrecognizer.training.models.CustomFormModel.getSubmodels()"
|
|
name: "getSubmodels()"
|
|
nameWithType: "CustomFormModel.getSubmodels()"
|
|
summary: "Get the list of sub model that are part of this model, each of which can recognize and extract fields from a different type of form."
|
|
syntax: "public List<CustomFormSubmodel> getSubmodels()"
|
|
desc: "Get the list of sub model that are part of this model, each of which can recognize and extract fields from a different type of form."
|
|
returns:
|
|
description: "the unmodifiable list of submodels that are a part of this model."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.formrecognizer.training.models.CustomFormSubmodel?alt=com.azure.ai.formrecognizer.training.models.CustomFormSubmodel&text=CustomFormSubmodel\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.ai.formrecognizer.training.models.CustomFormModel.getTrainingCompletedOn()"
|
|
fullName: "com.azure.ai.formrecognizer.training.models.CustomFormModel.getTrainingCompletedOn()"
|
|
name: "getTrainingCompletedOn()"
|
|
nameWithType: "CustomFormModel.getTrainingCompletedOn()"
|
|
summary: "Get the Date and time (UTC) when the model training was completed."
|
|
syntax: "public OffsetDateTime getTrainingCompletedOn()"
|
|
desc: "Get the Date and time (UTC) when the model training was completed."
|
|
returns:
|
|
description: "the <code>trainingCompletedOn</code> value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
- uid: "com.azure.ai.formrecognizer.training.models.CustomFormModel.getTrainingDocuments()"
|
|
fullName: "com.azure.ai.formrecognizer.training.models.CustomFormModel.getTrainingDocuments()"
|
|
name: "getTrainingDocuments()"
|
|
nameWithType: "CustomFormModel.getTrainingDocuments()"
|
|
summary: "Get the list of the documents used to train the model and any errors reported in each document."
|
|
syntax: "public List<TrainingDocumentInfo> getTrainingDocuments()"
|
|
desc: "Get the list of the documents used to train the model and any errors reported in each document."
|
|
returns:
|
|
description: "the unmodifiable list of documents used to train the model."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.formrecognizer.training.models.TrainingDocumentInfo?alt=com.azure.ai.formrecognizer.training.models.TrainingDocumentInfo&text=TrainingDocumentInfo\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.ai.formrecognizer.training.models.CustomFormModel.getTrainingStartedOn()"
|
|
fullName: "com.azure.ai.formrecognizer.training.models.CustomFormModel.getTrainingStartedOn()"
|
|
name: "getTrainingStartedOn()"
|
|
nameWithType: "CustomFormModel.getTrainingStartedOn()"
|
|
summary: "Get the Date and time (UTC) when the training of the model was started."
|
|
syntax: "public OffsetDateTime getTrainingStartedOn()"
|
|
desc: "Get the Date and time (UTC) when the training of the model was started."
|
|
returns:
|
|
description: "the <code>trainingStartedOn</code> value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
type: "class"
|
|
desc: "The CustomFormModel"
|
|
metadata: {}
|
|
package: "com.azure.ai.formrecognizer.training.models"
|
|
artifact: com.azure:azure-ai-formrecognizer:4.1.11
|