Class: Aws::Textract::Types::GetDocumentTextDetectionResponse

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#blocks ⇒ Array<Types::Block>

The results of the text-detection operation.

Returns:



1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
 
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1641

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

#detect_document_text_model_version ⇒ String

Returns:

  • (String) 


1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
 
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1641

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

#document_metadata ⇒ Types::DocumentMetadata

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

Returns:



1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
 
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1641

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

#job_status ⇒ String

The current status of the text detection job.

Returns:

  • (String) 


1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
 
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1641

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

#next_token ⇒ String

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) 


1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
 
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1641

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

#status_message ⇒ String

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

Returns:

  • (String) 


1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
 
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1641

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

#warnings ⇒ Array<Types::Warning>

A list of warnings that occurred during the text-detection operation for the document.

Returns:



1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
 
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1641

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