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.InputDataConfig

Description

Documentation

data InputDataConfig Source #

The input properties for an inference job.

See: newInputDataConfig smart constructor.

Constructors

InputDataConfig'

Fields

documentReaderConfig :: Maybe DocumentReaderConfig
The document reader config field applies only for InputDataConfig of StartEntitiesDetectionJob.
Use DocumentReaderConfig to provide specifications about how you want your inference documents read. Currently it applies for PDF documents in StartEntitiesDetectionJob custom inference.
inputFormat :: Maybe InputFormat
Specifies how the text in an input file should be processed:
- 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.
s3Uri :: Text
The Amazon S3 URI for the input data. The URI must be in 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 data 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.

Instances

Instances details

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

newInputDataConfig Source #

Arguments

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

Create a value of InputDataConfig 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:documentReaderConfig:InputDataConfig', inputDataConfig_documentReaderConfig - The document reader config field applies only for InputDataConfig of StartEntitiesDetectionJob.

Use DocumentReaderConfig to provide specifications about how you want your inference documents read. Currently it applies for PDF documents in StartEntitiesDetectionJob custom inference.

$sel:inputFormat:InputDataConfig', inputDataConfig_inputFormat - Specifies how the text in an input file should be processed:

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:s3Uri:InputDataConfig', inputDataConfig_s3Uri - The Amazon S3 URI for the input data. The URI must be in 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 data 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.

inputDataConfig_documentReaderConfig :: Lens' InputDataConfig (Maybe DocumentReaderConfig) Source #

The document reader config field applies only for InputDataConfig of StartEntitiesDetectionJob.

Use DocumentReaderConfig to provide specifications about how you want your inference documents read. Currently it applies for PDF documents in StartEntitiesDetectionJob custom inference.

inputDataConfig_inputFormat :: Lens' InputDataConfig (Maybe InputFormat) Source #

Specifies how the text in an input file should be processed:

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.

inputDataConfig_s3Uri :: Lens' InputDataConfig Text Source #

The Amazon S3 URI for the input data. The URI must be in 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 data 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.