libZSservicesZSamazonka-comprehendZSamazonka-comprehend
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Comprehend.Types.EntityRecognizerDocuments

Description

 
Synopsis

Documentation

data EntityRecognizerDocuments Source #

Describes the training documents submitted with an entity recognizer.

See: newEntityRecognizerDocuments smart constructor.

Constructors

EntityRecognizerDocuments' 

Fields

  • inputFormat :: Maybe InputFormat

    Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

  • testS3Uri :: Maybe Text

    Specifies the Amazon S3 location where the test documents for an entity recognizer are located. The URI must be in the same AWS Region as the API endpoint that you are calling.

  • s3Uri :: Text

    Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.

Instances

Instances details
Eq EntityRecognizerDocuments Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDocuments

Read EntityRecognizerDocuments Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDocuments

Show EntityRecognizerDocuments Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDocuments

Generic EntityRecognizerDocuments Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDocuments

Associated Types

type Rep EntityRecognizerDocuments :: Type -> Type #

NFData EntityRecognizerDocuments Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDocuments

Hashable EntityRecognizerDocuments Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDocuments

ToJSON EntityRecognizerDocuments Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDocuments

FromJSON EntityRecognizerDocuments Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDocuments

type Rep EntityRecognizerDocuments Source # 
Instance details

Defined in Amazonka.Comprehend.Types.EntityRecognizerDocuments

type Rep EntityRecognizerDocuments = D1 ('MetaData "EntityRecognizerDocuments" "Amazonka.Comprehend.Types.EntityRecognizerDocuments" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "EntityRecognizerDocuments'" 'PrefixI 'True) (S1 ('MetaSel ('Just "inputFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputFormat)) :*: (S1 ('MetaSel ('Just "testS3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "s3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newEntityRecognizerDocuments Source #

Create a value of EntityRecognizerDocuments 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:inputFormat:EntityRecognizerDocuments', entityRecognizerDocuments_inputFormat - Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

$sel:testS3Uri:EntityRecognizerDocuments', entityRecognizerDocuments_testS3Uri - Specifies the Amazon S3 location where the test documents for an entity recognizer are located. The URI must be in the same AWS Region as the API endpoint that you are calling.

$sel:s3Uri:EntityRecognizerDocuments', entityRecognizerDocuments_s3Uri - Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.

entityRecognizerDocuments_inputFormat :: Lens' EntityRecognizerDocuments (Maybe InputFormat) Source #

Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

entityRecognizerDocuments_testS3Uri :: Lens' EntityRecognizerDocuments (Maybe Text) Source #

Specifies the Amazon S3 location where the test documents for an entity recognizer are located. The URI must be in the same AWS Region as the API endpoint that you are calling.

entityRecognizerDocuments_s3Uri :: Lens' EntityRecognizerDocuments Text Source #

Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.