Class: Aws::Textract::Types::AnalyzeDocumentRequest

Inherits:

Struct

• Object
• Struct
• Aws::Textract::Types::AnalyzeDocumentRequest

Includes:

Structure

Defined in:

lib/aws-sdk-textract/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #adapters_config ⇒ Types::AdaptersConfig

  Specifies the adapter to be used when analyzing a document.

• #document ⇒ Types::Document

  The input document as base64-encoded bytes or an Amazon S3 object.

• #feature_types ⇒ Array<String>

  A list of the types of analysis to perform.

• #human_loop_config ⇒ Types::HumanLoopConfig

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

• #queries_config ⇒ Types::QueriesConfig

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

Instance Attribute Details

#adapters_config ⇒ Types::AdaptersConfig

Specifies the adapter to be used when analyzing a document.

Returns:

• (Types::AdaptersConfig)

# File 'lib/aws-sdk-textract/types.rb', line 234

class AnalyzeDocumentRequest < Struct.new(
  :document,
  :feature_types,
  :human_loop_config,
  :queries_config,
  :adapters_config)
  SENSITIVE = []
  include Aws::Structure
end

#document ⇒ Types::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.

Returns:

• (Types::Document)

# File 'lib/aws-sdk-textract/types.rb', line 234

class AnalyzeDocumentRequest < Struct.new(
  :document,
  :feature_types,
  :human_loop_config,
  :queries_config,
  :adapters_config)
  SENSITIVE = []
  include Aws::Structure
end

#feature_types ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'lib/aws-sdk-textract/types.rb', line 234

class AnalyzeDocumentRequest < Struct.new(
  :document,
  :feature_types,
  :human_loop_config,
  :queries_config,
  :adapters_config)
  SENSITIVE = []
  include Aws::Structure
end

#human_loop_config ⇒ Types::HumanLoopConfig

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

Returns:

• (Types::HumanLoopConfig)

# File 'lib/aws-sdk-textract/types.rb', line 234

class AnalyzeDocumentRequest < Struct.new(
  :document,
  :feature_types,
  :human_loop_config,
  :queries_config,
  :adapters_config)
  SENSITIVE = []
  include Aws::Structure
end

#queries_config ⇒ Types::QueriesConfig

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

Returns:

• (Types::QueriesConfig)

# File 'lib/aws-sdk-textract/types.rb', line 234

class AnalyzeDocumentRequest < Struct.new(
  :document,
  :feature_types,
  :human_loop_config,
  :queries_config,
  :adapters_config)
  SENSITIVE = []
  include Aws::Structure
end