Class DatasetInputDataConfig
- java.lang.Object
-
- software.amazon.awssdk.services.comprehend.model.DatasetInputDataConfig
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<DatasetInputDataConfig.Builder,DatasetInputDataConfig>
@Generated("software.amazon.awssdk:codegen") public final class DatasetInputDataConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DatasetInputDataConfig.Builder,DatasetInputDataConfig>
Specifies the format and location of the input data for the dataset.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDatasetInputDataConfig.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<DatasetAugmentedManifestsListItem>augmentedManifests()A list of augmented manifest files that provide training data for your custom model.static DatasetInputDataConfig.Builderbuilder()DatasetDataFormatdataFormat()COMPREHEND_CSV: The data format is a two-column CSV file, where the first column contains labels and the second column contains documents.StringdataFormatAsString()COMPREHEND_CSV: The data format is a two-column CSV file, where the first column contains labels and the second column contains documents.DatasetDocumentClassifierInputDataConfigdocumentClassifierInputDataConfig()The input properties for training a document classifier model.DatasetEntityRecognizerInputDataConfigentityRecognizerInputDataConfig()The input properties for training an entity recognizer model.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAugmentedManifests()For responses, this returns true if the service returned a value for the AugmentedManifests property.inthashCode()List<SdkField<?>>sdkFields()static Class<? extends DatasetInputDataConfig.Builder>serializableBuilderClass()DatasetInputDataConfig.BuildertoBuilder()StringtoString()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
-
hasAugmentedManifests
public final boolean hasAugmentedManifests()
For responses, this returns true if the service returned a value for the AugmentedManifests property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
augmentedManifests
public final List<DatasetAugmentedManifestsListItem> 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAugmentedManifests()method.- Returns:
- 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.
-
dataFormat
public final DatasetDataFormat dataFormat()
COMPREHEND_CSV: The data format is a two-column CSV file, where the first column contains labels and the second column contains documents.AUGMENTED_MANIFEST: The data formatIf the service returns an enum value that is not available in the current SDK version,
dataFormatwill returnDatasetDataFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdataFormatAsString().- Returns:
COMPREHEND_CSV: The data format is a two-column CSV file, where the first column contains labels and the second column contains documents.AUGMENTED_MANIFEST: The data format- See Also:
DatasetDataFormat
-
dataFormatAsString
public final String dataFormatAsString()
COMPREHEND_CSV: The data format is a two-column CSV file, where the first column contains labels and the second column contains documents.AUGMENTED_MANIFEST: The data formatIf the service returns an enum value that is not available in the current SDK version,
dataFormatwill returnDatasetDataFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdataFormatAsString().- Returns:
COMPREHEND_CSV: The data format is a two-column CSV file, where the first column contains labels and the second column contains documents.AUGMENTED_MANIFEST: The data format- See Also:
DatasetDataFormat
-
documentClassifierInputDataConfig
public final DatasetDocumentClassifierInputDataConfig documentClassifierInputDataConfig()
The input properties for training a document classifier model.
For more information on how the input file is formatted, see Preparing training data in the Comprehend Developer Guide.
- Returns:
- The input properties for training a document classifier model.
For more information on how the input file is formatted, see Preparing training data in the Comprehend Developer Guide.
-
entityRecognizerInputDataConfig
public final DatasetEntityRecognizerInputDataConfig entityRecognizerInputDataConfig()
The input properties for training an entity recognizer model.
- Returns:
- The input properties for training an entity recognizer model.
-
toBuilder
public DatasetInputDataConfig.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DatasetInputDataConfig.Builder,DatasetInputDataConfig>
-
builder
public static DatasetInputDataConfig.Builder builder()
-
serializableBuilderClass
public static Class<? extends DatasetInputDataConfig.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-