AugmentedManifestsListItem.Builder (AWS Java SDK :: Services

All Superinterfaces:

Buildable, CopyableBuilder<AugmentedManifestsListItem.Builder,AugmentedManifestsListItem>, SdkBuilder<AugmentedManifestsListItem.Builder,AugmentedManifestsListItem>, SdkPojo

Enclosing class:

AugmentedManifestsListItem
```
public static interface AugmentedManifestsListItem.Builder
extends SdkPojo, CopyableBuilder<AugmentedManifestsListItem.Builder,AugmentedManifestsListItem>
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AugmentedManifestsListItem.Builder`	`annotationDataS3Uri(String annotationDataS3Uri)` The S3 prefix to the annotation files that are referred in the augmented manifest file.
`AugmentedManifestsListItem.Builder`	`attributeNames(Collection<String> attributeNames)` The JSON attribute that contains the annotations for your training documents.
`AugmentedManifestsListItem.Builder`	`attributeNames(String... attributeNames)` The JSON attribute that contains the annotations for your training documents.
`AugmentedManifestsListItem.Builder`	`documentType(AugmentedManifestsDocumentTypeFormat documentType)` The type of augmented manifest.
`AugmentedManifestsListItem.Builder`	`documentType(String documentType)` The type of augmented manifest.
`AugmentedManifestsListItem.Builder`	`s3Uri(String s3Uri)` The Amazon S3 location of the augmented manifest file.
`AugmentedManifestsListItem.Builder`	`sourceDocumentsS3Uri(String sourceDocumentsS3Uri)` The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
`AugmentedManifestsListItem.Builder`	`split(Split split)` The purpose of the data you've provided in the augmented manifest.
`AugmentedManifestsListItem.Builder`	`split(String split)` The purpose of the data you've provided in the augmented manifest.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - s3Uri
```
AugmentedManifestsListItem.Builder s3Uri(String s3Uri)
```
    The Amazon S3 location of the augmented manifest file.
    
    Parameters:
    
    s3Uri - The Amazon S3 location of the augmented manifest file.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - split
```
AugmentedManifestsListItem.Builder split(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Split, Split
  - split
```
AugmentedManifestsListItem.Builder split(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Split, Split
  - attributeNames
```
AugmentedManifestsListItem.Builder attributeNames(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - attributeNames
```
AugmentedManifestsListItem.Builder attributeNames(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - annotationDataS3Uri
```
AugmentedManifestsListItem.Builder annotationDataS3Uri(String annotationDataS3Uri)
```
    The S3 prefix to the annotation files that are referred in the augmented manifest file.
    
    Parameters:
    
    annotationDataS3Uri - The S3 prefix to the annotation files that are referred in the augmented manifest file.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - sourceDocumentsS3Uri
```
AugmentedManifestsListItem.Builder sourceDocumentsS3Uri(String sourceDocumentsS3Uri)
```
    The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
    
    Parameters:
    
    sourceDocumentsS3Uri - The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - documentType
```
AugmentedManifestsListItem.Builder documentType(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AugmentedManifestsDocumentTypeFormat, AugmentedManifestsDocumentTypeFormat
  - documentType
```
AugmentedManifestsListItem.Builder documentType(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AugmentedManifestsDocumentTypeFormat, AugmentedManifestsDocumentTypeFormat

Interface AugmentedManifestsListItem.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

s3Uri

split

split

attributeNames

attributeNames

annotationDataS3Uri

sourceDocumentsS3Uri

documentType

documentType