Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Rekognition.Types.TextDetection

Description

Synopsis

Documentation

data TextDetection Source #

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.

See: newTextDetection smart constructor.

Constructors

TextDetection'

Fields

confidence :: Maybe Double
The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text.
detectedText :: Maybe Text
The word or line of text recognized by Amazon Rekognition.
geometry :: Maybe 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.
id :: Maybe Natural
The identifier for the detected text. The identifier is only unique for a single call to DetectText.
parentId :: Maybe Natural
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.
type' :: Maybe TextTypes
The type of text that was detected.

Instances

Instances details

FromJSON TextDetection Source #
Instance details Defined in Amazonka.Rekognition.Types.TextDetection Methods parseJSON :: Value -> Parser TextDetection # parseJSONList :: Value -> Parser [TextDetection] #
Generic TextDetection Source #
Instance details Defined in Amazonka.Rekognition.Types.TextDetection Associated Types type Rep TextDetection :: Type -> Type # Methods from :: TextDetection -> Rep TextDetection x # to :: Rep TextDetection x -> TextDetection #
Read TextDetection Source #
Instance details Defined in Amazonka.Rekognition.Types.TextDetection Methods readsPrec :: Int -> ReadS TextDetection # readList :: ReadS [TextDetection] # readPrec :: ReadPrec TextDetection # readListPrec :: ReadPrec [TextDetection] #
Show TextDetection Source #
Instance details Defined in Amazonka.Rekognition.Types.TextDetection Methods showsPrec :: Int -> TextDetection -> ShowS # show :: TextDetection -> String # showList :: [TextDetection] -> ShowS #
NFData TextDetection Source #
Instance details Defined in Amazonka.Rekognition.Types.TextDetection Methods rnf :: TextDetection -> () #
Eq TextDetection Source #
Instance details Defined in Amazonka.Rekognition.Types.TextDetection Methods (==) :: TextDetection -> TextDetection -> Bool # (/=) :: TextDetection -> TextDetection -> Bool #
Hashable TextDetection Source #
Instance details Defined in Amazonka.Rekognition.Types.TextDetection Methods hashWithSalt :: Int -> TextDetection -> Int # hash :: TextDetection -> Int #
type Rep TextDetection Source #
Instance details Defined in Amazonka.Rekognition.Types.TextDetection type Rep TextDetection = D1 ('MetaData "TextDetection" "Amazonka.Rekognition.Types.TextDetection" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "TextDetection'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "confidence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :: (S1 ('MetaSel ('Just "detectedText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "geometry") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Geometry)))) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "parentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TextTypes))))))

newTextDetection :: TextDetection Source #

Create a value of TextDetection with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:confidence:TextDetection', textDetection_confidence - The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text.

$sel:detectedText:TextDetection', textDetection_detectedText - The word or line of text recognized by Amazon Rekognition.

$sel:geometry:TextDetection', textDetection_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.

$sel:id:TextDetection', textDetection_id - The identifier for the detected text. The identifier is only unique for a single call to DetectText.

$sel:parentId:TextDetection', textDetection_parentId - 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.

$sel:type':TextDetection', textDetection_type - The type of text that was detected.

textDetection_confidence :: Lens' TextDetection (Maybe Double) Source #

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

textDetection_detectedText :: Lens' TextDetection (Maybe Text) Source #

The word or line of text recognized by Amazon Rekognition.

textDetection_geometry :: Lens' TextDetection (Maybe Geometry) Source #

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.

textDetection_id :: Lens' TextDetection (Maybe Natural) Source #

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

textDetection_parentId :: Lens' TextDetection (Maybe Natural) Source #

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.

textDetection_type :: Lens' TextDetection (Maybe TextTypes) Source #

The type of text that was detected.