Package software.amazon.awscdk.cfnpropertymixins.services.comprehend

Class CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.comprehend.CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty>

Enclosing interface:

CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty

@Stability(Stable)
public static final class CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty>

A builder for CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Builder	augmentedManifests(List<? extends Object> augmentedManifests)	Sets the value of CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.getAugmentedManifests()
CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Builder	augmentedManifests(IResolvable augmentedManifests)	Sets the value of CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.getAugmentedManifests()
CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty	build()	Builds the configured instance.
CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Builder	dataFormat(String dataFormat)	Sets the value of CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.getDataFormat()
CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Builder	documentReaderConfig(CfnDocumentClassifierPropsMixin.DocumentReaderConfigProperty documentReaderConfig)	Sets the value of CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.getDocumentReaderConfig()
CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Builder	documentReaderConfig(IResolvable documentReaderConfig)	Sets the value of CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.getDocumentReaderConfig()
CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Builder	documents(CfnDocumentClassifierPropsMixin.DocumentClassifierDocumentsProperty documents)	Sets the value of CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.getDocuments()
CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Builder	documents(IResolvable documents)	Sets the value of CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.getDocuments()
CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Builder	documentType(String documentType)	Sets the value of CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.getDocumentType()
CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Builder	labelDelimiter(String labelDelimiter)	Sets the value of CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.getLabelDelimiter()
CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Builder	s3Uri(String s3Uri)	Sets the value of CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.getS3Uri()
CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Builder	testS3Uri(String testS3Uri)	Sets the value of CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.getTestS3Uri()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

augmentedManifests

@Stability(Stable)
public CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Builder augmentedManifests(IResolvable augmentedManifests)

Sets the value of CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.getAugmentedManifests()

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:

this

augmentedManifests

@Stability(Stable)
public CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Builder augmentedManifests(List<? extends Object> augmentedManifests)

Sets the value of CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.getAugmentedManifests()

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:

this

dataFormat

@Stability(Stable)
public CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Builder dataFormat(String dataFormat)

Sets the value of CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.getDataFormat()

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:

this

documentReaderConfig

@Stability(Stable)
public CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Builder documentReaderConfig(IResolvable documentReaderConfig)

Sets the value of CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.getDocumentReaderConfig()

Parameters:

documentReaderConfig - the value to be set.

Returns:

this

documentReaderConfig

@Stability(Stable)
public CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Builder documentReaderConfig(CfnDocumentClassifierPropsMixin.DocumentReaderConfigProperty documentReaderConfig)

Sets the value of CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.getDocumentReaderConfig()

Parameters:

documentReaderConfig - the value to be set.

Returns:

this

documents

@Stability(Stable)
public CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Builder documents(IResolvable documents)

Sets the value of CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.getDocuments()

Parameters:

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

Returns:

this

documents

@Stability(Stable)
public CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Builder documents(CfnDocumentClassifierPropsMixin.DocumentClassifierDocumentsProperty documents)

Sets the value of CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.getDocuments()

Parameters:

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

Returns:

this

documentType

@Stability(Stable)
public CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Builder documentType(String documentType)

Sets the value of CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.getDocumentType()

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 document model.

Returns:

this

labelDelimiter

@Stability(Stable)
public CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Builder labelDelimiter(String labelDelimiter)

Sets the value of CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.getLabelDelimiter()

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:

this

s3Uri

@Stability(Stable)
public CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Builder s3Uri(String s3Uri)

Sets the value of CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.getS3Uri()

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:

this

testS3Uri

@Stability(Stable)
public CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Builder testS3Uri(String testS3Uri)

Sets the value of CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.getTestS3Uri()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty>

Returns:

a new instance of CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty

Throws:

NullPointerException - if any required attribute was not provided