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

Inherits:

Struct

• Object
• Struct
• Aws::Textract::Types::GetDocumentTextDetectionResponse

Includes:

Structure

Defined in:

lib/aws-sdk-textract/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #blocks ⇒ Array<Types::Block>

  The results of the text-detection operation.

• #detect_document_text_model_version ⇒ String
• #document_metadata ⇒ Types::DocumentMetadata

  Information about a document that Amazon Textract processed.

• #job_status ⇒ String

  The current status of the text detection job.

• #next_token ⇒ String

  If the response is truncated, Amazon Textract returns this token.

• #status_message ⇒ String

  Returns if the detection job could not be completed.

• #warnings ⇒ Array<Types::Warning>

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

Instance Attribute Details

#blocks ⇒ Array<Types::Block>

The results of the text-detection operation.

Returns:

• (Array<Types::Block>)

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

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)

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

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:

• (Types::DocumentMetadata)

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

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)

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

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)

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

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)

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

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:

• (Array<Types::Warning>)

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

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