All Products
Search
Document Center

ApsaraVideo VOD:GetAIVideoTagResult

Last Updated:Jul 19, 2024

Queries the results of smart tagging jobs.

Operation description

  • Regions that support this operation: China (Beijing), China (Shanghai), and Singapore.
  • You can obtain the smart tagging results by using the video ID.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
MediaIdstringYes

The ID of the media file. You can use one of the following methods to obtain the ID:

  • Log on to the ApsaraVideo VOD console. In the left-side navigation pane, choose Media Files > Audio/Video. On the Video and Audio page, view the ID of the audio or video file. This method is applicable to files that are uploaded by using the ApsaraVideo VOD console.
  • Obtain the value of VideoId from the response to the CreateUploadVideo operation that you call to upload media files.
  • Obtain the value of VideoId from the response to the SearchMedia operation after you upload media files.
595d020bad37421f37433451720****

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

RequestIdstring

The ID of the request.

8829B4DB-AFD9-4FF6-12965DBFFA14****
VideoTagResultobject

The returned result.

Categoryarray<object>

The video categories.

object

The category of the video.

Tagstring

The tag string.

Retouching
Personarray<object>

The figure tags.

object

The figure tag of the video.

FaceUrlstring

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
Tagstring

The tag string.

John
Timesarray

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"]
Timearray<object>

The time tags.

object

The time tag of the video.

Tagstring

The tag string.

Milliseconds
Timesarray

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"]
Locationarray<object>

The location tags.

object

The location tag of the video.

Tagstring

The tag string.

Asia
Timesarray

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"]
Keywordarray<object>

The keyword tags.

object

The keyword tag of the video.

Tagstring

The tag string.

Cushion
Timesarray

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

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.