Package software.amazon.awssdk.services.comprehend.model

Interface DocumentReaderConfig.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DocumentReaderConfig.Builder,DocumentReaderConfig>, SdkBuilder<DocumentReaderConfig.Builder,DocumentReaderConfig>, SdkPojo

Enclosing class:

DocumentReaderConfig

public static interface DocumentReaderConfig.Builder
extends SdkPojo, CopyableBuilder<DocumentReaderConfig.Builder,DocumentReaderConfig>

Method Summary

Modifier and Type	Method	Description
DocumentReaderConfig.Builder	documentReadAction(String documentReadAction)	This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files.
DocumentReaderConfig.Builder	documentReadAction(DocumentReadAction documentReadAction)	This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files.
DocumentReaderConfig.Builder	documentReadMode(String documentReadMode)	Determines the text extraction actions for PDF files.
DocumentReaderConfig.Builder	documentReadMode(DocumentReadMode documentReadMode)	Determines the text extraction actions for PDF files.
DocumentReaderConfig.Builder	featureTypes(Collection<DocumentReadFeatureTypes> featureTypes)	Specifies the type of Amazon Textract features to apply.
DocumentReaderConfig.Builder	featureTypes(DocumentReadFeatureTypes... featureTypes)	Specifies the type of Amazon Textract features to apply.
DocumentReaderConfig.Builder	featureTypesWithStrings(String... featureTypes)	Specifies the type of Amazon Textract features to apply.
DocumentReaderConfig.Builder	featureTypesWithStrings(Collection<String> featureTypes)	Specifies the type of Amazon Textract features to apply.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

documentReadAction

DocumentReaderConfig.Builder documentReadAction(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DocumentReadAction, DocumentReadAction

documentReadAction

DocumentReaderConfig.Builder documentReadAction(DocumentReadAction 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DocumentReadAction, DocumentReadAction

documentReadMode

DocumentReaderConfig.Builder documentReadMode(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DocumentReadMode, DocumentReadMode

documentReadMode

DocumentReaderConfig.Builder documentReadMode(DocumentReadMode 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DocumentReadMode, DocumentReadMode

featureTypesWithStrings

DocumentReaderConfig.Builder featureTypesWithStrings(Collection<String> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

featureTypesWithStrings

DocumentReaderConfig.Builder featureTypesWithStrings(String... 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

featureTypes

DocumentReaderConfig.Builder featureTypes(Collection<DocumentReadFeatureTypes> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

featureTypes

DocumentReaderConfig.Builder featureTypes(DocumentReadFeatureTypes... 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.