Class CfnDocumentClassifier.DocumentReaderConfigProperty
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
Inheritance
Namespace: Amazon.CDK.AWS.Comprehend
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class DocumentReaderConfigProperty : Object, CfnDocumentClassifier.IDocumentReaderConfigProperty
Syntax (vb)
Public Class DocumentReaderConfigProperty
Inherits Object
Implements CfnDocumentClassifier.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.
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.AWS.Comprehend;
var documentReaderConfigProperty = new DocumentReaderConfigProperty {
DocumentReadAction = "documentReadAction",
// the properties below are optional
DocumentReadMode = "documentReadMode",
FeatureTypes = new [] { "featureTypes" }
};
Synopsis
Constructors
DocumentReaderConfigProperty() |
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. |
Constructors
DocumentReaderConfigProperty()
public DocumentReaderConfigProperty()
Properties
DocumentReadAction
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files.
public string DocumentReadAction { get; set; }
Property Value
System.String
Remarks
DocumentReadMode
Determines the text extraction actions for PDF files. Enter one of the following values:.
public string DocumentReadMode { get; set; }
Property Value
System.String
Remarks
FeatureTypes
Specifies the type of Amazon Textract features to apply.
public string[] FeatureTypes { get; set; }
Property Value
System.String[]
Remarks
If you chose TEXTRACT_ANALYZE_DOCUMENT
as the read action, you must specify one or both of the following values: