Class AugmentedManifestsListItem

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

An augmented manifest file that provides training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.

See Also:

  • Method Details

    • s3Uri

      public final String s3Uri()

      The Amazon S3 location of the augmented manifest file.

      Returns:
      The Amazon S3 location of the augmented manifest file.

    • split

      public final Split split()

      The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.

      TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.

      TEST - all of the documents in the manifest will be used for testing.

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

      Returns:
      The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.

      TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.

      TEST - all of the documents in the manifest will be used for testing.

      See Also:

    • splitAsString

      public final String splitAsString()

      The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.

      TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.

      TEST - all of the documents in the manifest will be used for testing.

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

      Returns:
      The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.

      TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.

      TEST - all of the documents in the manifest will be used for testing.

      See Also:

    • hasAttributeNames

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

    • attributeNames

      public final List<String> attributeNames()

      The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.

      If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.

      If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.

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

      Returns:
      The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.

      If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.

      If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.

    • annotationDataS3Uri

      public final String annotationDataS3Uri()

      The S3 prefix to the annotation files that are referred in the augmented manifest file.

      Returns:
      The S3 prefix to the annotation files that are referred in the augmented manifest file.

    • sourceDocumentsS3Uri

      public final String sourceDocumentsS3Uri()

      The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.

      Returns:
      The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.

    • documentType

      public final AugmentedManifestsDocumentTypeFormat documentType()

      The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.

      • PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.

      • SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.

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

      Returns:
      The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.

      • PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.

      • SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.

      See Also:

    • documentTypeAsString

      public final String documentTypeAsString()

      The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.

      • PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.

      • SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.

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

      Returns:
      The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.

      • PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.

      • SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.

      See Also:

    • toBuilder

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

    • builder

      public static AugmentedManifestsListItem.Builder builder()

    • serializableBuilderClass

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