Class: Aws::Comprehend::Types::DocumentReaderConfig

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-comprehend/types.rb

Overview

Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

By default, Amazon Comprehend performs the following actions to extract text from files, based on the input file type:

  • **Word files** - Amazon Comprehend parser extracts the text.

  • **Digital PDF files** - Amazon Comprehend parser extracts the text.

  • **Image files and scanned PDF files** - Amazon Comprehend uses the Amazon Textract ‘DetectDocumentText` API to extract the text.

‘DocumentReaderConfig` does not apply to plain text files or Word files.

For image files and PDF documents, you can override these default actions using the fields listed below. For more information, see [ Setting text extraction options] in the Comprehend Developer Guide.

[1]: docs.aws.amazon.com/comprehend/latest/dg/idp-set-textract-options.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#document_read_action ⇒ String

This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:

  • ‘TEXTRACT_DETECT_DOCUMENT_TEXT` - The Amazon Comprehend service uses the `DetectDocumentText` API operation.

  • ‘TEXTRACT_ANALYZE_DOCUMENT` - The Amazon Comprehend service uses the `AnalyzeDocument` API operation.

Returns:

  • (String) 


3426
3427
3428
3429
3430
3431
3432
 
# File 'lib/aws-sdk-comprehend/types.rb', line 3426

class DocumentReaderConfig < Struct.new(
  :document_read_action,
  :document_read_mode,
  :feature_types)
  SENSITIVE = []
  include Aws::Structure
end

#document_read_mode ⇒ String

Determines the text extraction actions for PDF files. Enter one of the following values:

  • ‘SERVICE_DEFAULT` - use the Amazon Comprehend service defaults for PDF files.

  • ‘FORCE_DOCUMENT_READ_ACTION` - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.

Returns:

  • (String) 


3426
3427
3428
3429
3430
3431
3432
 
# File 'lib/aws-sdk-comprehend/types.rb', line 3426

class DocumentReaderConfig < Struct.new(
  :document_read_action,
  :document_read_mode,
  :feature_types)
  SENSITIVE = []
  include Aws::Structure
end

#feature_types ⇒ Array<String>

Specifies the type of Amazon Textract features to apply. If you chose ‘TEXTRACT_ANALYZE_DOCUMENT` as the read action, you must specify one or both of the following values:

  • ‘TABLES` - Returns additional information about any tables that are detected in the input document.

  • ‘FORMS` - Returns additional information about any forms that are detected in the input document.

Returns:

  • (Array<String>) 


3426
3427
3428
3429
3430
3431
3432
 
# File 'lib/aws-sdk-comprehend/types.rb', line 3426

class DocumentReaderConfig < Struct.new(
  :document_read_action,
  :document_read_mode,
  :feature_types)
  SENSITIVE = []
  include Aws::Structure
end