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

Class CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.comprehend.CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Jsii$Proxy

All Implemented Interfaces:

CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty

@Stability(Stable)
@Internal
public static final class CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty

An implementation for CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.cfnpropertymixins.services.comprehend.CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty

CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Builder, CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getAugmentedManifests()	A list of augmented manifest files that provide training data for your custom model.
final String	getDataFormat()	The format of your training data:.
final Object	getDocumentReaderConfig()	Returns union: either IResolvable or CfnDocumentClassifierPropsMixin.DocumentReaderConfigProperty
final Object	getDocuments()	The S3 location of the training documents.
final String	getDocumentType()	The type of input documents for training the model.
final String	getLabelDelimiter()	Indicates the delimiter used to separate each label for training a multi-label classifier.
final String	getS3Uri()	The Amazon S3 URI for the input data.
final String	getTestS3Uri()	This specifies the Amazon S3 location that contains the test annotations for the document classifier.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty.Builder.

Method Details

getAugmentedManifests

public final Object getAugmentedManifests()

Description copied from interface: CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty

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 union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDocumentClassifierPropsMixin.AugmentedManifestsListItemProperty>

Specified by:

getAugmentedManifests in interface CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty

See Also:

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

getDataFormat

public final String getDataFormat()

Description copied from interface: CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty

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.

Specified by:

getDataFormat in interface CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty

See Also:

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

getDocumentReaderConfig

public final Object getDocumentReaderConfig()

Description copied from interface: CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty

Returns union: either IResolvable or CfnDocumentClassifierPropsMixin.DocumentReaderConfigProperty

Specified by:

getDocumentReaderConfig in interface CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty

See Also:

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

getDocuments

public final Object getDocuments()

Description copied from interface: CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty

The S3 location of the training documents.

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

Returns union: either IResolvable or CfnDocumentClassifierPropsMixin.DocumentClassifierDocumentsProperty

Specified by:

getDocuments in interface CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty

See Also:

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

getDocumentType

public final String getDocumentType()

Description copied from interface: CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty

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.

Specified by:

getDocumentType in interface CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty

See Also:

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

getLabelDelimiter

public final String getLabelDelimiter()

Description copied from interface: CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty

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.

Specified by:

getLabelDelimiter in interface CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty

See Also:

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

getS3Uri

public final String getS3Uri()

Description copied from interface: CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty

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 .

Specified by:

getS3Uri in interface CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty

See Also:

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

getTestS3Uri

public final String getTestS3Uri()

Description copied from interface: CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty

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.

Specified by:

getTestS3Uri in interface CfnDocumentClassifierPropsMixin.DocumentClassifierInputDataConfigProperty

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object