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

Class: Aws::Rekognition::Types::TextDetection

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

Overview

Information about a word or line of text detected by DetectText.

The DetectedText field contains the text that Amazon Rekognition detected in the image.

Every word and line has an identifier (Id). Each word belongs to a line and has a parent identifier (ParentId) that identifies the line of text in which the word appears. The word Id is also an index for the word within a line of words.

For more information, see Detecting Text in the Amazon Rekognition Developer Guide.

Instance Attribute Summary collapse

Instance Attribute Details

#confidenceFloat

The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text.

Returns:

  • (Float)

    The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text.

#detected_textString

The word or line of text recognized by Amazon Rekognition.

Returns:

  • (String)

    The word or line of text recognized by Amazon Rekognition.

#geometryTypes::Geometry

The location of the detected text on the image. Includes an axis aligned coarse bounding box surrounding the text and a finer grain polygon for more accurate spatial information.

Returns:

#idInteger

The identifier for the detected text. The identifier is only unique for a single call to DetectText.

Returns:

  • (Integer)

    The identifier for the detected text.

#parent_idInteger

The Parent identifier for the detected text identified by the value of ID. If the type of detected text is LINE, the value of ParentId is Null.

Returns:

  • (Integer)

    The Parent identifier for the detected text identified by the value of ID.

#typeString

The type of text that was detected.

Possible values:

  • LINE
  • WORD

Returns:

  • (String)

    The type of text that was detected.