You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Comprehend::Types::DocumentClassifierProperties

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Provides information about a document classifier.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#classifier_metadata ⇒ Types::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.

Returns:

  • (Types::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.

#data_access_role_arn ⇒ String

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

Returns:

  • (String) —

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

#document_classifier_arn ⇒ String

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

Returns:

  • (String) —

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

#end_time ⇒ Time

The time that training the document classifier completed.

Returns:

  • (Time) —

    The time that training the document classifier completed.

#input_data_config ⇒ Types::DocumentClassifierInputDataConfig

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

Returns:

#language_code ⇒ String

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

Possible values:

  • en
  • es
  • fr
  • de
  • it
  • pt
  • ar
  • hi
  • ja
  • ko
  • zh
  • zh-TW

Returns:

  • (String) —

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

#message ⇒ String

Additional information about the status of the classifier.

Returns:

  • (String) —

    Additional information about the status of the classifier.

#mode ⇒ 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.

Possible values:

  • MULTI_CLASS
  • MULTI_LABEL

Returns:

  • (String) —

    Indicates the mode in which the specific classifier was trained.

#output_data_config ⇒ Types::DocumentClassifierOutputDataConfig

Provides output results configuration parameters for custom classifier jobs.

Returns:

#status ⇒ String

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.

Possible values:

  • SUBMITTED
  • TRAINING
  • DELETING
  • STOP_REQUESTED
  • STOPPED
  • IN_ERROR
  • TRAINED

Returns:

  • (String) —

    The status of the document classifier.

#submit_time ⇒ Time

The time that the document classifier was submitted for training.

Returns:

  • (Time) —

    The time that the document classifier was submitted for training.

#training_end_time ⇒ Time

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.

Returns:

  • (Time) —

    The time that training of the document classifier was completed.

#training_start_time ⇒ Time

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.

Returns:

  • (Time) —

    Indicates the time when the training starts on documentation classifiers.

#volume_kms_key_id ⇒ 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:

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

Returns:

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

#vpc_config ⇒ Types::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.

Returns:

  • (Types::VpcConfig) —

    Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier.