Class: Aws::Comprehend::Types::DocumentClassifierProperties
- Inherits:
-
Struct
- Object
- Struct
- Aws::Comprehend::Types::DocumentClassifierProperties
- Defined in:
- gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb
Overview
Provides information about a document classifier.
Constant Summary collapse
- SENSITIVE =
[:classifier_metadata]
Instance Attribute Summary collapse
-
#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.
-
#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.
-
#document_classifier_arn ⇒ String
The Amazon Resource Name (ARN) that identifies the document classifier.
-
#end_time ⇒ 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.
-
#language_code ⇒ 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.
-
#mode ⇒ String
Indicates the mode in which the specific classifier was trained.
-
#model_kms_key_id ⇒ String
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models.
-
#output_data_config ⇒ Types::DocumentClassifierOutputDataConfig
Provides output results configuration parameters for custom classifier jobs.
-
#source_model_arn ⇒ String
The Amazon Resource Name (ARN) of the source model.
-
#status ⇒ String
The status of the document classifier.
-
#submit_time ⇒ 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.
-
#training_start_time ⇒ Time
Indicates the time when the training starts on documentation classifiers.
-
#version_name ⇒ String
The version name that you assigned to the document classifier.
-
#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.
-
#vpc_config ⇒ Types::VpcConfig
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier.
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.
2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2498 class DocumentClassifierProperties < Struct.new( :document_classifier_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :output_data_config, :classifier_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :mode, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:classifier_metadata] include Aws::Structure end |
#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.
2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2498 class DocumentClassifierProperties < Struct.new( :document_classifier_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :output_data_config, :classifier_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :mode, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:classifier_metadata] include Aws::Structure end |
#document_classifier_arn ⇒ String
The Amazon Resource Name (ARN) that identifies the document classifier.
2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2498 class DocumentClassifierProperties < Struct.new( :document_classifier_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :output_data_config, :classifier_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :mode, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:classifier_metadata] include Aws::Structure end |
#end_time ⇒ Time
The time that training the document classifier completed.
2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2498 class DocumentClassifierProperties < Struct.new( :document_classifier_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :output_data_config, :classifier_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :mode, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:classifier_metadata] include Aws::Structure end |
#input_data_config ⇒ Types::DocumentClassifierInputDataConfig
The input data configuration that you supplied when you created the document classifier for training.
2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2498 class DocumentClassifierProperties < Struct.new( :document_classifier_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :output_data_config, :classifier_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :mode, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:classifier_metadata] include Aws::Structure end |
#language_code ⇒ String
The language code for the language of the documents that the classifier was trained on.
2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2498 class DocumentClassifierProperties < Struct.new( :document_classifier_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :output_data_config, :classifier_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :mode, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:classifier_metadata] include Aws::Structure end |
#message ⇒ String
Additional information about the status of the classifier.
2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2498 class DocumentClassifierProperties < Struct.new( :document_classifier_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :output_data_config, :classifier_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :mode, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:classifier_metadata] include Aws::Structure end |
#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.
2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2498 class DocumentClassifierProperties < Struct.new( :document_classifier_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :output_data_config, :classifier_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :mode, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:classifier_metadata] include Aws::Structure end |
#model_kms_key_id ⇒ String
ID for the AWS Key Management Service (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"
2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2498 class DocumentClassifierProperties < Struct.new( :document_classifier_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :output_data_config, :classifier_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :mode, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:classifier_metadata] include Aws::Structure end |
#output_data_config ⇒ Types::DocumentClassifierOutputDataConfig
Provides output results configuration parameters for custom classifier jobs.
2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2498 class DocumentClassifierProperties < Struct.new( :document_classifier_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :output_data_config, :classifier_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :mode, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:classifier_metadata] include Aws::Structure end |
#source_model_arn ⇒ String
The Amazon Resource Name (ARN) of the source model. This model was imported from a different AWS account to create the document classifier model in your AWS account.
2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2498 class DocumentClassifierProperties < Struct.new( :document_classifier_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :output_data_config, :classifier_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :mode, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:classifier_metadata] include Aws::Structure end |
#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.
2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2498 class DocumentClassifierProperties < Struct.new( :document_classifier_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :output_data_config, :classifier_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :mode, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:classifier_metadata] include Aws::Structure end |
#submit_time ⇒ Time
The time that the document classifier was submitted for training.
2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2498 class DocumentClassifierProperties < Struct.new( :document_classifier_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :output_data_config, :classifier_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :mode, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:classifier_metadata] include Aws::Structure end |
#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.
2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2498 class DocumentClassifierProperties < Struct.new( :document_classifier_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :output_data_config, :classifier_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :mode, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:classifier_metadata] include Aws::Structure end |
#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.
2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2498 class DocumentClassifierProperties < Struct.new( :document_classifier_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :output_data_config, :classifier_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :mode, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:classifier_metadata] include Aws::Structure end |
#version_name ⇒ String
The version name that you assigned to the document classifier.
2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2498 class DocumentClassifierProperties < Struct.new( :document_classifier_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :output_data_config, :classifier_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :mode, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:classifier_metadata] include Aws::Structure end |
#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"
2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2498 class DocumentClassifierProperties < Struct.new( :document_classifier_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :output_data_config, :classifier_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :mode, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:classifier_metadata] include Aws::Structure end |
#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.
2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2498 class DocumentClassifierProperties < Struct.new( :document_classifier_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :output_data_config, :classifier_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :mode, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:classifier_metadata] include Aws::Structure end |