Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Comprehend.Types.AugmentedManifestsListItem

Description

Synopsis

Documentation

data AugmentedManifestsListItem Source #

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: newAugmentedManifestsListItem smart constructor.

Constructors

AugmentedManifestsListItem'

Fields

sourceDocumentsS3Uri :: Maybe Text
The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
documentType :: Maybe AugmentedManifestsDocumentTypeFormat
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.
split :: Maybe Split
The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.
TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.
TEST - all of the documents in the manifest will be used for testing.
annotationDataS3Uri :: Maybe Text
The S3 prefix to the annotation files that are referred in the augmented manifest file.
s3Uri :: Text
The Amazon S3 location of the augmented manifest file.
attributeNames :: [Text]
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.

Instances

Instances details

Eq AugmentedManifestsListItem Source #
Instance details Defined in Amazonka.Comprehend.Types.AugmentedManifestsListItem Methods (==) :: AugmentedManifestsListItem -> AugmentedManifestsListItem -> Bool # (/=) :: AugmentedManifestsListItem -> AugmentedManifestsListItem -> Bool #
Read AugmentedManifestsListItem Source #
Instance details Defined in Amazonka.Comprehend.Types.AugmentedManifestsListItem Methods readsPrec :: Int -> ReadS AugmentedManifestsListItem # readList :: ReadS [AugmentedManifestsListItem] # readPrec :: ReadPrec AugmentedManifestsListItem # readListPrec :: ReadPrec [AugmentedManifestsListItem] #
Show AugmentedManifestsListItem Source #
Instance details Defined in Amazonka.Comprehend.Types.AugmentedManifestsListItem Methods showsPrec :: Int -> AugmentedManifestsListItem -> ShowS # show :: AugmentedManifestsListItem -> String # showList :: [AugmentedManifestsListItem] -> ShowS #
Generic AugmentedManifestsListItem Source #
Instance details Defined in Amazonka.Comprehend.Types.AugmentedManifestsListItem Associated Types type Rep AugmentedManifestsListItem :: Type -> Type # Methods from :: AugmentedManifestsListItem -> Rep AugmentedManifestsListItem x # to :: Rep AugmentedManifestsListItem x -> AugmentedManifestsListItem #
NFData AugmentedManifestsListItem Source #
Instance details Defined in Amazonka.Comprehend.Types.AugmentedManifestsListItem Methods rnf :: AugmentedManifestsListItem -> () #
Hashable AugmentedManifestsListItem Source #
Instance details Defined in Amazonka.Comprehend.Types.AugmentedManifestsListItem Methods hashWithSalt :: Int -> AugmentedManifestsListItem -> Int # hash :: AugmentedManifestsListItem -> Int #
ToJSON AugmentedManifestsListItem Source #
Instance details Defined in Amazonka.Comprehend.Types.AugmentedManifestsListItem Methods toJSON :: AugmentedManifestsListItem -> Value # toEncoding :: AugmentedManifestsListItem -> Encoding # toJSONList :: [AugmentedManifestsListItem] -> Value # toEncodingList :: [AugmentedManifestsListItem] -> Encoding #
FromJSON AugmentedManifestsListItem Source #
Instance details Defined in Amazonka.Comprehend.Types.AugmentedManifestsListItem Methods parseJSON :: Value -> Parser AugmentedManifestsListItem # parseJSONList :: Value -> Parser [AugmentedManifestsListItem] #
type Rep AugmentedManifestsListItem Source #
Instance details Defined in Amazonka.Comprehend.Types.AugmentedManifestsListItem type Rep AugmentedManifestsListItem = D1 ('MetaData "AugmentedManifestsListItem" "Amazonka.Comprehend.Types.AugmentedManifestsListItem" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "AugmentedManifestsListItem'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sourceDocumentsS3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "documentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AugmentedManifestsDocumentTypeFormat)) :: S1 ('MetaSel ('Just "split") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Split)))) :: (S1 ('MetaSel ('Just "annotationDataS3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "s3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "attributeNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))))

newAugmentedManifestsListItem Source #

Arguments

:: Text	`$sel:s3Uri:AugmentedManifestsListItem'`
-> AugmentedManifestsListItem

Create a value of AugmentedManifestsListItem with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sourceDocumentsS3Uri:AugmentedManifestsListItem', augmentedManifestsListItem_sourceDocumentsS3Uri - The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.

$sel:documentType:AugmentedManifestsListItem', augmentedManifestsListItem_documentType - 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.

$sel:split:AugmentedManifestsListItem', augmentedManifestsListItem_split - The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.

TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.

TEST - all of the documents in the manifest will be used for testing.

$sel:annotationDataS3Uri:AugmentedManifestsListItem', augmentedManifestsListItem_annotationDataS3Uri - The S3 prefix to the annotation files that are referred in the augmented manifest file.

$sel:s3Uri:AugmentedManifestsListItem', augmentedManifestsListItem_s3Uri - The Amazon S3 location of the augmented manifest file.

$sel:attributeNames:AugmentedManifestsListItem', augmentedManifestsListItem_attributeNames - 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.

augmentedManifestsListItem_sourceDocumentsS3Uri :: Lens' AugmentedManifestsListItem (Maybe Text) Source #

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

augmentedManifestsListItem_documentType :: Lens' AugmentedManifestsListItem (Maybe AugmentedManifestsDocumentTypeFormat) Source #

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.

augmentedManifestsListItem_split :: Lens' AugmentedManifestsListItem (Maybe Split) Source #

The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.

TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.

TEST - all of the documents in the manifest will be used for testing.

augmentedManifestsListItem_annotationDataS3Uri :: Lens' AugmentedManifestsListItem (Maybe Text) Source #

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

augmentedManifestsListItem_s3Uri :: Lens' AugmentedManifestsListItem Text Source #

The Amazon S3 location of the augmented manifest file.

augmentedManifestsListItem_attributeNames :: Lens' AugmentedManifestsListItem [Text] Source #

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.