You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#blocks ⇒ Array<Types::Block>

The results of the text-detection operation.

Returns:

  • (Array<Types::Block>) —

    The results of the text-detection operation.

#detect_document_text_model_version ⇒ String

Returns:

  • (String)

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

#job_status ⇒ String

The current status of the text detection job.

Possible values:

  • IN_PROGRESS
  • SUCCEEDED
  • FAILED
  • PARTIAL_SUCCESS

Returns:

  • (String) —

    The current status of the text detection job.

#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) —

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

#status_message ⇒ String

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

Returns:

  • (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.

Returns:

  • (Array<Types::Warning>) —

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