DocumentClassifierProperties

public struct DocumentClassifierProperties : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • 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.

    Declaration

    Swift

    public let classifierMetadata: ClassifierMetadata?

  • The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

    Declaration

    Swift

    public let dataAccessRoleArn: String?

  • The Amazon Resource Name (ARN) that identifies the document classifier.

    Declaration

    Swift

    public let documentClassifierArn: String?

  • The time that training the document classifier completed.

    Declaration

    Swift

    public let endTime: TimeStamp?

  • The input data configuration that you supplied when you created the document classifier for training.

    Declaration

    Swift

    public let inputDataConfig: DocumentClassifierInputDataConfig?

  • The language code for the language of the documents that the classifier was trained on.

    Declaration

    Swift

    public let languageCode: LanguageCode?

  • Additional information about the status of the classifier.

    Declaration

    Swift

    public let message: String?

  • 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.

    Declaration

    Swift

    public let mode: DocumentClassifierMode?

  • Provides output results configuration parameters for custom classifier jobs.

    Declaration

    Swift

    public let outputDataConfig: DocumentClassifierOutputDataConfig?

  • 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.

    Declaration

    Swift

    public let status: ModelStatus?

  • The time that the document classifier was submitted for training.

    Declaration

    Swift

    public let submitTime: TimeStamp?

  • 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.

    Declaration

    Swift

    public let trainingEndTime: TimeStamp?

  • 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.

    Declaration

    Swift

    public let trainingStartTime: TimeStamp?

  • 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: KMS Key ID: “1234abcd-12ab-34cd-56ef-1234567890ab” Amazon Resource Name (ARN) of a KMS Key: “arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab”

    Declaration

    Swift

    public let volumeKmsKeyId: String?

  • 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.

    Declaration

    Swift

    public let vpcConfig: VpcConfig?

  • Undocumented

    Declaration

    Swift

    public init(classifierMetadata: ClassifierMetadata? = nil, dataAccessRoleArn: String? = nil, documentClassifierArn: String? = nil, endTime: TimeStamp? = nil, inputDataConfig: DocumentClassifierInputDataConfig? = nil, languageCode: LanguageCode? = nil, message: String? = nil, mode: DocumentClassifierMode? = nil, outputDataConfig: DocumentClassifierOutputDataConfig? = nil, status: ModelStatus? = nil, submitTime: TimeStamp? = nil, trainingEndTime: TimeStamp? = nil, trainingStartTime: TimeStamp? = nil, volumeKmsKeyId: String? = nil, vpcConfig: VpcConfig? = nil)