Struct aws_sdk_textract::operation::analyze_document::AnalyzeDocumentInput

#[non_exhaustive]
pub struct AnalyzeDocumentInput {
    pub document: Option<Document>,
    pub feature_types: Option<Vec<FeatureType>>,
    pub human_loop_config: Option<HumanLoopConfig>,
    pub queries_config: Option<QueriesConfig>,
    pub adapters_config: Option<AdaptersConfig>,
}

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: Option<Document>

The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG, PNG, PDF, or TIFF format.

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.

feature_types: Option<Vec<FeatureType>>

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

human_loop_config: Option<HumanLoopConfig>

Sets the configuration for the human in the loop workflow for analyzing documents.

queries_config: Option<QueriesConfig>

Contains Queries and the alias for those Queries, as determined by the input.

adapters_config: Option<AdaptersConfig>

Specifies the adapter to be used when analyzing a document.

Implementations

impl AnalyzeDocumentInput

pub fn document(&self) -> Option<&Document>

The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG, PNG, PDF, or TIFF format.

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.

pub fn feature_types(&self) -> &[FeatureType]

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

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().

pub fn human_loop_config(&self) -> Option<&HumanLoopConfig>

Sets the configuration for the human in the loop workflow for analyzing documents.

pub fn queries_config(&self) -> Option<&QueriesConfig>

Contains Queries and the alias for those Queries, as determined by the input.

pub fn adapters_config(&self) -> Option<&AdaptersConfig>

Specifies the adapter to be used when analyzing a document.

impl AnalyzeDocumentInput

pub fn builder() -> AnalyzeDocumentInputBuilder

Creates a new builder-style object to manufacture AnalyzeDocumentInput.

Trait Implementations

impl Clone for AnalyzeDocumentInput

fn clone(&self) -> AnalyzeDocumentInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AnalyzeDocumentInput

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

Formats the value using the given formatter.

impl PartialEq for AnalyzeDocumentInput

fn eq(&self, other: &AnalyzeDocumentInput) -> 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 AnalyzeDocumentInput