Class EntityRecognizerInputDataConfig

java.lang.Object
software.amazon.awssdk.services.comprehend.model.EntityRecognizerInputDataConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EntityRecognizerInputDataConfig.Builder,EntityRecognizerInputDataConfig>
@Generated("software.amazon.awssdk:codegen") public final class EntityRecognizerInputDataConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EntityRecognizerInputDataConfig.Builder,EntityRecognizerInputDataConfig>

Specifies the format and location of the input data.

See Also:

  • Method Details

    • dataFormat

      public final EntityRecognizerDataFormat dataFormat()

      The format of your training data:

      • COMPREHEND_CSV: A CSV file that supplements your training documents. The CSV file contains information about the custom entities that your trained model will detect. The required format of the file depends on whether you are providing annotations or an entity list.

        If you use this value, you must provide your CSV file by using either the Annotations or EntityList parameters. You must provide your training documents by using the Documents parameter.

      • 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 labels. Each label annotates a named entity in the training document.

        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 EntityRecognizerDataFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataFormatAsString().

      Returns:
      The format of your training data:

      • COMPREHEND_CSV: A CSV file that supplements your training documents. The CSV file contains information about the custom entities that your trained model will detect. The required format of the file depends on whether you are providing annotations or an entity list.

        If you use this value, you must provide your CSV file by using either the Annotations or EntityList parameters. You must provide your training documents by using the Documents parameter.

      • 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 labels. Each label annotates a named entity in the training document.

        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.

      See Also:

    • dataFormatAsString

      public final String dataFormatAsString()

      The format of your training data:

      • COMPREHEND_CSV: A CSV file that supplements your training documents. The CSV file contains information about the custom entities that your trained model will detect. The required format of the file depends on whether you are providing annotations or an entity list.

        If you use this value, you must provide your CSV file by using either the Annotations or EntityList parameters. You must provide your training documents by using the Documents parameter.

      • 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 labels. Each label annotates a named entity in the training document.

        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 EntityRecognizerDataFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataFormatAsString().

      Returns:
      The format of your training data:

      • COMPREHEND_CSV: A CSV file that supplements your training documents. The CSV file contains information about the custom entities that your trained model will detect. The required format of the file depends on whether you are providing annotations or an entity list.

        If you use this value, you must provide your CSV file by using either the Annotations or EntityList parameters. You must provide your training documents by using the Documents parameter.

      • 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 labels. Each label annotates a named entity in the training document.

        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.

      See Also:

    • hasEntityTypes

      public final boolean hasEntityTypes()
      For responses, this returns true if the service returned a value for the EntityTypes 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.

    • entityTypes

      public final List<EntityTypesListItem> entityTypes()

      The entity types in the labeled training data that Amazon Comprehend uses to train the custom entity recognizer. Any entity types that you don't specify are ignored.

      A maximum of 25 entity types can be used at one time to train an entity recognizer. Entity types must not contain the following invalid characters: \n (line break), \\n (escaped line break), \r (carriage return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), space, and , (comma).

      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 hasEntityTypes() method.

      Returns:
      The entity types in the labeled training data that Amazon Comprehend uses to train the custom entity recognizer. Any entity types that you don't specify are ignored.

      A maximum of 25 entity types can be used at one time to train an entity recognizer. Entity types must not contain the following invalid characters: \n (line break), \\n (escaped line break), \r (carriage return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), space, and , (comma).

    • documents

      public final EntityRecognizerDocuments documents()

      The S3 location of the folder that contains the training documents for your custom entity recognizer.

      This parameter is required if you set DataFormat to COMPREHEND_CSV.

      Returns:
      The S3 location of the folder that contains the training documents for your custom entity recognizer.

      This parameter is required if you set DataFormat to COMPREHEND_CSV.

    • annotations

      public final EntityRecognizerAnnotations annotations()

      The S3 location of the CSV file that annotates your training documents.

      Returns:
      The S3 location of the CSV file that annotates your training documents.

    • entityList

      public final EntityRecognizerEntityList entityList()

      The S3 location of the CSV file that has the entity list for your custom entity recognizer.

      Returns:
      The S3 location of the CSV file that has the entity list for your custom entity recognizer.

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

      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.

      This parameter is required if you set DataFormat to AUGMENTED_MANIFEST.

    • toBuilder

      public EntityRecognizerInputDataConfig.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<EntityRecognizerInputDataConfig.Builder,EntityRecognizerInputDataConfig>
      Returns:
      a builder for type T

    • builder

      public static EntityRecognizerInputDataConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends EntityRecognizerInputDataConfig.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.