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

Inherits:
Struct
  • Object
show all
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

Instance Attribute Details

#classifier_metadataTypes::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.



3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3257

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,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#data_access_role_arnString

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

Returns:

  • (String)


3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3257

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,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#document_classifier_arnString

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

Returns:

  • (String)


3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3257

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,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#end_timeTime

The time that training the document classifier completed.

Returns:

  • (Time)


3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3257

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,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#flywheel_arnString

The Amazon Resource Number (ARN) of the flywheel

Returns:

  • (String)


3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3257

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,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#input_data_configTypes::DocumentClassifierInputDataConfig

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



3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3257

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,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#language_codeString

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

Returns:

  • (String)


3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3257

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,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#messageString

Additional information about the status of the classifier.

Returns:

  • (String)


3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3257

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,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#modeString

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.

Returns:

  • (String)


3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3257

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,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#model_kms_key_idString

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"

Returns:

  • (String)


3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3257

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,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#output_data_configTypes::DocumentClassifierOutputDataConfig

Provides output results configuration parameters for custom classifier jobs.



3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3257

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,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#source_model_arnString

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.

Returns:

  • (String)


3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3257

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,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#statusString

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.

Returns:

  • (String)


3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3257

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,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#submit_timeTime

The time that the document classifier was submitted for training.

Returns:

  • (Time)


3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3257

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,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#training_end_timeTime

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)


3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3257

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,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#training_start_timeTime

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)


3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3257

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,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#version_nameString

The version name that you assigned to the document classifier.

Returns:

  • (String)


3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3257

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,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#volume_kms_key_idString

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"

Returns:

  • (String)


3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3257

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,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#vpc_configTypes::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:



3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3257

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,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end