Feature Description
This API is used to submit a video tagging job.
Request
Sample request
POST /jobs HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Content-Length: <length>
Content-Type: application/xml
<body>
Request body
This request requires the following request body:
<Request>
<Tag>VideoTag</Tag>
<Input>
<Object>input/demo.mp4</Object>
</Input>
<Operation>
<VideoTag>
<Scenario>Stream</Scenario>
</VideoTag>
<UserData>This is my data.</UserData>
<JobLevel>0</JobLevel>
</Operation>
<QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
<CallBack>http://callback.demo.com</CallBack>
<CallBackFormat>JSON<CallBackFormat>
</Request>
The nodes are described as follows:
Request has the following sub-nodes:
|
| | | | |
| | Information of the media file to be processed | | |
| | | | |
| | | | |
| | Job callback format, which can be JSON or XML (default value). It has a higher priority than that of the queue. | | |
| | Job callback type, which can be Url (default value) or TDMQ. It has a higher priority than that of the queue. | | |
| | Job callback address, which has a higher priority than that of the queue. If it is set to no, no callbacks will be generated at the callback address of the queue. | | |
| | TDMQ configuration for job callback as described in Structure, which is required if CallBackType is TDMQ. | | |
Input has the following sub-nodes:
|
| | Name of the media file on which to perform the video tagging job. Currently, .mp4, .avi, .mkv, .wmv, .rmvb, .flv, and .mov formats are supported. For videos longer than 30 minutes, submit a ticket for assistance. | | |
Operation
has the following sub-nodes: |
| | | | |
| | Job priority. The greater the value, the higher the priority. Valid values: 0, 1, 2. Default value: 0. | | |
| Response.JobsDetail.Operation | The user information passed through. | | |
VideoTag has the following sub-nodes:
|
| Request.Operation.VideoTag | Scenario type. You can select the application scenario of the video tag. The used algorithm, input, and output vary by scenario. | | | The current version is only adapted to the Stream scenario |
Response
Response body
The response body returns application/xml data. The following contains all the nodes:
<Response>
<JobsDetail>
<Code>Success</Code>
<Message/>
<JobId>j8d121820f5e411ec926ef19d53ba9c6f</JobId>
<State>Submitted</State>
<CreationTime>2022-06-27T15:23:10+0800</CreationTime>
<StartTime>-</StartTime>
<EndTime>-</EndTime>
<QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
<Tag>VideoTag</Tag>
<Input>
<BucketId>test-123456789</BucketId>
<Object>input/demo.mp4</Object>
<Region>ap-chongqing</Region>
</Input>
<Operation>
<VideoTag>
<Scenario>Stream</Scenario>
</VideoTag>
<UserData>This is my data.</UserData>
<JobLevel>0</JobLevel>
</Operation>
</JobsDetail>
</Response>
The nodes are as described below:
Response has the following sub-nodes:
JobsDetail
has the following sub-nodes: |
| | Error code, which is returned only if State is Failed | |
| | Error message, which is returned only if State is Failed | |
| | | |
| | | |
| | Job status. Valid values: Submitted, Running, Success, Failed, Pause, Cancel. | |
| | | |
| | | |
| | | |
| | ID of the queue which the job is in | |
| | Input resource address of the job | |
| | | |
Input has the following sub-nodes:
|
| Response.JobsDetail.Input | | |
| Response.JobsDetail.Input | | |
| Response.JobsDetail.Input | | |
Operation has the following sub-nodes:
|
| Response.JobsDetail.Operation | Same as Request.Operation.VideoTag in the request. | |
| Response.JobsDetail.Operation | Video tag analysis result, which will not be returned when the job is not completed. | |
| Response.JobsDetail.Operation | The user information passed through. | |
| Response.JobsDetail.Operation | | |
VideoTagResult has the following sub-nodes:
|
| Response.JobsDetail.Operation.VideoTagResult | Result of the video tagging job in the Stream scenario | |
StreamData has the following sub-nodes:
|
| Response.JobsDetail.Operation.VideoTagResult.StreamData | Result list of the video tagging job in the Stream scenario | |
| Response.JobsDetail.Operation.VideoTagResult.StreamData | Algorithm status code. 0: Success. Other values: Exception. | |
| Response.JobsDetail.Operation.VideoTagResult.StreamData | Algorithm error message. ok indicates a success. If the request fails, the corresponding error is returned. | |
Data has the following sub-nodes:
|
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data | Video tag and video category information | |
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data | | |
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data | | |
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data | | |
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data | | |
Tags (video tag) has the following sub-nodes:
|
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.Tags | | |
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.Tags | | |
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.Tags | Tag model prediction score. Value range: [0, 1]. | |
Tags (video category) has the following sub-nodes:
|
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.Tags | | |
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.Tags | Tag model prediction score. Value range: [0, 1]. | |
PersonTags has the following sub-nodes:
|
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.PersonTags | | |
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.PersonTags | Tag model prediction score | |
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.PersonTags | Number of person appearances | |
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.PersonTags | Location and time of person appearance | |
DetailPerSecond has the following sub-nodes:
|
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.PersonTags.DetailPerSecond | Appearance time in seconds | |
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.PersonTags.DetailPerSecond | Tag model prediction score | |
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.PersonTags.DetailPerSecond | Relative coordinates of the object with top-left corner as the origin | |
BBox has the following sub-nodes:
|
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.PersonTags.DetailPerSecond.BBox | Relative position of coordinate X1 | |
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.PersonTags.DetailPerSecond.BBox | Relative position of coordinate Y1 | |
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.PersonTags.DetailPerSecond.BBox | Relative position of coordinate X2 | |
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.PersonTags.DetailPerSecond.BBox | Relative position of coordinate Y2 | |
PlaceTags has the following sub-nodes:
|
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.PlaceTags | Video scene tag information, which may not be returned and is the same as Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.Tags. | |
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.PlaceTags | Segment start time in seconds | |
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.PlaceTags | Segment end time in seconds | |
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.PlaceTags | Segment start frame number | |
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.PlaceTags | | |
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.PlaceTags | Top 1 single frame recognition result | |
ActionTags has the following sub-nodes:
|
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.ActionTags | Video action tag information, which may not be returned and is the same as Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.Tags. | |
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.ActionTags | Segment start time in seconds | |
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.ActionTags | Segment end time in seconds | |
ObjectTags has the following sub-nodes:
|
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.ObjectTags | Video object tag information, which may not be returned and is the same as Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.Tags. | |
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.ObjectTags | Timestamp of the identified object in seconds | |
Object has the following sub-nodes:
|
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.ObjectTags.Objects | | |
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.ObjectTags.Objects | Tag model prediction score. Value range: [0, 1]. | |
| Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.ObjectTags.Objects | Relative coordinates of the object with top-left corner as the origin, which is the same as Response.JobsDetail.Operation.VideoTagResult.StreamData.Data.PersonTags.DetailPerSecond.BBox. | |
Error codes
There are no special error messages for this request. For common error messages, see Error Codes. Samples
Request
POST /jobs HTTP/1.1
Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0ea057
Host: examplebucket-1250000000.ci.ap-beijing.myqcloud.com
Content-Length: 166
Content-Type: application/xml
<Request>
<Tag>VideoTag</Tag>
<Input>
<Object>input/demo.mp4</Object>
</Input>
<Operation>
<VideoTag>
<Scenario>Stream</Scenario>
</VideoTag>
<UserData>This is my data.</UserData>
<JobLevel>0</JobLevel>
</Operation>
<QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
<CallBack>http://callback.demo.com</CallBack>
<CallBackFormat>JSON<CallBackFormat>
</Request>
Response
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 230
Connection: keep-alive
Date: Mon, 28 Jun 2022 15:23:12 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****
<Response>
<JobsDetail>
<Code>Success</Code>
<Message/>
<JobId>j8d121820f5e411ec926ef19d53ba9c6f</JobId>
<State>Submitted</State>
<CreationTime>2022-06-27T15:23:10+0800</CreationTime>
<StartTime>-</StartTime>
<EndTime>-</EndTime>
<QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
<Tag>VideoTag</Tag>
<Input>
<BucketId>test-123456789</BucketId>
<Object>input/demo.mp4</Object>
<Region>ap-chongqing</Region>
</Input>
<Operation>
<VideoTag>
<Scenario>Stream</Scenario>
</VideoTag>
<UserData>This is my data.</UserData>
<JobLevel>0</JobLevel>
</Operation>
</JobsDetail>
</Response>
