Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to conduct semantic search on media using natural language.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: SearchMediaBySemantics. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| SubAppId | Yes | Integer | Video-on-demand (VOD) application ID. For customers who activate on-demand services from December 25, 2023, they must fill this field with the application ID when accessing resources in on-demand applications (whether it's the default application or a newly created application). |
| Text | Yes | String | Search content |
| Limit | No | Integer | Number of returned records. The default value is 20. Value ranges from 1 to 100. |
| Categories.N | No | Array of String | File type. Match any element in the collection: |
| Tags.N | No | Array of String | Tag set, match any element in the collection. Input parameter limit: single tag length limited to 32 characters. Array length limit: 16. |
| Persons.N | No | Array of String | Figure collection, matching video clips where all imported figures appear. Input limit: Array length limit: 16. |
| TaskTypes.N | No | Array of String | Task type to search. Optional values:
|
| Parameter Name | Type | Description |
|---|---|---|
| SearchResults | Array of SemanticsSearchResult | Media list. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SearchMediaBySemantics
<Common request parameters>
{
"SubAppId": 1500035838,
"Text": "A seaside video with sunset"
}
{
"Response": {
"RequestId": "1e7aa7b9-0f92-4fbb-9ca2-6aebdfb31543",
"SearchResults": [
{
"EndTimeOffset": 159.07,
"FileId": "966263618841114024",
"Score": 0.58276,
"StartTimeOffset": 109.908
},
{
"EndTimeOffset": 109.708,
"FileId": "966263618841114024",
"Score": 0.58201,
"StartTimeOffset": 83.141
},
{
"EndTimeOffset": 82.741,
"FileId": "966263618841114024",
"Score": 0.46496,
"StartTimeOffset": 10.222
}
]
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError | Internal error. |
| ResourceNotFound.UserNotExist | The user does not exist. |
フィードバック