AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::Textract::Types::GetDocumentAnalysisResponse

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#analyze_document_model_versionString

Returns:

  • (String)


848
849
850
851
852
853
854
855
856
857
858
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 848

class GetDocumentAnalysisResponse < Struct.new(
  :document_metadata,
  :job_status,
  :next_token,
  :blocks,
  :warnings,
  :status_message,
  :analyze_document_model_version)
  SENSITIVE = []
  include Aws::Structure
end

#blocksArray<Types::Block>

The results of the text-analysis operation.

Returns:



848
849
850
851
852
853
854
855
856
857
858
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 848

class GetDocumentAnalysisResponse < Struct.new(
  :document_metadata,
  :job_status,
  :next_token,
  :blocks,
  :warnings,
  :status_message,
  :analyze_document_model_version)
  SENSITIVE = []
  include Aws::Structure
end

#document_metadataTypes::DocumentMetadata

Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.



848
849
850
851
852
853
854
855
856
857
858
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 848

class GetDocumentAnalysisResponse < Struct.new(
  :document_metadata,
  :job_status,
  :next_token,
  :blocks,
  :warnings,
  :status_message,
  :analyze_document_model_version)
  SENSITIVE = []
  include Aws::Structure
end

#job_statusString

The current status of the text detection job.

Returns:

  • (String)


848
849
850
851
852
853
854
855
856
857
858
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 848

class GetDocumentAnalysisResponse < Struct.new(
  :document_metadata,
  :job_status,
  :next_token,
  :blocks,
  :warnings,
  :status_message,
  :analyze_document_model_version)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text detection results.

Returns:

  • (String)


848
849
850
851
852
853
854
855
856
857
858
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 848

class GetDocumentAnalysisResponse < Struct.new(
  :document_metadata,
  :job_status,
  :next_token,
  :blocks,
  :warnings,
  :status_message,
  :analyze_document_model_version)
  SENSITIVE = []
  include Aws::Structure
end

#status_messageString

Returns if the detection job could not be completed. Contains explanation for what error occured.

Returns:

  • (String)


848
849
850
851
852
853
854
855
856
857
858
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 848

class GetDocumentAnalysisResponse < Struct.new(
  :document_metadata,
  :job_status,
  :next_token,
  :blocks,
  :warnings,
  :status_message,
  :analyze_document_model_version)
  SENSITIVE = []
  include Aws::Structure
end

#warningsArray<Types::Warning>

A list of warnings that occurred during the document-analysis operation.

Returns:



848
849
850
851
852
853
854
855
856
857
858
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 848

class GetDocumentAnalysisResponse < Struct.new(
  :document_metadata,
  :job_status,
  :next_token,
  :blocks,
  :warnings,
  :status_message,
  :analyze_document_model_version)
  SENSITIVE = []
  include Aws::Structure
end