/AWS1/CL_REK=>GETTEXTDETECTION()
¶
About GetTextDetection¶
Gets the text detection results of a Amazon Rekognition Video analysis started by StartTextDetection.
Text detection with Amazon Rekognition Video is an asynchronous operation. You start text detection by
calling StartTextDetection which returns a job identifier (JobId
)
When the text detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service
topic registered in the initial call to StartTextDetection
. To get the results
of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
.
if so, call GetTextDetection
and pass the job identifier (JobId
) from the initial call
of StartLabelDetection
.
GetTextDetection
returns an array of detected text (TextDetections
) sorted by
the time the text was detected, up to 100 words per frame of video.
Each element of the array includes the detected text, the precentage confidence in the acuracy of the detected text, the time the text was detected, bounding box information for where the text was located, and unique identifiers for words and their lines.
Use MaxResults parameter to limit the number of text detections returned. If there are more results than
specified in MaxResults
, the value of NextToken
in the operation response contains
a pagination token for getting the next set of results. To get the next page of results, call GetTextDetection
and populate the NextToken
request parameter with the token value returned from the previous
call to GetTextDetection
.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_JOBID
TYPE /AWS1/REKJOBID
/AWS1/REKJOBID
¶
Job identifier for the text detection operation for which you want results returned. You get the job identifer from an initial call to
StartTextDetection
.
Optional arguments:¶
IV_MAXRESULTS
TYPE /AWS1/REKMAXRESULTS
/AWS1/REKMAXRESULTS
¶
Maximum number of results to return per paginated call. The largest value you can specify is 1000.
IV_NEXTTOKEN
TYPE /AWS1/REKPAGINATIONTOKEN
/AWS1/REKPAGINATIONTOKEN
¶
If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.