Package software.amazon.awssdk.services.rekognition.model

Class TextDetection

java.lang.Object

software.amazon.awssdk.services.rekognition.model.TextDetection

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TextDetection.Builder,TextDetection>

@Generated("software.amazon.awssdk:codegen")
public final class TextDetection
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TextDetection.Builder,TextDetection>

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

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TextDetection.Builder

Method Summary

Modifier and Type	Method	Description
static TextDetection.Builder	builder()
Float	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.
String	detectedText()	The word or line of text recognized by Amazon Rekognition.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Geometry	geometry()	The location of the detected text on the image.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	id()	The identifier for the detected text.
Integer	parentId()	The Parent identifier for the detected text identified by the value of ID.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends TextDetection.Builder>	serializableBuilderClass()
TextDetection.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
TextTypes	type()	The type of text that was detected.
String	typeAsString()	The type of text that was detected.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

detectedText

public final String detectedText()

The word or line of text recognized by Amazon Rekognition.

Returns:

The word or line of text recognized by Amazon Rekognition.

type

public final TextTypes type()

The type of text that was detected.

If the service returns an enum value that is not available in the current SDK version, type will return TextTypes.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of text that was detected.

See Also:

TextTypes

typeAsString

public final String typeAsString()

The type of text that was detected.

If the service returns an enum value that is not available in the current SDK version, type will return TextTypes.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of text that was detected.

See Also:

TextTypes

id

public final Integer id()

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

Returns:

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

parentId

public final Integer 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.

Returns:

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.

confidence

public final Float 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.

Returns:

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

geometry

public final Geometry 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:

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.

toBuilder

public TextDetection.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TextDetection.Builder,TextDetection>

builder

public static TextDetection.Builder builder()

serializableBuilderClass

public static Class<? extends TextDetection.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo