Package software.amazon.awscdk.services.comprehend

Interface CfnDocumentClassifier.DocumentReaderConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDocumentClassifier.DocumentReaderConfigProperty.Jsii$Proxy

Enclosing class:

CfnDocumentClassifier

@Stability(Stable)
public static interface CfnDocumentClassifier.DocumentReaderConfigProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.comprehend.*;
 DocumentReaderConfigProperty documentReaderConfigProperty = DocumentReaderConfigProperty.builder()
         .documentReadAction("documentReadAction")
         // the properties below are optional
         .documentReadMode("documentReadMode")
         .featureTypes(List.of("featureTypes"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentreaderconfig.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDocumentClassifier.DocumentReaderConfigProperty.Builder	A builder for CfnDocumentClassifier.DocumentReaderConfigProperty
static final class	CfnDocumentClassifier.DocumentReaderConfigProperty.Jsii$Proxy	An implementation for CfnDocumentClassifier.DocumentReaderConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnDocumentClassifier.DocumentReaderConfigProperty.Builder	builder()
String	getDocumentReadAction()	This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files.
default String	getDocumentReadMode()	Determines the text extraction actions for PDF files.
default List<String>	getFeatureTypes()	Specifies the type of Amazon Textract features to apply.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDocumentReadAction

@Stability(Stable)
@NotNull
String getDocumentReadAction()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentreaderconfig.html#cfn-comprehend-documentclassifier-documentreaderconfig-documentreadaction

getDocumentReadMode

@Stability(Stable)
@Nullable
default String getDocumentReadMode()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentreaderconfig.html#cfn-comprehend-documentclassifier-documentreaderconfig-documentreadmode

getFeatureTypes

@Stability(Stable)
@Nullable
default List<String> getFeatureTypes()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentreaderconfig.html#cfn-comprehend-documentclassifier-documentreaderconfig-featuretypes

builder

@Stability(Stable)
static CfnDocumentClassifier.DocumentReaderConfigProperty.Builder builder()

Returns:

a CfnDocumentClassifier.DocumentReaderConfigProperty.Builder of CfnDocumentClassifier.DocumentReaderConfigProperty