AWS::Comprehend::DocumentClassifier DocumentReaderConfig - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Comprehend::DocumentClassifier DocumentReaderConfig

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.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "DocumentReadAction" : String,
  "DocumentReadMode" : String,
  "FeatureTypes" : [ String, ... ]
}

YAML

  DocumentReadAction: String
  DocumentReadMode: String
  FeatureTypes: 
    - String

Properties

DocumentReadAction

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.

Required: Yes

Type: String

Allowed values: TEXTRACT_DETECT_DOCUMENT_TEXT | TEXTRACT_ANALYZE_DOCUMENT

Update requires: Replacement

DocumentReadMode

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.

Required: No

Type: String

Allowed values: SERVICE_DEFAULT | FORCE_DOCUMENT_READ_ACTION

Update requires: Replacement

FeatureTypes

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.

Required: No

Type: Array of String

Allowed values: TABLES | FORMS

Minimum: 1

Maximum: 2

Update requires: Replacement