Package software.amazon.awssdk.services.comprehend.model

Class DatasetDocumentClassifierInputDataConfig

java.lang.Object

software.amazon.awssdk.services.comprehend.model.DatasetDocumentClassifierInputDataConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DatasetDocumentClassifierInputDataConfig.Builder,DatasetDocumentClassifierInputDataConfig>

@Generated("software.amazon.awssdk:codegen")
public final class DatasetDocumentClassifierInputDataConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DatasetDocumentClassifierInputDataConfig.Builder,DatasetDocumentClassifierInputDataConfig>

Describes the dataset input data configuration for a document classifier model.

For more information on how the input file is formatted, see Preparing training data in the Comprehend Developer Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DatasetDocumentClassifierInputDataConfig.Builder

Method Summary

Modifier and Type	Method	Description
static DatasetDocumentClassifierInputDataConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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 DatasetDocumentClassifierInputDataConfig.Builder>	serializableBuilderClass()
DatasetDocumentClassifierInputDataConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

s3Uri

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.

Returns:

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.

labelDelimiter

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.

Returns:

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.

toBuilder

public DatasetDocumentClassifierInputDataConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DatasetDocumentClassifierInputDataConfig.Builder,DatasetDocumentClassifierInputDataConfig>

builder

public static DatasetDocumentClassifierInputDataConfig.Builder builder()

serializableBuilderClass

public static Class<? extends DatasetDocumentClassifierInputDataConfig.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo