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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-textract/types.rb

Overview

Note:

When making an API call, you may pass AnalyzeDocumentRequest data as a hash:

{
  document: { # required
    bytes: "data",
    s3_object: {
      bucket: "S3Bucket",
      name: "S3ObjectName",
      version: "S3ObjectVersion",
    },
  },
  feature_types: ["TABLES"], # required, accepts TABLES, FORMS, QUERIES
  human_loop_config: {
    human_loop_name: "HumanLoopName", # required
    flow_definition_arn: "FlowDefinitionArn", # required
    data_attributes: {
      content_classifiers: ["FreeOfPersonallyIdentifiableInformation"], # accepts FreeOfPersonallyIdentifiableInformation, FreeOfAdultContent
    },
  },
  queries_config: {
    queries: [ # required
      {
        text: "QueryInput", # required
        alias: "QueryInput",
        pages: ["QueryPage"],
      },
    ],
  },
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#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:



84
85
86
87
88
89
90
91
 
# File 'lib/aws-sdk-textract/types.rb', line 84

class AnalyzeDocumentRequest < Struct.new(
  :document,
  :feature_types,
  :human_loop_config,
  :queries_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. To perform both types of analysis, add TABLES and FORMS to ‘FeatureTypes`. 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>) 


84
85
86
87
88
89
90
91
 
# File 'lib/aws-sdk-textract/types.rb', line 84

class AnalyzeDocumentRequest < Struct.new(
  :document,
  :feature_types,
  :human_loop_config,
  :queries_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:



84
85
86
87
88
89
90
91
 
# File 'lib/aws-sdk-textract/types.rb', line 84

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

#queries_config ⇒ Types::QueriesConfig

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

Returns:



84
85
86
87
88
89
90
91
 
# File 'lib/aws-sdk-textract/types.rb', line 84

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