You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Comprehend::Types::DocumentClassifierInputDataConfig
- Inherits:
-
Struct
- Object
- Struct
- Aws::Comprehend::Types::DocumentClassifierInputDataConfig
- Defined in:
- (unknown)
Overview
When passing DocumentClassifierInputDataConfig as input to an Aws::Client method, you can use a vanilla Hash:
{
data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
s3_uri: "S3Uri",
label_delimiter: "LabelDelimiter",
augmented_manifests: [
{
s3_uri: "S3Uri", # required
attribute_names: ["AttributeNamesListItem"], # required
},
],
}
The input properties for training a document classifier.
For more information on how the input file is formatted, see how-document-classification-training-data.
Returned by:
Instance Attribute Summary collapse
-
#augmented_manifests ⇒ Array<Types::AugmentedManifestsListItem>
A list of augmented manifest files that provide training data for your custom model.
-
#data_format ⇒ String
The format of your training data:.
-
#label_delimiter ⇒ String
Indicates the delimiter used to separate each label for training a multi-label classifier.
-
#s3_uri ⇒ String
The Amazon S3 URI for the input data.
Instance Attribute Details
#augmented_manifests ⇒ Array<Types::AugmentedManifestsListItem>
A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
This parameter is required if you set DataFormat
to
AUGMENTED_MANIFEST
.
#data_format ⇒ String
The format of your training data:
COMPREHEND_CSV
: A two-column CSV file, where labels are provided in the first column, and documents are provided in the second. If you use this value, you must provide theS3Uri
parameter in your request.AUGMENTED_MANIFEST
: A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its associated labels.If you use this value, you must provide the
AugmentedManifests
parameter in your request.
If you don\'t specify a value, Amazon Comprehend uses COMPREHEND_CSV
as the default.
Possible values:
- COMPREHEND_CSV
- AUGMENTED_MANIFEST
#label_delimiter ⇒ String
Indicates the delimiter used to separate each label for training a multi-label classifier. The default delimiter between labels is a pipe (|). You can use a different character as a delimiter (if it\'s an allowed character) by specifying it under Delimiter for labels. If the training documents use a delimiter other than the default or the delimiter you specify, the labels on that line will be combined to make a single unique label, such as LABELLABELLABEL.
#s3_uri ⇒ String
The Amazon S3 URI for the input data. The S3 bucket must be in the same region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files.
For example, if you use the URI S3://bucketName/prefix
, if the prefix
is a single file, Amazon Comprehend uses that file as input. If more
than one file begins with the prefix, Amazon Comprehend uses all of them
as input.
This parameter is required if you set DataFormat
to COMPREHEND_CSV
.