Use GetAIVideoTagResult to query AI video tag results - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Retrieves the results of smart tagging for a video.

Operation description

Currently, this operation is supported in the following regions: China (Beijing) and China (Shanghai).
Retrieves smart tagging results by video ID.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vod:GetAIVideoTagResult

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MediaId	string	Yes	The media asset ID, which is the video ID. You can obtain the video ID by using the following methods: For videos uploaded through the console, logon to the ApsaraVideo VOD console and choose Media Files > Audio/Video to view the video ID. When you call the CreateUploadVideo operation to obtain the upload URL and credential, the video ID is the value of the VideoId parameter in the response. After the video is uploaded, call the SearchMedia operation to query the video ID. The video ID is the value of the VideoId parameter in the response.	595d020bad37421f37433451720****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	8829B4DB-AFD9-4FF6-12965DBFFA14****
VideoTagResult	object	The result data.
Category	array<object>	The collection of video categories.
	object	The details of the video category.
Tag	string	The tag string.	Beauty
Person	array<object>	The collection of person tags.
	object	The details of the person tag.
FaceUrl	string	The URL of the profile photo. Note This parameter is returned only when a figure tag was used.	http://example.com/aivideotag/8829B4DB-AFD9-4F***F6-12965DBFFA14/Index_**.jpg
Tag	string	The tag string.	Xiao Wang
Times	array	The points in time when the tags are displayed. Unit: milliseconds.
	string	The point in time when the figure tag is displayed. Unit: milliseconds.	["10760"]
Time	array<object>	The collection of time tags.
	object	The details of the time tag.
Tag	string	The tag string.	Millisecond
Times	array	The points in time when the tags are displayed. Unit: milliseconds.
	string	The point in time when the time tag is displayed. Unit: milliseconds.	["3260","4000","5000","8410","12000","13000","14000"]
Location	array<object>	The collection of location tags.
	object	The details of the location tag.
Tag	string	The tag string.	Asia
Times	array	The points in time when the tags are displayed. Unit: milliseconds.
	string	The point in time when the location tag is displayed. Unit: milliseconds.	["8410"]
Keyword	array<object>	The collection of keyword tags.
	object	The details of the keyword tag.
Tag	string	The tag string.	Cushion
Times	array	The points in time when the tags are displayed. Unit: milliseconds.
	string	The point in time when the keyword tag is displayed. Unit: milliseconds.	["3260","4000","5000","8410","12000","13000","14000"]

Examples

Success response

JSON format

{
  "RequestId": "8829B4DB-AFD9-4FF6-12965DBFFA14****",
  "VideoTagResult": {
    "Category": [
      {
        "Tag": "Beauty"
      }
    ],
    "Person": [
      {
        "FaceUrl": "http://example.com/aivideotag/8829B4DB-AFD9-4F*****F6-12965DBFFA14/Index_****.jpg",
        "Tag": "Xiao Wang",
        "Times": [
          "[\"10760\"]"
        ]
      }
    ],
    "Time": [
      {
        "Tag": "Millisecond",
        "Times": [
          "[\"3260\",\"4000\",\"5000\",\"8410\",\"12000\",\"13000\",\"14000\"]"
        ]
      }
    ],
    "Location": [
      {
        "Tag": "Asia",
        "Times": [
          "[\"8410\"]"
        ]
      }
    ],
    "Keyword": [
      {
        "Tag": "Cushion",
        "Times": [
          "[\"3260\",\"4000\",\"5000\",\"8410\",\"12000\",\"13000\",\"14000\"]"
        ]
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.