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

Description

 
Synopsis

Documentation

data DocumentReaderConfig Source #

The input properties for a topic detection job.

See: newDocumentReaderConfig smart constructor.

Constructors

DocumentReaderConfig' 

Fields

  • featureTypes :: Maybe (NonEmpty DocumentReadFeatureTypes)

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

  • documentReadMode :: Maybe DocumentReadMode

    This enum field provides two values:

    • SERVICE_DEFAULT - use service defaults for Document reading. For Digital PDF it would mean using an internal parser instead of Textract APIs
    • FORCE_DOCUMENT_READ_ACTION - Always use specified action for DocumentReadAction, including Digital PDF.
  • documentReadAction :: DocumentReadAction

    This enum field will start with two values which will apply to PDFs:

    • TEXTRACT_DETECT_DOCUMENT_TEXT - The service calls DetectDocumentText for PDF documents per page.
    • TEXTRACT_ANALYZE_DOCUMENT - The service calls AnalyzeDocument for PDF documents per page.

Instances

Instances details
Eq DocumentReaderConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReaderConfig

Read DocumentReaderConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReaderConfig

Show DocumentReaderConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReaderConfig

Generic DocumentReaderConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReaderConfig

Associated Types

type Rep DocumentReaderConfig :: Type -> Type #

NFData DocumentReaderConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReaderConfig

Methods

rnf :: DocumentReaderConfig -> () #

Hashable DocumentReaderConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReaderConfig

ToJSON DocumentReaderConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReaderConfig

FromJSON DocumentReaderConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReaderConfig

type Rep DocumentReaderConfig Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentReaderConfig

type Rep DocumentReaderConfig = D1 ('MetaData "DocumentReaderConfig" "Amazonka.Comprehend.Types.DocumentReaderConfig" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DocumentReaderConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "featureTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DocumentReadFeatureTypes))) :*: (S1 ('MetaSel ('Just "documentReadMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentReadMode)) :*: S1 ('MetaSel ('Just "documentReadAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DocumentReadAction))))

newDocumentReaderConfig Source #

Create a value of DocumentReaderConfig 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:featureTypes:DocumentReaderConfig', documentReaderConfig_featureTypes - Specifies how the text in an input file should be processed:

$sel:documentReadMode:DocumentReaderConfig', documentReaderConfig_documentReadMode - This enum field provides two values:

  • SERVICE_DEFAULT - use service defaults for Document reading. For Digital PDF it would mean using an internal parser instead of Textract APIs
  • FORCE_DOCUMENT_READ_ACTION - Always use specified action for DocumentReadAction, including Digital PDF.

$sel:documentReadAction:DocumentReaderConfig', documentReaderConfig_documentReadAction - This enum field will start with two values which will apply to PDFs:

  • TEXTRACT_DETECT_DOCUMENT_TEXT - The service calls DetectDocumentText for PDF documents per page.
  • TEXTRACT_ANALYZE_DOCUMENT - The service calls AnalyzeDocument for PDF documents per page.

documentReaderConfig_featureTypes :: Lens' DocumentReaderConfig (Maybe (NonEmpty DocumentReadFeatureTypes)) Source #

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

documentReaderConfig_documentReadMode :: Lens' DocumentReaderConfig (Maybe DocumentReadMode) Source #

This enum field provides two values:

  • SERVICE_DEFAULT - use service defaults for Document reading. For Digital PDF it would mean using an internal parser instead of Textract APIs
  • FORCE_DOCUMENT_READ_ACTION - Always use specified action for DocumentReadAction, including Digital PDF.

documentReaderConfig_documentReadAction :: Lens' DocumentReaderConfig DocumentReadAction Source #

This enum field will start with two values which will apply to PDFs:

  • TEXTRACT_DETECT_DOCUMENT_TEXT - The service calls DetectDocumentText for PDF documents per page.
  • TEXTRACT_ANALYZE_DOCUMENT - The service calls AnalyzeDocument for PDF documents per page.