Show / Hide Table of Contents

Interface CfnDocumentClassifierPropsMixin.IDocumentReaderConfigProperty

Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

Namespace: Amazon.CDK.Mixins.Preview.AWS.Comprehend.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public interface CfnDocumentClassifierPropsMixin.IDocumentReaderConfigProperty
Syntax (vb)
Public Interface CfnDocumentClassifierPropsMixin.IDocumentReaderConfigProperty
Remarks

By default, Amazon Comprehend performs the following actions to extract text from files, based on the input file type:

    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.

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

    ExampleMetadata: fixture=_generated

    Examples
    // The code below shows an example of how to instantiate this type.
                 // The values are placeholders you should change.
                 using Amazon.CDK.Mixins.Preview.AWS.Comprehend.Mixins;
    
                 var documentReaderConfigProperty = new DocumentReaderConfigProperty {
                     DocumentReadAction = "documentReadAction",
                     DocumentReadMode = "documentReadMode",
                     FeatureTypes = new [] { "featureTypes" }
                 };

    Synopsis

    Properties

    DocumentReadAction

    This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files.

    DocumentReadMode

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

    FeatureTypes

    Specifies the type of Amazon Textract features to apply.

    Properties

    DocumentReadAction

    This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files.

    string? DocumentReadAction { get; }
    Property Value

    string

    Remarks

    Enter one of the following values:

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

      DocumentReadMode

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

      string? DocumentReadMode { get; }
      Property Value

      string

      Remarks

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

        FeatureTypes

        Specifies the type of Amazon Textract features to apply.

        string[]? FeatureTypes { get; }
        Property Value

        string[]

        Remarks

        If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

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

          Back to top Generated by DocFX