Package software.amazon.awscdk.services.comprehend

Interface CfnEntityRecognizer.EntityRecognizerInputDataConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEntityRecognizer.EntityRecognizerInputDataConfigProperty.Jsii$Proxy

Enclosing class:

CfnEntityRecognizer

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

Specifies the format and location of the input data for an entity recognizer.

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.*;
 EntityRecognizerInputDataConfigProperty entityRecognizerInputDataConfigProperty = EntityRecognizerInputDataConfigProperty.builder()
         .entityTypes(List.of(EntityTypesListItemProperty.builder()
                 .type("type")
                 .build()))
         // the properties below are optional
         .annotations(EntityRecognizerAnnotationsProperty.builder()
                 .s3Uri("s3Uri")
                 // the properties below are optional
                 .testS3Uri("testS3Uri")
                 .build())
         .augmentedManifests(List.of(AugmentedManifestsListItemProperty.builder()
                 .attributeNames(List.of("attributeNames"))
                 .s3Uri("s3Uri")
                 // the properties below are optional
                 .annotationDataS3Uri("annotationDataS3Uri")
                 .documentType("documentType")
                 .sourceDocumentsS3Uri("sourceDocumentsS3Uri")
                 .split("split")
                 .build()))
         .dataFormat("dataFormat")
         .documents(EntityRecognizerDocumentsProperty.builder()
                 .s3Uri("s3Uri")
                 // the properties below are optional
                 .inputFormat("inputFormat")
                 .testS3Uri("testS3Uri")
                 .build())
         .entityList(EntityRecognizerEntityListProperty.builder()
                 .s3Uri("s3Uri")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnEntityRecognizer.EntityRecognizerInputDataConfigProperty.Builder	builder()
default Object	getAnnotations()	Describes the annotations associated with an entity recognizer.
default Object	getAugmentedManifests()	A list of augmented manifest files that provide training data for a custom model.
default String	getDataFormat()	The format of your training data.
default Object	getDocuments()	Describes the training documents submitted with an entity recognizer.
default Object	getEntityList()	Describes the entity list submitted with an entity recognizer.
Object	getEntityTypes()	The entity types in the labeled training data.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEntityTypes

@Stability(Stable)
@NotNull
Object getEntityTypes()

The entity types in the labeled training data.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnEntityRecognizer.EntityTypesListItemProperty>

See Also:

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

getAnnotations

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

Describes the annotations associated with an entity recognizer.

Returns union: either IResolvable or CfnEntityRecognizer.EntityRecognizerAnnotationsProperty

See Also:

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

getAugmentedManifests

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

A list of augmented manifest files that provide training data for a custom model.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnEntityRecognizer.AugmentedManifestsListItemProperty>

See Also:

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

getDataFormat

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

The format of your training data.

See Also:

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

getDocuments

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

Describes the training documents submitted with an entity recognizer.

Returns union: either IResolvable or CfnEntityRecognizer.EntityRecognizerDocumentsProperty

See Also:

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

getEntityList

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

Describes the entity list submitted with an entity recognizer.

Returns union: either IResolvable or CfnEntityRecognizer.EntityRecognizerEntityListProperty

See Also:

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

builder

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

Returns:

a CfnEntityRecognizer.EntityRecognizerInputDataConfigProperty.Builder of CfnEntityRecognizer.EntityRecognizerInputDataConfigProperty