Module Values.GetTextDetectionResponseSource

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.

Sourcetype nonrec t = {
  1. jobStatus : VideoJobStatus.t option;
    (*

    Current status of the text detection job.

    *)
  2. statusMessage : StatusMessage.t option;
    (*

    If the job fails, StatusMessage provides a descriptive error message.

    *)
  3. videoMetadata : VideoMetadata.t option;
  4. textDetections : TextDetectionResults.t option;
    (*

    An array of text detected in the video. Each element contains the detected text, the time in milliseconds from the start of the video that the text was detected, and where it was detected on the screen.

    *)
  5. nextToken : PaginationToken.t option;
    (*

    If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of text.

    *)
  6. textModelVersion : String_.t option;
    (*

    Version number of the text detection model that was used to detect text.

    *)
  7. jobId : JobId.t option;
    (*

    Job identifier for the text detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartTextDetection.

    *)
  8. video : Video.t option;
  9. jobTag : JobTag.t option;
    (*

    A job identifier specified in the call to StartTextDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of AccessDeniedException.t
  2. | `InternalServerError of InternalServerError.t
  3. | `InvalidPaginationTokenException of InvalidPaginationTokenException.t
  4. | `InvalidParameterException of InvalidParameterException.t
  5. | `ProvisionedThroughputExceededException of ProvisionedThroughputExceededException.t
  6. | `ResourceNotFoundException of ResourceNotFoundException.t
  7. | `ThrottlingException of ThrottlingException.t
  8. | `Unknown_operation_error of string * string option
]
Sourceval make : ?jobStatus:??? -> ?statusMessage:??? -> ?videoMetadata:??? -> ?textDetections:??? -> ?nextToken:??? -> ?textModelVersion:??? -> ?jobId:??? -> ?video:??? -> ?jobTag:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of unit | `InternalServerError of unit | `InvalidPaginationTokenException of unit | `InvalidParameterException of unit | `ProvisionedThroughputExceededException of unit | `ResourceNotFoundException of unit | `ThrottlingException of unit | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `AccessDeniedException of unit | `InternalServerError of unit | `InvalidPaginationTokenException of unit | `InvalidParameterException of unit | `ProvisionedThroughputExceededException of unit | `ResourceNotFoundException of unit | `ThrottlingException of unit | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Long of Timestamp.t | `Structure of (string * [> `Enum of string | `Float of Percent.t | `Integer of UInteger.t | `String of String_.t | `Structure of (string * [> `List of [> `Structure of (string * [> `Float of Float_.t ]) list ] list | `Structure of (string * [> `Float of Float_.t ]) list ]) list ]) list ]) list ] list | `String of StatusMessage.t | `Structure of (string * [> `Enum of string | `Float of Float_.t | `Long of ULong.t | `String of String_.t | `Structure of (string * [> `String of S3Bucket.t ]) list ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t