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

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

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.

Constant Summary collapse

SENSITIVE =
[]

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)


6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 6936

class TextDetection < Struct.new(
  :detected_text,
  :type,
  :id,
  :parent_id,
  :confidence,
  :geometry)
  SENSITIVE = []
  include Aws::Structure
end

#detected_textString

The word or line of text recognized by Amazon Rekognition.

Returns:

  • (String)


6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 6936

class TextDetection < Struct.new(
  :detected_text,
  :type,
  :id,
  :parent_id,
  :confidence,
  :geometry)
  SENSITIVE = []
  include Aws::Structure
end

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



6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 6936

class TextDetection < Struct.new(
  :detected_text,
  :type,
  :id,
  :parent_id,
  :confidence,
  :geometry)
  SENSITIVE = []
  include Aws::Structure
end

#idInteger

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

Returns:

  • (Integer)


6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 6936

class TextDetection < Struct.new(
  :detected_text,
  :type,
  :id,
  :parent_id,
  :confidence,
  :geometry)
  SENSITIVE = []
  include Aws::Structure
end

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


6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 6936

class TextDetection < Struct.new(
  :detected_text,
  :type,
  :id,
  :parent_id,
  :confidence,
  :geometry)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The type of text that was detected.

Returns:

  • (String)


6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 6936

class TextDetection < Struct.new(
  :detected_text,
  :type,
  :id,
  :parent_id,
  :confidence,
  :geometry)
  SENSITIVE = []
  include Aws::Structure
end