AWSComprehendDocumentClassifierProperties

Objective-C

@interface AWSComprehendDocumentClassifierProperties

Swift

class AWSComprehendDocumentClassifierProperties

Provides information about a document classifier.

  • 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

    Objective-C

    @property (nonatomic, strong) AWSComprehendClassifierMetadata *_Nullable classifierMetadata;

    Swift

    var classifierMetadata: AWSComprehendClassifierMetadata? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable dataAccessRoleArn;

    Swift

    var dataAccessRoleArn: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable documentClassifierArn;

    Swift

    var documentClassifierArn: String? { get set }

  • The time that training the document classifier completed.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable endTime;

    Swift

    var endTime: Date? { get set }

  • The Amazon Resource Number (ARN) of the flywheel

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable flywheelArn;

    Swift

    var flywheelArn: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSComprehendDocumentClassifierInputDataConfig *_Nullable inputDataConfig;

    Swift

    var inputDataConfig: AWSComprehendDocumentClassifierInputDataConfig? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSComprehendLanguageCode languageCode;

    Swift

    var languageCode: AWSComprehendLanguageCode { get set }

  • Additional information about the status of the classifier.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable message;

    Swift

    var message: String? { get set }

  • 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

    Objective-C

    @property (nonatomic) AWSComprehendDocumentClassifierMode mode;

    Swift

    var mode: AWSComprehendDocumentClassifierMode { get set }

  • ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable modelKmsKeyId;

    Swift

    var modelKmsKeyId: String? { get set }

  • Provides output results configuration parameters for custom classifier jobs.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSComprehendDocumentClassifierOutputDataConfig *_Nullable outputDataConfig;

    Swift

    var outputDataConfig: AWSComprehendDocumentClassifierOutputDataConfig? { get set }

  • The Amazon Resource Name (ARN) of the source model. This model was imported from a different Amazon Web Services account to create the document classifier model in your Amazon Web Services account.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable sourceModelArn;

    Swift

    var sourceModelArn: String? { get set }

  • The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is TRAINED_WITH_WARNINGS the classifier training succeeded, but you should review the warnings returned in the CreateDocumentClassifier response.

    If the status is FAILED you can see additional information about why the classifier wasn’t trained in the Message field.

    Declaration

    Objective-C

    @property (nonatomic) AWSComprehendModelStatus status;

    Swift

    var status: AWSComprehendModelStatus { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable submitTime;

    Swift

    var submitTime: Date? { get set }

  • 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

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable trainingEndTime;

    Swift

    var trainingEndTime: Date? { get set }

  • 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

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable trainingStartTime;

    Swift

    var trainingStartTime: Date? { get set }

  • The version name that you assigned to the document classifier.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable versionName;

    Swift

    var versionName: String? { get set }

  • ID for the Amazon Web Services 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

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable volumeKmsKeyId;

    Swift

    var volumeKmsKeyId: String? { get set }

  • 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

    Objective-C

    @property (nonatomic, strong) AWSComprehendVpcConfig *_Nullable vpcConfig;

    Swift

    var vpcConfig: AWSComprehendVpcConfig? { get set }