DocumentClassifierProperties class

Provides information about a document classifier.

Constructors

DocumentClassifierProperties({ClassifierMetadata? classifierMetadata, String? dataAccessRoleArn, String? documentClassifierArn, DateTime? endTime, DocumentClassifierInputDataConfig? inputDataConfig, LanguageCode? languageCode, String? message, DocumentClassifierMode? mode, DocumentClassifierOutputDataConfig? outputDataConfig, ModelStatus? status, DateTime? submitTime, DateTime? trainingEndTime, DateTime? trainingStartTime, String? volumeKmsKeyId, VpcConfig? vpcConfig})
DocumentClassifierProperties.fromJson(Map<String, dynamic> json)
factory

Properties

classifierMetadata ClassifierMetadata?
Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.
final
dataAccessRoleArn String?
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
final
documentClassifierArn String?
The Amazon Resource Name (ARN) that identifies the document classifier.
final
endTime DateTime?
The time that training the document classifier completed.
final
hashCode int
The hash code for this object.
no setterinherited
inputDataConfig DocumentClassifierInputDataConfig?
The input data configuration that you supplied when you created the document classifier for training.
final
languageCode LanguageCode?
The language code for the language of the documents that the classifier was trained on.
final
message String?
Additional information about the status of the classifier.
final
mode DocumentClassifierMode?
Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.
final
outputDataConfig DocumentClassifierOutputDataConfig?
Provides output results configuration parameters for custom classifier jobs.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
status ModelStatus?
The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.
final
submitTime DateTime?
The time that the document classifier was submitted for training.
final
trainingEndTime DateTime?
The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.
final
trainingStartTime DateTime?
Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.
final
volumeKmsKeyId String?
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
final
vpcConfig VpcConfig?
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited