AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::Comprehend::Model::DocumentClassifierInputDataConfig Class Reference

#include <DocumentClassifierInputDataConfig.h>

Public Member Functions

 DocumentClassifierInputDataConfig ()
 
 DocumentClassifierInputDataConfig (Aws::Utils::Json::JsonView jsonValue)
 
DocumentClassifierInputDataConfigoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const DocumentClassifierDataFormatGetDataFormat () const
 
bool DataFormatHasBeenSet () const
 
void SetDataFormat (const DocumentClassifierDataFormat &value)
 
void SetDataFormat (DocumentClassifierDataFormat &&value)
 
DocumentClassifierInputDataConfigWithDataFormat (const DocumentClassifierDataFormat &value)
 
DocumentClassifierInputDataConfigWithDataFormat (DocumentClassifierDataFormat &&value)
 
const Aws::StringGetS3Uri () const
 
bool S3UriHasBeenSet () const
 
void SetS3Uri (const Aws::String &value)
 
void SetS3Uri (Aws::String &&value)
 
void SetS3Uri (const char *value)
 
DocumentClassifierInputDataConfigWithS3Uri (const Aws::String &value)
 
DocumentClassifierInputDataConfigWithS3Uri (Aws::String &&value)
 
DocumentClassifierInputDataConfigWithS3Uri (const char *value)
 
const Aws::StringGetLabelDelimiter () const
 
bool LabelDelimiterHasBeenSet () const
 
void SetLabelDelimiter (const Aws::String &value)
 
void SetLabelDelimiter (Aws::String &&value)
 
void SetLabelDelimiter (const char *value)
 
DocumentClassifierInputDataConfigWithLabelDelimiter (const Aws::String &value)
 
DocumentClassifierInputDataConfigWithLabelDelimiter (Aws::String &&value)
 
DocumentClassifierInputDataConfigWithLabelDelimiter (const char *value)
 
const Aws::Vector< AugmentedManifestsListItem > & GetAugmentedManifests () const
 
bool AugmentedManifestsHasBeenSet () const
 
void SetAugmentedManifests (const Aws::Vector< AugmentedManifestsListItem > &value)
 
void SetAugmentedManifests (Aws::Vector< AugmentedManifestsListItem > &&value)
 
DocumentClassifierInputDataConfigWithAugmentedManifests (const Aws::Vector< AugmentedManifestsListItem > &value)
 
DocumentClassifierInputDataConfigWithAugmentedManifests (Aws::Vector< AugmentedManifestsListItem > &&value)
 
DocumentClassifierInputDataConfigAddAugmentedManifests (const AugmentedManifestsListItem &value)
 
DocumentClassifierInputDataConfigAddAugmentedManifests (AugmentedManifestsListItem &&value)
 

Detailed Description

The input properties for training a document classifier.

For more information on how the input file is formatted, see how-document-classification-training-data.

See Also:

AWS API Reference

Definition at line 36 of file DocumentClassifierInputDataConfig.h.

Constructor & Destructor Documentation

◆ DocumentClassifierInputDataConfig() [1/2]

Aws::Comprehend::Model::DocumentClassifierInputDataConfig::DocumentClassifierInputDataConfig ( )

◆ DocumentClassifierInputDataConfig() [2/2]

Aws::Comprehend::Model::DocumentClassifierInputDataConfig::DocumentClassifierInputDataConfig ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddAugmentedManifests() [1/2]

DocumentClassifierInputDataConfig& Aws::Comprehend::Model::DocumentClassifierInputDataConfig::AddAugmentedManifests ( const AugmentedManifestsListItem value)
inline

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.

Definition at line 376 of file DocumentClassifierInputDataConfig.h.

◆ AddAugmentedManifests() [2/2]

DocumentClassifierInputDataConfig& Aws::Comprehend::Model::DocumentClassifierInputDataConfig::AddAugmentedManifests ( AugmentedManifestsListItem &&  value)
inline

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.

Definition at line 384 of file DocumentClassifierInputDataConfig.h.

◆ AugmentedManifestsHasBeenSet()

