Struct aws_sdk_comprehend::types::DocumentReaderConfig

#[non_exhaustive]
pub struct DocumentReaderConfig {
    pub document_read_action: DocumentReadAction,
    pub document_read_mode: Option<DocumentReadMode>,
    pub feature_types: Option<Vec<DocumentReadFeatureTypes>>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

document_read_action: 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.

document_read_mode: Option<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.

feature_types: Option<Vec<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:

• 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.

Implementations

impl DocumentReaderConfig

pub fn document_read_action(&self) -> &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.

pub fn document_read_mode(&self) -> Option<&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.

pub fn feature_types(&self) -> &[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:

• 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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .feature_types.is_none().

impl DocumentReaderConfig

pub fn builder() -> DocumentReaderConfigBuilder

Creates a new builder-style object to manufacture DocumentReaderConfig.

Trait Implementations

impl Clone for DocumentReaderConfig

fn clone(&self) -> DocumentReaderConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DocumentReaderConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DocumentReaderConfig

fn eq(&self, other: &DocumentReaderConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DocumentReaderConfig