@Generated(value="software.amazon.awssdk:codegen") public final class DocumentClassifierInputDataConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DocumentClassifierInputDataConfig.Builder,DocumentClassifierInputDataConfig>
The input properties for training a document classifier.
For more information on how the input file is formatted, see how-document-classification-training-data.
Modifier and Type | Class and Description |
---|---|
static interface |
DocumentClassifierInputDataConfig.Builder |
Modifier and Type | Method and Description |
---|---|
List<AugmentedManifestsListItem> |
augmentedManifests()
A list of augmented manifest files that provide training data for your custom model.
|
static DocumentClassifierInputDataConfig.Builder |
builder() |
DocumentClassifierDataFormat |
dataFormat()
The format of your training data:
|
String |
dataFormatAsString()
The format of your training data:
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasAugmentedManifests()
Returns true if the AugmentedManifests property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
int |
hashCode() |
String |
labelDelimiter()
Indicates the delimiter used to separate each label for training a multi-label classifier.
|
String |
s3Uri()
The Amazon S3 URI for the input data.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends DocumentClassifierInputDataConfig.Builder> |
serializableBuilderClass() |
DocumentClassifierInputDataConfig.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
copy
public final DocumentClassifierDataFormat dataFormat()
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 the S3Uri
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.
If the service returns an enum value that is not available in the current SDK version, dataFormat
will
return DocumentClassifierDataFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from dataFormatAsString()
.
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 the S3Uri
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.
DocumentClassifierDataFormat
public final String dataFormatAsString()
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 the S3Uri
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.
If the service returns an enum value that is not available in the current SDK version, dataFormat
will
return DocumentClassifierDataFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from dataFormatAsString()
.
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 the S3Uri
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.
DocumentClassifierDataFormat
public final String s3Uri()
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
.
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
.
public final String labelDelimiter()
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.
public final boolean hasAugmentedManifests()
public final List<AugmentedManifestsListItem> augmentedManifests()
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
.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasAugmentedManifests()
to see if a value was sent in this field.
This parameter is required if you set DataFormat
to AUGMENTED_MANIFEST
.
public DocumentClassifierInputDataConfig.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DocumentClassifierInputDataConfig.Builder,DocumentClassifierInputDataConfig>
public static DocumentClassifierInputDataConfig.Builder builder()
public static Class<? extends DocumentClassifierInputDataConfig.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.