DocumentClassifierInputDataConfig (AWS SDK for Android

java.lang.Object
- com.amazonaws.services.comprehend.model.DocumentClassifierInputDataConfig

All Implemented Interfaces:

java.io.Serializable
```
public class DocumentClassifierInputDataConfig
extends java.lang.Object
implements java.io.Serializable
```
The input properties for training a document classifier.

For more information on how the input file is formatted, see how-document-classification-training-data.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

DocumentClassifierInputDataConfig()

Constructors
Constructor and Description
`DocumentClassifierInputDataConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.util.List<AugmentedManifestsListItem>`	`getAugmentedManifests()` A list of augmented manifest files that provide training data for your custom model.
`java.lang.String`	`getDataFormat()` The format of your training data:
`java.lang.String`	`getLabelDelimiter()` Indicates the delimiter used to separate each label for training a multi-label classifier.
`java.lang.String`	`getS3Uri()` The Amazon S3 URI for the input data.
`int`	`hashCode()`
`void`	`setAugmentedManifests(java.util.Collection<AugmentedManifestsListItem> augmentedManifests)` A list of augmented manifest files that provide training data for your custom model.
`void`	`setDataFormat(DocumentClassifierDataFormat dataFormat)` The format of your training data:
`void`	`setDataFormat(java.lang.String dataFormat)` The format of your training data:
`void`	`setLabelDelimiter(java.lang.String labelDelimiter)` Indicates the delimiter used to separate each label for training a multi-label classifier.
`void`	`setS3Uri(java.lang.String s3Uri)` The Amazon S3 URI for the input data.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DocumentClassifierInputDataConfig`	`withAugmentedManifests(AugmentedManifestsListItem... augmentedManifests)` A list of augmented manifest files that provide training data for your custom model.
`DocumentClassifierInputDataConfig`	`withAugmentedManifests(java.util.Collection<AugmentedManifestsListItem> augmentedManifests)` A list of augmented manifest files that provide training data for your custom model.
`DocumentClassifierInputDataConfig`	`withDataFormat(DocumentClassifierDataFormat dataFormat)` The format of your training data:
`DocumentClassifierInputDataConfig`	`withDataFormat(java.lang.String dataFormat)` The format of your training data:
`DocumentClassifierInputDataConfig`	`withLabelDelimiter(java.lang.String labelDelimiter)` Indicates the delimiter used to separate each label for training a multi-label classifier.
`DocumentClassifierInputDataConfig`	`withS3Uri(java.lang.String s3Uri)` The Amazon S3 URI for the input data.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DocumentClassifierInputDataConfig
```
public DocumentClassifierInputDataConfig()
```
- Method Detail
  - getDataFormat
```
public java.lang.String getDataFormat()
```
    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.
    
    Constraints:
    Allowed Values: COMPREHEND_CSV, AUGMENTED_MANIFEST
    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:
    
    DocumentClassifierDataFormat
  - setDataFormat
```
public void setDataFormat(java.lang.String 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.
    
    Constraints:
    Allowed Values: COMPREHEND_CSV, AUGMENTED_MANIFEST
    Parameters:
    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.
    See Also:
    
    DocumentClassifierDataFormat
  - withDataFormat
```
public DocumentClassifierInputDataConfig withDataFormat(java.lang.String 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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: COMPREHEND_CSV, AUGMENTED_MANIFEST
    Parameters:
    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.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    DocumentClassifierDataFormat
  - setDataFormat
```
public void setDataFormat(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.
    
    Constraints:
    Allowed Values: COMPREHEND_CSV, AUGMENTED_MANIFEST
    Parameters:
    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.
    See Also:
    
    DocumentClassifierDataFormat
  - withDataFormat
```
public DocumentClassifierInputDataConfig withDataFormat(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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: COMPREHEND_CSV, AUGMENTED_MANIFEST
    Parameters:
    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.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    DocumentClassifierDataFormat
  - getS3Uri
```
public java.lang.String getS3Uri()
```
    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.
    
    Constraints:
    Length: - 1024
    Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?
    
    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.
  - setS3Uri
```
public void setS3Uri(java.lang.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.
    
    Constraints:
    Length: - 1024
    Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?
    
    Parameters:
    
    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.
  - withS3Uri
```
public DocumentClassifierInputDataConfig withS3Uri(java.lang.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 a reference to this object so that method calls can be chained together.
    Constraints:
    Length: - 1024
    Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?
    
    Parameters:
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getLabelDelimiter
```
public java.lang.String getLabelDelimiter()
```
    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.
    
    Constraints:
    Length: 1 - 1
    Pattern: ^[ ~!@#$%^*\-_+=|\\:;\t>?/]$
    
    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.
  - setLabelDelimiter
```
public void setLabelDelimiter(java.lang.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.
    
    Constraints:
    Length: 1 - 1
    Pattern: ^[ ~!@#$%^*\-_+=|\\:;\t>?/]$
    
    Parameters:
    
    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.
  - withLabelDelimiter
```
public DocumentClassifierInputDataConfig withLabelDelimiter(java.lang.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 a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 1
    Pattern: ^[ ~!@#$%^*\-_+=|\\:;\t>?/]$
    
    Parameters:
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getAugmentedManifests
```
public java.util.List<AugmentedManifestsListItem> getAugmentedManifests()
```
    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.
    
    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.
  - setAugmentedManifests
```
public void setAugmentedManifests(java.util.Collection<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.
    
    Parameters:
    
    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.
  - withAugmentedManifests
```
public DocumentClassifierInputDataConfig withAugmentedManifests(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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withAugmentedManifests
```
public DocumentClassifierInputDataConfig withAugmentedManifests(java.util.Collection<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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class DocumentClassifierInputDataConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentClassifierInputDataConfig

Method Detail

getDataFormat

setDataFormat

withDataFormat

setDataFormat

withDataFormat

getS3Uri

setS3Uri

withS3Uri

getLabelDelimiter

setLabelDelimiter

withLabelDelimiter

getAugmentedManifests

setAugmentedManifests

withAugmentedManifests

withAugmentedManifests

toString

hashCode

equals