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

#include <AugmentedManifestsListItem.h>

Public Member Functions

 AugmentedManifestsListItem ()
 
 AugmentedManifestsListItem (Aws::Utils::Json::JsonView jsonValue)
 
AugmentedManifestsListItemoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetS3Uri () const
 
bool S3UriHasBeenSet () const
 
void SetS3Uri (const Aws::String &value)
 
void SetS3Uri (Aws::String &&value)
 
void SetS3Uri (const char *value)
 
AugmentedManifestsListItemWithS3Uri (const Aws::String &value)
 
AugmentedManifestsListItemWithS3Uri (Aws::String &&value)
 
AugmentedManifestsListItemWithS3Uri (const char *value)
 
const Aws::Vector< Aws::String > & GetAttributeNames () const
 
bool AttributeNamesHasBeenSet () const
 
void SetAttributeNames (const Aws::Vector< Aws::String > &value)
 
void SetAttributeNames (Aws::Vector< Aws::String > &&value)
 
AugmentedManifestsListItemWithAttributeNames (const Aws::Vector< Aws::String > &value)
 
AugmentedManifestsListItemWithAttributeNames (Aws::Vector< Aws::String > &&value)
 
AugmentedManifestsListItemAddAttributeNames (const Aws::String &value)
 
AugmentedManifestsListItemAddAttributeNames (Aws::String &&value)
 
AugmentedManifestsListItemAddAttributeNames (const char *value)
 
const Aws::StringGetAnnotationDataS3Uri () const
 
bool AnnotationDataS3UriHasBeenSet () const
 
void SetAnnotationDataS3Uri (const Aws::String &value)
 
void SetAnnotationDataS3Uri (Aws::String &&value)
 
void SetAnnotationDataS3Uri (const char *value)
 
AugmentedManifestsListItemWithAnnotationDataS3Uri (const Aws::String &value)
 
AugmentedManifestsListItemWithAnnotationDataS3Uri (Aws::String &&value)
 
AugmentedManifestsListItemWithAnnotationDataS3Uri (const char *value)
 
const Aws::StringGetSourceDocumentsS3Uri () const
 
bool SourceDocumentsS3UriHasBeenSet () const
 
void SetSourceDocumentsS3Uri (const Aws::String &value)
 
void SetSourceDocumentsS3Uri (Aws::String &&value)
 
void SetSourceDocumentsS3Uri (const char *value)
 
AugmentedManifestsListItemWithSourceDocumentsS3Uri (const Aws::String &value)
 
AugmentedManifestsListItemWithSourceDocumentsS3Uri (Aws::String &&value)
 
AugmentedManifestsListItemWithSourceDocumentsS3Uri (const char *value)
 
const AugmentedManifestsDocumentTypeFormatGetDocumentType () const
 
bool DocumentTypeHasBeenSet () const
 
void SetDocumentType (const AugmentedManifestsDocumentTypeFormat &value)
 
void SetDocumentType (AugmentedManifestsDocumentTypeFormat &&value)
 
AugmentedManifestsListItemWithDocumentType (const AugmentedManifestsDocumentTypeFormat &value)
 
AugmentedManifestsListItemWithDocumentType (AugmentedManifestsDocumentTypeFormat &&value)
 

Detailed Description

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.

See Also:

AWS API Reference

Definition at line 35 of file AugmentedManifestsListItem.h.

Constructor & Destructor Documentation

◆ AugmentedManifestsListItem() [1/2]

Aws::Comprehend::Model::AugmentedManifestsListItem::AugmentedManifestsListItem ( )

◆ AugmentedManifestsListItem() [2/2]

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

Member Function Documentation

◆ AddAttributeNames() [1/3]

AugmentedManifestsListItem& Aws::Comprehend::Model::AugmentedManifestsListItem::AddAttributeNames ( Aws::String &&  value)
inline

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.

Definition at line 179 of file AugmentedManifestsListItem.h.

◆ AddAttributeNames() [2/3]

AugmentedManifestsListItem& Aws::Comprehend::Model::AugmentedManifestsListItem::AddAttributeNames ( const Aws::String value)
inline

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.

Definition at line 167 of file AugmentedManifestsListItem.h.

◆ AddAttributeNames() [3/3]

AugmentedManifestsListItem& Aws::Comprehend::Model::AugmentedManifestsListItem::AddAttributeNames ( const char *  value)
inline

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.

Definition at line 191 of file AugmentedManifestsListItem.h.

◆ AnnotationDataS3UriHasBeenSet()

