comprehend/aws.sdk.kotlin.services.comprehend.model/DocumentReaderConfig

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.

Types

Builder

class Builder

Companion

object Companion

Properties

documentReadAction

val 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:

documentReadMode

val documentReadMode: DocumentReadMode?

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

featureTypes

val featureTypes: List<DocumentReadFeatureTypes>?

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:

Functions

copy

inline fun copy(block: DocumentReaderConfig.Builder.() -> Unit = {}): DocumentReaderConfig

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String