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

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:

  • Method Details

    • 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 the isEmpty() 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 format

      If the service returns an enum value that is not available in the current SDK version, dataFormat will return DatasetDataFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataFormatAsString().

      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:

    • 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 format

      If the service returns an enum value that is not available in the current SDK version, dataFormat will return DatasetDataFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataFormatAsString().

      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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DatasetInputDataConfig.Builder,DatasetInputDataConfig>
      Returns:
      a builder for type T

    • builder

      public static DatasetInputDataConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DatasetInputDataConfig.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an 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.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.