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 |
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' .
Creating a Request
:: Image | |
-> 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 Source #
See: detectText
smart constructor.
Request Lenses
dtImage :: Lens' DetectText Image Source #
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
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 Source #
See: detectTextResponse
smart constructor.
Response Lenses
dtrsTextDetections :: Lens' DetectTextResponse [TextDetection] Source #
An array of text that was detected in the input image.
dtrsResponseStatus :: Lens' DetectTextResponse Int Source #
- - | The response status code.