Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.Rekognition.DetectText

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Detects text in the input image and converts it into machine-readable text.

Pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not supported. The image must be either a .png or .jpeg formatted file.

The DetectText operation returns text in an array of elements, TextDetections . Each TextDetection element provides information about a single word or line of text that was detected in the image.

A word is one or more ISO basic latin script characters that are not separated by spaces. DetectText can detect up to 50 words in an image.

A line is a string of equally spaced words. A line isn't necessarily a complete sentence. For example, a driver's license number is detected as a line. A line ends when there is no aligned text after it. Also, a line ends when there is a large gap between words, relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition may detect multiple lines in text aligned in the same direction. Periods don't represent the end of a line. If a sentence spans multiple lines, the DetectText operation returns multiple lines.

To determine whether a TextDetection element is a line of text or a word, use the TextDetection object Type field.

To be detected, text must be within +/- 30 degrees orientation of the horizontal axis.

For more information, see 'text-detection' .

Synopsis

Creating a Request

detectText #

Arguments

:: Image	`dtImage`
-> DetectText

Creates a value of DetectText with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dtImage - The input image as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Rekognition operations, you can't pass image bytes.

data DetectText #

See: detectText smart constructor.

Instances

Eq DetectText #
Instance details Defined in Network.AWS.Rekognition.DetectText Methods (==) :: DetectText -> DetectText -> Bool # (/=) :: DetectText -> DetectText -> Bool #
Data DetectText #
Instance details Defined in Network.AWS.Rekognition.DetectText Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DetectText -> c DetectText # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DetectText # toConstr :: DetectText -> Constr # dataTypeOf :: DetectText -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DetectText) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DetectText) # gmapT :: (forall b. Data b => b -> b) -> DetectText -> DetectText # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DetectText -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DetectText -> r # gmapQ :: (forall d. Data d => d -> u) -> DetectText -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DetectText -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DetectText -> m DetectText # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DetectText -> m DetectText # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DetectText -> m DetectText #
Read DetectText #
Instance details Defined in Network.AWS.Rekognition.DetectText Methods readsPrec :: Int -> ReadS DetectText # readList :: ReadS [DetectText] # readPrec :: ReadPrec DetectText # readListPrec :: ReadPrec [DetectText] #
Show DetectText #
Instance details Defined in Network.AWS.Rekognition.DetectText Methods showsPrec :: Int -> DetectText -> ShowS # show :: DetectText -> String # showList :: [DetectText] -> ShowS #
Generic DetectText #
Instance details Defined in Network.AWS.Rekognition.DetectText Associated Types type Rep DetectText :: Type -> Type # Methods from :: DetectText -> Rep DetectText x # to :: Rep DetectText x -> DetectText #
Hashable DetectText #
Instance details Defined in Network.AWS.Rekognition.DetectText Methods hashWithSalt :: Int -> DetectText -> Int # hash :: DetectText -> Int #
ToJSON DetectText #
Instance details Defined in Network.AWS.Rekognition.DetectText Methods toJSON :: DetectText -> Value # toEncoding :: DetectText -> Encoding # toJSONList :: [DetectText] -> Value # toEncodingList :: [DetectText] -> Encoding #
AWSRequest DetectText #
Instance details Defined in Network.AWS.Rekognition.DetectText Associated Types type Rs DetectText :: Type # Methods request :: DetectText -> Request DetectText # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DetectText -> ClientResponse -> m (Response DetectText) #
ToHeaders DetectText #
Instance details Defined in Network.AWS.Rekognition.DetectText Methods toHeaders :: DetectText -> [Header] #
ToPath DetectText #
Instance details Defined in Network.AWS.Rekognition.DetectText Methods toPath :: DetectText -> ByteString #
ToQuery DetectText #
Instance details Defined in Network.AWS.Rekognition.DetectText Methods toQuery :: DetectText -> QueryString #
NFData DetectText #
Instance details Defined in Network.AWS.Rekognition.DetectText Methods rnf :: DetectText -> () #
type Rep DetectText #
Instance details Defined in Network.AWS.Rekognition.DetectText type Rep DetectText = D1 (MetaData "DetectText" "Network.AWS.Rekognition.DetectText" "amazonka-rekognition-1.6.1-LJYoSuoGbtd78kiYOWkJFK" True) (C1 (MetaCons "DetectText'" PrefixI True) (S1 (MetaSel (Just "_dtImage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Image)))
type Rs DetectText #
Instance details Defined in Network.AWS.Rekognition.DetectText type Rs DetectText = DetectTextResponse

Request Lenses

dtImage :: Lens' DetectText Image #

The input image as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Rekognition operations, you can't pass image bytes.

Destructuring the Response

detectTextResponse #

Arguments

:: Int	`dtrsResponseStatus`
-> DetectTextResponse

Creates a value of DetectTextResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dtrsTextDetections - An array of text that was detected in the input image.
dtrsResponseStatus - -- | The response status code.

data DetectTextResponse #

See: detectTextResponse smart constructor.

Instances

Eq DetectTextResponse #
Instance details Defined in Network.AWS.Rekognition.DetectText Methods (==) :: DetectTextResponse -> DetectTextResponse -> Bool # (/=) :: DetectTextResponse -> DetectTextResponse -> Bool #
Data DetectTextResponse #
Instance details Defined in Network.AWS.Rekognition.DetectText Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DetectTextResponse -> c DetectTextResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DetectTextResponse # toConstr :: DetectTextResponse -> Constr # dataTypeOf :: DetectTextResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DetectTextResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DetectTextResponse) # gmapT :: (forall b. Data b => b -> b) -> DetectTextResponse -> DetectTextResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DetectTextResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DetectTextResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> DetectTextResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DetectTextResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DetectTextResponse -> m DetectTextResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DetectTextResponse -> m DetectTextResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DetectTextResponse -> m DetectTextResponse #
Read DetectTextResponse #
Instance details Defined in Network.AWS.Rekognition.DetectText Methods readsPrec :: Int -> ReadS DetectTextResponse # readList :: ReadS [DetectTextResponse] # readPrec :: ReadPrec DetectTextResponse # readListPrec :: ReadPrec [DetectTextResponse] #
Show DetectTextResponse #
Instance details Defined in Network.AWS.Rekognition.DetectText Methods showsPrec :: Int -> DetectTextResponse -> ShowS # show :: DetectTextResponse -> String # showList :: [DetectTextResponse] -> ShowS #
Generic DetectTextResponse #
Instance details Defined in Network.AWS.Rekognition.DetectText Associated Types type Rep DetectTextResponse :: Type -> Type # Methods from :: DetectTextResponse -> Rep DetectTextResponse x # to :: Rep DetectTextResponse x -> DetectTextResponse #
NFData DetectTextResponse #
Instance details Defined in Network.AWS.Rekognition.DetectText Methods rnf :: DetectTextResponse -> () #
type Rep DetectTextResponse #
Instance details Defined in Network.AWS.Rekognition.DetectText type Rep DetectTextResponse = D1 (MetaData "DetectTextResponse" "Network.AWS.Rekognition.DetectText" "amazonka-rekognition-1.6.1-LJYoSuoGbtd78kiYOWkJFK" False) (C1 (MetaCons "DetectTextResponse'" PrefixI True) (S1 (MetaSel (Just "_dtrsTextDetections") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [TextDetection])) :*: S1 (MetaSel (Just "_dtrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

dtrsTextDetections :: Lens' DetectTextResponse [TextDetection] #

An array of text that was detected in the input image.

dtrsResponseStatus :: Lens' DetectTextResponse Int #

- | The response status code.