bool Aws::Comprehend::Model::AugmentedManifestsListItem::AnnotationDataS3UriHasBeenSet ( ) const
inline

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

Definition at line 204 of file AugmentedManifestsListItem.h.

◆ AttributeNamesHasBeenSet()

bool Aws::Comprehend::Model::AugmentedManifestsListItem::AttributeNamesHasBeenSet ( ) const
inline

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.

Definition at line 107 of file AugmentedManifestsListItem.h.

◆ DocumentTypeHasBeenSet()

bool Aws::Comprehend::Model::AugmentedManifestsListItem::DocumentTypeHasBeenSet ( ) const
inline

The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.

  • PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.

  • SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.

Definition at line 314 of file AugmentedManifestsListItem.h.

◆ GetAnnotationDataS3Uri()

const Aws::String& Aws::Comprehend::Model::AugmentedManifestsListItem::GetAnnotationDataS3Uri ( ) const
inline

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

Definition at line 198 of file AugmentedManifestsListItem.h.

◆ GetAttributeNames()

const Aws::Vector<Aws::String>& Aws::Comprehend::Model::AugmentedManifestsListItem::GetAttributeNames ( ) const
inline

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.

Definition at line 95 of file AugmentedManifestsListItem.h.

◆ GetDocumentType()

const AugmentedManifestsDocumentTypeFormat& Aws::Comprehend::Model::AugmentedManifestsListItem::GetDocumentType ( ) const
inline

The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.

  • PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.

  • SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.

Definition at line 302 of file AugmentedManifestsListItem.h.

◆ GetS3Uri()

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

The Amazon S3 location of the augmented manifest file.

Definition at line 47 of file AugmentedManifestsListItem.h.

◆ GetSourceDocumentsS3Uri()

const Aws::String& Aws::Comprehend::Model::AugmentedManifestsListItem::GetSourceDocumentsS3Uri ( ) const
inline

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

Definition at line 247 of file AugmentedManifestsListItem.h.

◆ Jsonize()

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

◆ operator=()

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

◆ S3UriHasBeenSet()

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

The Amazon S3 location of the augmented manifest file.

Definition at line 52 of file AugmentedManifestsListItem.h.

◆ SetAnnotationDataS3Uri() [1/3]

void Aws::Comprehend::Model::AugmentedManifestsListItem::SetAnnotationDataS3Uri ( Aws::String &&  value)
inline

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

Definition at line 216 of file AugmentedManifestsListItem.h.

◆ SetAnnotationDataS3Uri() [2/3]

void Aws::Comprehend::Model::AugmentedManifestsListItem::SetAnnotationDataS3Uri ( const Aws::String value)
inline

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

Definition at line 210 of file AugmentedManifestsListItem.h.

◆ SetAnnotationDataS3Uri() [3/3]

void Aws::Comprehend::Model::AugmentedManifestsListItem::SetAnnotationDataS3Uri ( const char *  value)
inline

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

Definition at line 222 of file AugmentedManifestsListItem.h.

◆ SetAttributeNames() [1/2]

void Aws::Comprehend::Model::AugmentedManifestsListItem::SetAttributeNames ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 131 of file AugmentedManifestsListItem.h.

◆ SetAttributeNames() [2/2]

void Aws::Comprehend::Model::AugmentedManifestsListItem::SetAttributeNames ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 119 of file AugmentedManifestsListItem.h.

◆ SetDocumentType() [1/2]

void Aws::Comprehend::Model::AugmentedManifestsListItem::SetDocumentType ( AugmentedManifestsDocumentTypeFormat &&  value)
inline

The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.

  • PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.

  • SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.

Definition at line 338 of file AugmentedManifestsListItem.h.

◆ SetDocumentType() [2/2]

void Aws::Comprehend::Model::AugmentedManifestsListItem::SetDocumentType ( const AugmentedManifestsDocumentTypeFormat value)
inline

The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.

  • PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.

  • SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.

Definition at line 326 of file AugmentedManifestsListItem.h.

◆ SetS3Uri() [1/3]

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

The Amazon S3 location of the augmented manifest file.

Definition at line 62 of file AugmentedManifestsListItem.h.

◆ SetS3Uri() [2/3]

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

The Amazon S3 location of the augmented manifest file.

Definition at line 57 of file AugmentedManifestsListItem.h.

◆ SetS3Uri() [3/3]

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

The Amazon S3 location of the augmented manifest file.

Definition at line 67 of file AugmentedManifestsListItem.h.

