Class TextDetection
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic TextDetection.Builder
builder()
final Float
The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text.final String
The word or line of text recognized by Amazon Rekognition.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Geometry
geometry()
The location of the detected text on the image.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Integer
id()
The identifier for the detected text.final Integer
parentId()
The Parent identifier for the detected text identified by the value ofID
.static Class
<? extends TextDetection.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final TextTypes
type()
The type of text that was detected.final String
The type of text that was detected.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
detectedText
The word or line of text recognized by Amazon Rekognition.
- Returns:
- The word or line of text recognized by Amazon Rekognition.
-
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 returnTextTypes.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of text that was detected.
- See Also:
-
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 returnTextTypes.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of text that was detected.
- See Also:
-
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
The Parent identifier for the detected text identified by the value of
ID
. If the type of detected text isLINE
, the value ofParentId
isNull
.- Returns:
- The Parent identifier for the detected text identified by the value of
ID
. If the type of detected text isLINE
, the value ofParentId
isNull
.
-
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<TextDetection.Builder,
TextDetection> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-