Values.GetLabelDetectionResponseSourceGets the label detection results of a Amazon Rekognition Video analysis started by StartLabelDetection. The label detection operation is started by a call to StartLabelDetection which returns a job identifier (JobId). When the label detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartlabelDetection. To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier (JobId) from the initial call to StartLabelDetection. GetLabelDetection returns an array of detected labels (Labels) sorted by the time the labels were detected. You can also sort by the label name by specifying NAME for the SortBy input parameter. If there is no NAME specified, the default sort is by timestamp. You can select how results are aggregated by using the AggregateBy input parameter. The default aggregation method is TIMESTAMPS. You can also aggregate by SEGMENTS, which aggregates all instances of labels detected in a given segment. The returned Labels array may include the following attributes: Name - The name of the detected label. Confidence - The level of confidence in the label assigned to a detected object. Parents - The ancestor labels for a detected label. GetLabelDetection returns a hierarchical taxonomy of detected labels. For example, a detected car might be assigned the label car. The label car has two parent labels: Vehicle (its parent) and Transportation (its grandparent). The response includes the all ancestors for a label, where every ancestor is a unique label. In the previous example, Car, Vehicle, and Transportation are returned as unique labels in the response. Aliases - Possible Aliases for the label. Categories - The label categories that the detected label belongs to. BoundingBox — Bounding boxes are described for all instances of detected common object labels, returned in an array of Instance objects. An Instance object contains a BoundingBox object, describing the location of the label on the input image. It also includes the confidence for the accuracy of the detected bounding box. Timestamp - Time, in milliseconds from the start of the video, that the label was detected. For aggregation by SEGMENTS, the StartTimestampMillis, EndTimestampMillis, and DurationMillis structures are what define a segment. Although the “Timestamp” structure is still returned with each label, its value is set to be the same as StartTimestampMillis. Timestamp and Bounding box information are returned for detected Instances, only if aggregation is done by TIMESTAMPS. If aggregating by SEGMENTS, information about detected instances isn’t returned. The version of the label model used for the detection is also returned. Note DominantColors isn't returned for Instances, although it is shown as part of the response in the sample seen below. Use MaxResults parameter to limit the number of labels 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 GetlabelDetection and populate the NextToken request parameter with the token value returned from the previous call to GetLabelDetection. If you are retrieving results while using the Amazon Simple Notification Service, note that you will receive an "ERROR" notification if the job encounters an issue.
type nonrec t = {jobStatus : VideoJobStatus.t option;The current status of the label detection job.
*)statusMessage : StatusMessage.t option;If the job fails, StatusMessage provides a descriptive error message.
*)videoMetadata : VideoMetadata.t option;Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.
*)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 labels.
*)labels : LabelDetections.t option;An array of labels detected in the video. Each element contains the detected label and the time, in milliseconds from the start of the video, that the label was detected.
*)labelModelVersion : String_.t option;Version number of the label detection model that was used to detect labels.
*)jobId : JobId.t option;Job identifier for the label detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartLabelDetection.
*)video : Video.t option;jobTag : JobTag.t option;A job identifier specified in the call to StartLabelDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.
*)getRequestMetadata : GetLabelDetectionRequestMetadata.t option;Information about the paramters used when getting a response. Includes information on aggregation and sorting methods.
*)}type nonrec error = [ | `AccessDeniedException of AccessDeniedException.t| `InternalServerError of InternalServerError.t| `InvalidPaginationTokenException of InvalidPaginationTokenException.t| `InvalidParameterException of InvalidParameterException.t| `ProvisionedThroughputExceededException of
ProvisionedThroughputExceededException.t| `ResourceNotFoundException of ResourceNotFoundException.t| `ThrottlingException of ThrottlingException.t| `Unknown_operation_error of string * string option ]val 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 ]val 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 ]val to_value :
t ->
[> `Structure of
(string
* [> `Enum of string
| `List of
[> `Structure of
(string
* [> `Long of Timestamp.t
| `Structure of
(string
* [> `Float of Percent.t
| `List of
[> `Structure of
(string
* [> `Float of Percent.t
| `List of
[> `Structure of
(string
* [> `Float of Percent.t
| `Integer of UInteger.t
| `String of String_.t ])
list ]
list
| `String of String_.t
| `Structure of
(string * [> `Float of Float_.t ]) list ])
list ]
list
| `String of String_.t ])
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 ]