com.amazonaws.services.rekognition.model

Class DetectTextRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rekognition.model.DetectTextRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class DetectTextRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

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 TextDetection 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 +/- 90 degrees orientation of the horizontal axis.

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DetectTextRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
DetectTextFilters	getFilters() Optional parameters that let you set the criteria that the text must meet to be included in your response.
Image	getImage() The input image as base64-encoded bytes or an Amazon S3 object.
int	hashCode()
void	setFilters(DetectTextFilters filters) Optional parameters that let you set the criteria that the text must meet to be included in your response.
void	setImage(Image image) The input image as base64-encoded bytes or an Amazon S3 object.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
DetectTextRequest	withFilters(DetectTextFilters filters) Optional parameters that let you set the criteria that the text must meet to be included in your response.
DetectTextRequest	withImage(Image image) The input image as base64-encoded bytes or an Amazon S3 object.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DetectTextRequest

public DetectTextRequest()

Method Detail

getImage

public Image getImage()

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.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Returns:

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.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

setImage

public void setImage(Image 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.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Parameters:

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.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

withImage

public DetectTextRequest withImage(Image 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.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Returns:

A reference to this updated object so that method calls can be chained together.

getFilters

public DetectTextFilters getFilters()

Optional parameters that let you set the criteria that the text must meet to be included in your response.

Returns:

Optional parameters that let you set the criteria that the text must meet to be included in your response.

setFilters

public void setFilters(DetectTextFilters filters)

Optional parameters that let you set the criteria that the text must meet to be included in your response.

Parameters:

filters -

Optional parameters that let you set the criteria that the text must meet to be included in your response.

withFilters

public DetectTextRequest withFilters(DetectTextFilters filters)

Optional parameters that let you set the criteria that the text must meet to be included in your response.

Returns a reference to this object so that method calls can be chained together.

Parameters:

filters -

Optional parameters that let you set the criteria that the text must meet to be included in your response.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object