Package software.amazon.awscdk.services.comprehend

Interface CfnDocumentClassifier.DocumentClassifierInputDataConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDocumentClassifier.DocumentClassifierInputDataConfigProperty.Jsii$Proxy

Enclosing class:

CfnDocumentClassifier

@Stability(Stable)
public static interface CfnDocumentClassifier.DocumentClassifierInputDataConfigProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.comprehend.*;
 DocumentClassifierInputDataConfigProperty documentClassifierInputDataConfigProperty = DocumentClassifierInputDataConfigProperty.builder()
         .augmentedManifests(List.of(AugmentedManifestsListItemProperty.builder()
                 .attributeNames(List.of("attributeNames"))
                 .s3Uri("s3Uri")
                 // the properties below are optional
                 .split("split")
                 .build()))
         .dataFormat("dataFormat")
         .documentReaderConfig(DocumentReaderConfigProperty.builder()
                 .documentReadAction("documentReadAction")
                 // the properties below are optional
                 .documentReadMode("documentReadMode")
                 .featureTypes(List.of("featureTypes"))
                 .build())
         .documents(DocumentClassifierDocumentsProperty.builder()
                 .s3Uri("s3Uri")
                 // the properties below are optional
                 .testS3Uri("testS3Uri")
                 .build())
         .documentType("documentType")
         .labelDelimiter("labelDelimiter")
         .s3Uri("s3Uri")
         .testS3Uri("testS3Uri")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDocumentClassifier.DocumentClassifierInputDataConfigProperty.Builder	A builder for CfnDocumentClassifier.DocumentClassifierInputDataConfigProperty
static final class	CfnDocumentClassifier.DocumentClassifierInputDataConfigProperty.Jsii$Proxy	An implementation for CfnDocumentClassifier.DocumentClassifierInputDataConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnDocumentClassifier.DocumentClassifierInputDataConfigProperty.Builder	builder()
default Object	getAugmentedManifests()	A list of augmented manifest files that provide training data for your custom model.
default String	getDataFormat()	The format of your training data:.
default Object	getDocumentReaderConfig()
default Object	getDocuments()	The S3 location of the training documents.
default String	getDocumentType()	The type of input documents for training the model.
default String	getLabelDelimiter()	Indicates the delimiter used to separate each label for training a multi-label classifier.
default String	getS3Uri()	The Amazon S3 URI for the input data.
default String	getTestS3Uri()	This specifies the Amazon S3 location that contains the test annotations for the document classifier.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAugmentedManifests

@Stability(Stable)
@Nullable
default Object 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-augmentedmanifests

getDataFormat

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-dataformat

getDocumentReaderConfig

@Stability(Stable)
@Nullable
default Object getDocumentReaderConfig()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-documentreaderconfig

getDocuments

@Stability(Stable)
@Nullable
default Object getDocuments()

The S3 location of the training documents.

This parameter is required in a request to create a native document model.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-documents

getDocumentType

@Stability(Stable)
@Nullable
default String getDocumentType()

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-documenttype

getLabelDelimiter

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-labeldelimiter

getS3Uri

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-s3uri

getTestS3Uri

@Stability(Stable)
@Nullable
default String getTestS3Uri()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-tests3uri

builder

@Stability(Stable)
static CfnDocumentClassifier.DocumentClassifierInputDataConfigProperty.Builder builder()

Returns:

a CfnDocumentClassifier.DocumentClassifierInputDataConfigProperty.Builder of CfnDocumentClassifier.DocumentClassifierInputDataConfigProperty