Class DocumentClassifierInputDataConfig

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

The input properties for training a document classifier.

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

See Also:

  • Method Details

    • dataFormat

      public final DocumentClassifierDataFormat dataFormat()

      The format of your training data:

      • COMPREHEND_CSV: A two-column CSV file, where labels are provided in the first column, and documents are provided in the second. If you use this value, you must provide the S3Uri parameter in your request.

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

        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 DocumentClassifierDataFormat.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 two-column CSV file, where labels are provided in the first column, and documents are provided in the second. If you use this value, you must provide the S3Uri parameter in your request.

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

        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 two-column CSV file, where labels are provided in the first column, and documents are provided in the second. If you use this value, you must provide the S3Uri parameter in your request.

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

        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 DocumentClassifierDataFormat.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 two-column CSV file, where labels are provided in the first column, and documents are provided in the second. If you use this value, you must provide the S3Uri parameter in your request.

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

        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:

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

    • testS3Uri

      public final String testS3Uri()

      This specifies the Amazon S3 location that contains the test annotations for the document classifier. The URI must be in the same Amazon Web Services Region as the API endpoint that you are calling.

      Returns:
      This specifies the Amazon S3 location that contains the test annotations for the document classifier. The URI must be in the same Amazon Web Services Region as the API endpoint that you are calling.

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

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

    • documentType

      public final DocumentClassifierDocumentTypeFormat documentType()

      The type of input documents for training the model. Provide plain-text documents to create a plain-text model, and provide semi-structured documents to create a native document model.

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

      Returns:
      The type of input documents for training the model. Provide plain-text documents to create a plain-text model, and provide semi-structured documents to create a native document model.
      See Also:

    • documentTypeAsString

      public final String documentTypeAsString()

      The type of input documents for training the model. Provide plain-text documents to create a plain-text model, and provide semi-structured documents to create a native document model.

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

      Returns:
      The type of input documents for training the model. Provide plain-text documents to create a plain-text model, and provide semi-structured documents to create a native document model.
      See Also:

    • documents

      public final DocumentClassifierDocuments documents()

      The S3 location of the training documents. This parameter is required in a request to create a native document model.

      Returns:
      The S3 location of the training documents. This parameter is required in a request to create a native document model.

    • documentReaderConfig

      public final DocumentReaderConfig documentReaderConfig()
      Returns the value of the DocumentReaderConfig property for this object.
      Returns:
      The value of the DocumentReaderConfig property for this object.

    • toBuilder

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

    • builder

      public static DocumentClassifierInputDataConfig.Builder builder()

    • serializableBuilderClass

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