Package software.amazon.awscdk.services.comprehend

Interface CfnDocumentClassifier.AugmentedManifestsListItemProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDocumentClassifier.AugmentedManifestsListItemProperty.Jsii$Proxy

Enclosing class:

CfnDocumentClassifier

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

An augmented manifest file that provides training data for your custom model.

An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.

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.*;
 AugmentedManifestsListItemProperty augmentedManifestsListItemProperty = AugmentedManifestsListItemProperty.builder()
         .attributeNames(List.of("attributeNames"))
         .s3Uri("s3Uri")
         // the properties below are optional
         .split("split")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDocumentClassifier.AugmentedManifestsListItemProperty.Builder	builder()
List<String>	getAttributeNames()	The JSON attribute that contains the annotations for your training documents.
String	getS3Uri()	The Amazon S3 location of the augmented manifest file.
default String	getSplit()	The purpose of the data you've provided in the augmented manifest.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAttributeNames

@Stability(Stable)
@NotNull
List<String> getAttributeNames()

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.

See Also:

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

getS3Uri

@Stability(Stable)
@NotNull
String getS3Uri()

The Amazon S3 location of the augmented manifest file.

See Also:

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

getSplit

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

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.

See Also:

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

builder

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

Returns:

a CfnDocumentClassifier.AugmentedManifestsListItemProperty.Builder of CfnDocumentClassifier.AugmentedManifestsListItemProperty