◆ SetSourceDocumentsS3Uri() [1/3]

void Aws::Comprehend::Model::AugmentedManifestsListItem::SetSourceDocumentsS3Uri ( Aws::String &&  value)
inline

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

Definition at line 265 of file AugmentedManifestsListItem.h.

◆ SetSourceDocumentsS3Uri() [2/3]

void Aws::Comprehend::Model::AugmentedManifestsListItem::SetSourceDocumentsS3Uri ( const Aws::String value)
inline

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

Definition at line 259 of file AugmentedManifestsListItem.h.

◆ SetSourceDocumentsS3Uri() [3/3]

void Aws::Comprehend::Model::AugmentedManifestsListItem::SetSourceDocumentsS3Uri ( const char *  value)
inline

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

Definition at line 271 of file AugmentedManifestsListItem.h.

◆ SourceDocumentsS3UriHasBeenSet()

bool Aws::Comprehend::Model::AugmentedManifestsListItem::SourceDocumentsS3UriHasBeenSet ( ) const
inline

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

Definition at line 253 of file AugmentedManifestsListItem.h.

◆ WithAnnotationDataS3Uri() [1/3]

AugmentedManifestsListItem& Aws::Comprehend::Model::AugmentedManifestsListItem::WithAnnotationDataS3Uri ( Aws::String &&  value)
inline

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

Definition at line 234 of file AugmentedManifestsListItem.h.

◆ WithAnnotationDataS3Uri() [2/3]

AugmentedManifestsListItem& Aws::Comprehend::Model::AugmentedManifestsListItem::WithAnnotationDataS3Uri ( const Aws::String value)
inline

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

Definition at line 228 of file AugmentedManifestsListItem.h.

◆ WithAnnotationDataS3Uri() [3/3]

AugmentedManifestsListItem& Aws::Comprehend::Model::AugmentedManifestsListItem::WithAnnotationDataS3Uri ( const char *  value)
inline

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

Definition at line 240 of file AugmentedManifestsListItem.h.

◆ WithAttributeNames() [1/2]

AugmentedManifestsListItem& Aws::Comprehend::Model::AugmentedManifestsListItem::WithAttributeNames ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 155 of file AugmentedManifestsListItem.h.

◆ WithAttributeNames() [2/2]

AugmentedManifestsListItem& Aws::Comprehend::Model::AugmentedManifestsListItem::WithAttributeNames ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 143 of file AugmentedManifestsListItem.h.

◆ WithDocumentType() [1/2]

AugmentedManifestsListItem& Aws::Comprehend::Model::AugmentedManifestsListItem::WithDocumentType ( AugmentedManifestsDocumentTypeFormat &&  value)
inline

The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.

  • PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.

  • SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.

Definition at line 362 of file AugmentedManifestsListItem.h.

◆ WithDocumentType() [2/2]

AugmentedManifestsListItem& Aws::Comprehend::Model::AugmentedManifestsListItem::WithDocumentType ( const AugmentedManifestsDocumentTypeFormat value)
inline

The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.

  • PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.

  • SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.

Definition at line 350 of file AugmentedManifestsListItem.h.

◆ WithS3Uri() [1/3]

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

The Amazon S3 location of the augmented manifest file.

Definition at line 77 of file AugmentedManifestsListItem.h.

◆ WithS3Uri() [2/3]

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

The Amazon S3 location of the augmented manifest file.

Definition at line 72 of file AugmentedManifestsListItem.h.

◆ WithS3Uri() [3/3]

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

The Amazon S3 location of the augmented manifest file.

Definition at line 82 of file AugmentedManifestsListItem.h.

◆ WithSourceDocumentsS3Uri() [1/3]

AugmentedManifestsListItem& Aws::Comprehend::Model::AugmentedManifestsListItem::WithSourceDocumentsS3Uri ( Aws::String &&  value)
inline

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

Definition at line 283 of file AugmentedManifestsListItem.h.

◆ WithSourceDocumentsS3Uri() [2/3]

AugmentedManifestsListItem& Aws::Comprehend::Model::AugmentedManifestsListItem::WithSourceDocumentsS3Uri ( const Aws::String value)
inline

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

Definition at line 277 of file AugmentedManifestsListItem.h.

◆ WithSourceDocumentsS3Uri() [3/3]

AugmentedManifestsListItem& Aws::Comprehend::Model::AugmentedManifestsListItem::WithSourceDocumentsS3Uri ( const char *  value)
inline

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

Definition at line 289 of file AugmentedManifestsListItem.h.


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