Package software.amazon.awscdk.services.comprehend

Interface CfnEntityRecognizer.AugmentedManifestsListItemProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEntityRecognizer.AugmentedManifestsListItemProperty.Jsii$Proxy

Enclosing class:

CfnEntityRecognizer

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

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

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
         .annotationDataS3Uri("annotationDataS3Uri")
         .documentType("documentType")
         .sourceDocumentsS3Uri("sourceDocumentsS3Uri")
         .split("split")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnEntityRecognizer.AugmentedManifestsListItemProperty.Builder	builder()
default String	getAnnotationDataS3Uri()	The S3 prefix to the annotation files that are referred in the augmented manifest file.
List<String>	getAttributeNames()	The JSON attribute that contains the annotations for your training documents.
default String	getDocumentType()	The type of augmented manifest.
String	getS3Uri()	The Amazon S3 location of the augmented manifest file.
default String	getSourceDocumentsS3Uri()	The S3 prefix to the source files (PDFs) that are referred to in 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-entityrecognizer-augmentedmanifestslistitem.html#cfn-comprehend-entityrecognizer-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-entityrecognizer-augmentedmanifestslistitem.html#cfn-comprehend-entityrecognizer-augmentedmanifestslistitem-s3uri

getAnnotationDataS3Uri

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

The S3 prefix to the annotation files that are referred in the augmented manifest file.

See Also:

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

getDocumentType

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

The type of augmented manifest.

See Also:

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

getSourceDocumentsS3Uri

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

The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.

See Also:

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

getSplit

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

The purpose of the data you've provided in the augmented manifest.

See Also:

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

builder

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

Returns:

a CfnEntityRecognizer.AugmentedManifestsListItemProperty.Builder of CfnEntityRecognizer.AugmentedManifestsListItemProperty