Submits a smart tagging or video fingerprinting job.
Operation description
- Make sure that you understand the billing method and price of ApsaraVideo VOD before you call this operation. You are charged for using the smart tagging and video fingerprinting features. For more information, see Billing of video AI.
- Regions that support the video fingerprinting feature: China (Beijing), China (Shanghai), and Singapore. Regions that support the smart tagging feature: China (Beijing) and China (Shanghai).
- You need to enable the video fingerprinting feature or the smart tagging feature before you can call this operation to submit jobs. For more information, see Overview .
- If this is the first time you use the video fingerprinting feature, you must submit a ticket to apply for using the media fingerprint library for free. Otherwise, the video fingerprinting feature will be affected. For more information about how to submit a ticket, see Contact us.
- After you submit an AI job, ApsaraVideo VOD asynchronously processes the job. The operation may return a response before the job is complete. You can configure the Event Notification feature and set the callback event to AI Processing Completed. After you receive the event notification, you can query the execution result of the AI job.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| vod:SubmitAIJob | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| MediaId | string | Yes | The ID of the video. You can use one of the following methods to obtain the ID:
| 3D3D12340d9401fab46a0b847**** |
| Types | string | No | The type of the AI job. Separate multiple types with commas (,). Valid values:
| AIVideoTag |
| Config | string | No | The configurations of the AI job. The value is a JSON string.
| {"AIVideoTag": {"AnalyseTypes": "Face,ASR"} } |
| UserData | string | No | The custom settings. The value is a JSON string. For more information, see Request parameters. | {"Extend":{"localId":"***","test":"www"}} |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "25818875-5F78-4A13-BEF6-D73936****",
"AIJobList": {
"AIJob": [
{
"Type": "AIVideoTag",
"JobId": "9e82640c85114bf5af23edfaf****",
"MediaId": "3D3D12340d92c641401fab46a0b847****"
}
]
}
}Error codes
For a list of error codes, visit the Service error codes.