DocumentClassifierInputDataConfig.Builder (AWS Java SDK :: Services

All Superinterfaces:

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

Enclosing class:

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

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`DocumentClassifierInputDataConfig.Builder`	`augmentedManifests(AugmentedManifestsListItem... augmentedManifests)` A list of augmented manifest files that provide training data for your custom model.
`DocumentClassifierInputDataConfig.Builder`	`augmentedManifests(Collection<AugmentedManifestsListItem> augmentedManifests)` A list of augmented manifest files that provide training data for your custom model.
`DocumentClassifierInputDataConfig.Builder`	`augmentedManifests(Consumer<AugmentedManifestsListItem.Builder>... augmentedManifests)` A list of augmented manifest files that provide training data for your custom model.
`DocumentClassifierInputDataConfig.Builder`	`dataFormat(DocumentClassifierDataFormat dataFormat)` The format of your training data:
`DocumentClassifierInputDataConfig.Builder`	`dataFormat(String dataFormat)` The format of your training data:
`default DocumentClassifierInputDataConfig.Builder`	`documentReaderConfig(Consumer<DocumentReaderConfig.Builder> documentReaderConfig)` Sets the value of the DocumentReaderConfig property for this object.
`DocumentClassifierInputDataConfig.Builder`	`documentReaderConfig(DocumentReaderConfig documentReaderConfig)` Sets the value of the DocumentReaderConfig property for this object.
`default DocumentClassifierInputDataConfig.Builder`	`documents(Consumer<DocumentClassifierDocuments.Builder> documents)` The S3 location of the training documents.
`DocumentClassifierInputDataConfig.Builder`	`documents(DocumentClassifierDocuments documents)` The S3 location of the training documents.
`DocumentClassifierInputDataConfig.Builder`	`documentType(DocumentClassifierDocumentTypeFormat documentType)` The type of input documents for training the model.
`DocumentClassifierInputDataConfig.Builder`	`documentType(String documentType)` The type of input documents for training the model.
`DocumentClassifierInputDataConfig.Builder`	`labelDelimiter(String labelDelimiter)` Indicates the delimiter used to separate each label for training a multi-label classifier.
`DocumentClassifierInputDataConfig.Builder`	`s3Uri(String s3Uri)` The Amazon S3 URI for the input data.
`DocumentClassifierInputDataConfig.Builder`	`testS3Uri(String testS3Uri)` This specifies the Amazon S3 location where the test annotations for an entity recognizer are located.

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
  - dataFormat
```
DocumentClassifierInputDataConfig.Builder dataFormat(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.
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentClassifierDataFormat, DocumentClassifierDataFormat
  - dataFormat
```
DocumentClassifierInputDataConfig.Builder dataFormat(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.
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentClassifierDataFormat, DocumentClassifierDataFormat
  - s3Uri
```
DocumentClassifierInputDataConfig.Builder s3Uri(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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - testS3Uri
```
DocumentClassifierInputDataConfig.Builder testS3Uri(String testS3Uri)
```
    This specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same Amazon Web Services Region as the API endpoint that you are calling.
    
    Parameters:
    
    testS3Uri - This specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same Amazon Web Services Region as the API endpoint that you are calling.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - labelDelimiter
```
DocumentClassifierInputDataConfig.Builder labelDelimiter(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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - augmentedManifests
```
DocumentClassifierInputDataConfig.Builder augmentedManifests(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - augmentedManifests
```
DocumentClassifierInputDataConfig.Builder augmentedManifests(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - augmentedManifests
```
DocumentClassifierInputDataConfig.Builder augmentedManifests(Consumer<AugmentedManifestsListItem.Builder>... 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.
    This is a convenience method that creates an instance of the AugmentedManifestsListItem.Builder avoiding the need to create one manually via AugmentedManifestsListItem.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #augmentedManifests(List).
    
    Parameters:
    
    augmentedManifests - a consumer that will call methods on AugmentedManifestsListItem.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #augmentedManifests(java.util.Collection)
  - documentType
```
DocumentClassifierInputDataConfig.Builder documentType(String 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 model.
    
    Parameters:
    
    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 model.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentClassifierDocumentTypeFormat, DocumentClassifierDocumentTypeFormat
  - documentType
```
DocumentClassifierInputDataConfig.Builder documentType(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 model.
    
    Parameters:
    
    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 model.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentClassifierDocumentTypeFormat, DocumentClassifierDocumentTypeFormat
  - documents
```
DocumentClassifierInputDataConfig.Builder documents(DocumentClassifierDocuments documents)
```
    The S3 location of the training documents. This parameter is required in a request to create a native classifier model.
    
    Parameters:
    
    documents - The S3 location of the training documents. This parameter is required in a request to create a native classifier model.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - documents
```
default DocumentClassifierInputDataConfig.Builder documents(Consumer<DocumentClassifierDocuments.Builder> documents)
```
    The S3 location of the training documents. This parameter is required in a request to create a native classifier model.
    This is a convenience method that creates an instance of the DocumentClassifierDocuments.Builder avoiding the need to create one manually via DocumentClassifierDocuments.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to documents(DocumentClassifierDocuments).
    
    Parameters:
    
    documents - a consumer that will call methods on DocumentClassifierDocuments.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    documents(DocumentClassifierDocuments)
  - documentReaderConfig
```
DocumentClassifierInputDataConfig.Builder documentReaderConfig(DocumentReaderConfig documentReaderConfig)
```
    Sets the value of the DocumentReaderConfig property for this object.
    
    Parameters:
    
    documentReaderConfig - The new value for the DocumentReaderConfig property for this object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - documentReaderConfig
```
default DocumentClassifierInputDataConfig.Builder documentReaderConfig(Consumer<DocumentReaderConfig.Builder> documentReaderConfig)
```
    Sets the value of the DocumentReaderConfig property for this object. This is a convenience method that creates an instance of the DocumentReaderConfig.Builder avoiding the need to create one manually via DocumentReaderConfig.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to documentReaderConfig(DocumentReaderConfig).
    
    Parameters:
    
    documentReaderConfig - a consumer that will call methods on DocumentReaderConfig.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    documentReaderConfig(DocumentReaderConfig)

Interface DocumentClassifierInputDataConfig.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

dataFormat

dataFormat

s3Uri

testS3Uri

labelDelimiter

augmentedManifests

augmentedManifests

augmentedManifests

documentType

documentType

documents

documents

documentReaderConfig

documentReaderConfig