bool Aws::Comprehend::Model::DocumentClassifierInputDataConfig::AugmentedManifestsHasBeenSet ( ) const
inline

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.

Definition at line 336 of file DocumentClassifierInputDataConfig.h.

◆ DataFormatHasBeenSet()

bool Aws::Comprehend::Model::DocumentClassifierInputDataConfig::DataFormatHasBeenSet ( ) const
inline

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.

Definition at line 73 of file DocumentClassifierInputDataConfig.h.

◆ GetAugmentedManifests()

const Aws::Vector<AugmentedManifestsListItem>& Aws::Comprehend::Model::DocumentClassifierInputDataConfig::GetAugmentedManifests ( ) const
inline

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.

Definition at line 328 of file DocumentClassifierInputDataConfig.h.

◆ GetDataFormat()

const DocumentClassifierDataFormat& Aws::Comprehend::Model::DocumentClassifierInputDataConfig::GetDataFormat ( ) const
inline

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.

Definition at line 58 of file DocumentClassifierInputDataConfig.h.

◆ GetLabelDelimiter()

const Aws::String& Aws::Comprehend::Model::DocumentClassifierInputDataConfig::GetLabelDelimiter ( ) const
inline

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.

Definition at line 242 of file DocumentClassifierInputDataConfig.h.

◆ GetS3Uri()

const Aws::String& Aws::Comprehend::Model::DocumentClassifierInputDataConfig::GetS3Uri ( ) const
inline

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.

Definition at line 146 of file DocumentClassifierInputDataConfig.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Comprehend::Model::DocumentClassifierInputDataConfig::Jsonize ( ) const

◆ LabelDelimiterHasBeenSet()

bool Aws::Comprehend::Model::DocumentClassifierInputDataConfig::LabelDelimiterHasBeenSet ( ) const
inline

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.

Definition at line 253 of file DocumentClassifierInputDataConfig.h.

◆ operator=()

DocumentClassifierInputDataConfig& Aws::Comprehend::Model::DocumentClassifierInputDataConfig::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ S3UriHasBeenSet()

bool Aws::Comprehend::Model::DocumentClassifierInputDataConfig::S3UriHasBeenSet ( ) const
inline

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.

Definition at line 158 of file DocumentClassifierInputDataConfig.h.

◆ SetAugmentedManifests() [1/2]

void Aws::Comprehend::Model::DocumentClassifierInputDataConfig::SetAugmentedManifests ( const Aws::Vector< AugmentedManifestsListItem > &  value)
inline

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.

Definition at line 344 of file DocumentClassifierInputDataConfig.h.

◆ SetAugmentedManifests() [2/2]

void Aws::Comprehend::Model::DocumentClassifierInputDataConfig::SetAugmentedManifests ( Aws::Vector< AugmentedManifestsListItem > &&  value)
inline

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.

Definition at line 352 of file DocumentClassifierInputDataConfig.h.

◆ SetDataFormat() [1/2]

void Aws::Comprehend::Model::DocumentClassifierInputDataConfig::SetDataFormat ( const DocumentClassifierDataFormat value)
inline

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.

Definition at line 88 of file DocumentClassifierInputDataConfig.h.

◆ SetDataFormat() [2/2]

void Aws::Comprehend::Model::DocumentClassifierInputDataConfig::SetDataFormat ( DocumentClassifierDataFormat &&  value)
inline

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.

Definition at line 103 of file DocumentClassifierInputDataConfig.h.

◆ SetLabelDelimiter() [1/3]

void Aws::Comprehend::Model::DocumentClassifierInputDataConfig::SetLabelDelimiter ( const Aws::String value)
inline

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.

Definition at line 264 of file DocumentClassifierInputDataConfig.h.

◆ SetLabelDelimiter() [2/3]

void Aws::Comprehend::Model::DocumentClassifierInputDataConfig::SetLabelDelimiter ( Aws::String &&  value)
inline

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.

Definition at line 275 of file DocumentClassifierInputDataConfig.h.

◆ SetLabelDelimiter() [3/3]

void Aws::Comprehend::Model::DocumentClassifierInputDataConfig::SetLabelDelimiter ( const char *  value)
inline

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.

Definition at line 286 of file DocumentClassifierInputDataConfig.h.

◆ SetS3Uri() [1/3]

void Aws::Comprehend::Model::DocumentClassifierInputDataConfig::SetS3Uri ( const Aws::String value)
inline

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.

Definition at line 170 of file DocumentClassifierInputDataConfig.h.

◆ SetS3Uri() [2/3]

void Aws::Comprehend::Model::DocumentClassifierInputDataConfig::SetS3Uri ( Aws::String &&  value)
inline

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.

Definition at line 182 of file DocumentClassifierInputDataConfig.h.

◆ SetS3Uri() [3/3]

void Aws::Comprehend::Model::DocumentClassifierInputDataConfig::SetS3Uri ( const char *  value)
inline

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.

Definition at line 194 of file DocumentClassifierInputDataConfig.h.

◆ WithAugmentedManifests() [1/2]

DocumentClassifierInputDataConfig& Aws::Comprehend::Model::DocumentClassifierInputDataConfig::WithAugmentedManifests ( const Aws::Vector< AugmentedManifestsListItem > &  value)
inline

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.

Definition at line 360 of file DocumentClassifierInputDataConfig.h.

◆ WithAugmentedManifests() [2/2]

DocumentClassifierInputDataConfig& Aws::Comprehend::Model::DocumentClassifierInputDataConfig::WithAugmentedManifests ( Aws::Vector< AugmentedManifestsListItem > &&  value)
inline

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.

Definition at line 368 of file DocumentClassifierInputDataConfig.h.

◆ WithDataFormat() [1/2]

DocumentClassifierInputDataConfig& Aws::Comprehend::Model::DocumentClassifierInputDataConfig::WithDataFormat ( const DocumentClassifierDataFormat value)
inline

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.

Definition at line 118 of file DocumentClassifierInputDataConfig.h.

◆ WithDataFormat() [2/2]

DocumentClassifierInputDataConfig& Aws::Comprehend::Model::DocumentClassifierInputDataConfig::WithDataFormat ( DocumentClassifierDataFormat &&  value)
inline

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.

Definition at line 133 of file DocumentClassifierInputDataConfig.h.

◆ WithLabelDelimiter() [1/3]

DocumentClassifierInputDataConfig& Aws::Comprehend::Model::DocumentClassifierInputDataConfig::WithLabelDelimiter ( const Aws::String value)
inline

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.

Definition at line 297 of file DocumentClassifierInputDataConfig.h.

◆ WithLabelDelimiter() [2/3]

DocumentClassifierInputDataConfig& Aws::Comprehend::Model::DocumentClassifierInputDataConfig::WithLabelDelimiter ( Aws::String &&  value)
inline

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.

Definition at line 308 of file DocumentClassifierInputDataConfig.h.

◆ WithLabelDelimiter() [3/3]

DocumentClassifierInputDataConfig& Aws::Comprehend::Model::DocumentClassifierInputDataConfig::WithLabelDelimiter ( const char *  value)
inline

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.

Definition at line 319 of file DocumentClassifierInputDataConfig.h.

◆ WithS3Uri() [1/3]

DocumentClassifierInputDataConfig& Aws::Comprehend::Model::DocumentClassifierInputDataConfig::WithS3Uri ( const Aws::String value)
inline

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.

Definition at line 206 of file DocumentClassifierInputDataConfig.h.

◆ WithS3Uri() [2/3]

DocumentClassifierInputDataConfig& Aws::Comprehend::Model::DocumentClassifierInputDataConfig::WithS3Uri ( Aws::String &&  value)
inline

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.

Definition at line 218 of file DocumentClassifierInputDataConfig.h.

◆ WithS3Uri() [3/3]

DocumentClassifierInputDataConfig& Aws::Comprehend::Model::DocumentClassifierInputDataConfig::WithS3Uri ( const char *  value)
inline

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.

Definition at line 230 of file DocumentClassifierInputDataConfig.h.


The documentation for this class was generated from the following file: