1. 接口描述
接口请求域名: iotexplorer.tencentcloudapi.com 。
视频语义搜索
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:InvokeAISearchService。 |
| Version | 是 | String | 公共参数,本接口取值:2019-04-23。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-bangkok, ap-guangzhou 。 |
| ProductId | 是 | String | 产品ID 示例值:MVTYMD8YCD |
| DeviceName | 是 | String | 设备名称 示例值:dev001 |
| Query | 是 | String | 自然语言查询 示例值:有人走过 |
| SummaryLang | 否 | String | 搜索结果总结的语言类型,支持的类型有:en-US、zh-CN、id-ID、th-TH 示例值:zh-CN |
| ChannelId | 否 | Integer | 通道ID 示例值:0 |
| EnableSummary | 否 | Boolean | 是否需要返回总结,默认为True; 开启后会加大接口响应时长 示例值:false |
| StartTimeMs | 否 | Integer | 开始时间。 注: 1. 单位为毫秒(ms) 2. 如果同时指定了StartTimeMs与EndTimeMs,时间区间不能大于7天;如果只指定其中一个(例如只指定StartTimeMs,则查询自StartTimeMs后1天内的数据, 反之EndTimeMs也一样) 3. 只要指定了其中一个参数,接口则会忽略Query参数中关于时间的描述;(例如Query为"过去三天关于猫咪的视频", 则会将"过去三天忽略") 示例值:1750158420000 |
| EndTimeMs | 否 | Integer | 结束时间。 注: 1. 单位为毫秒(ms) 2. 如果同时指定了StartTimeMs与EndTimeMs,时间区间不能大于7天;如果只指定其中一个(例如只指定StartTimeMs,则查询自StartTimeMs后1天内的数据, 反之EndTimeMs也一样) 3. 只要指定了其中一个参数,接口则会忽略Query参数中关于时间的描述;(例如Query为"过去三天关于猫咪的视频", 则会将"过去三天忽略") 示例值:1750244820000 |
| TimeZone | 否 | String | 时区。默认值:Asia/Shanghai 注: 符合iana标准 https://www.iana.org/time-zones,例如Asia/Shanghai、Asia/Bangkok 示例值:Asia/Shanghai |
| SearchMode | 否 | Integer | 取值为1表示高级搜索,取值为2表示简单搜索,默认为1 示例值:1 |
| Limit | 否 | Integer | 最终输出的条数;仅当SearchMode为2时支持自定义设置,默认为50 示例值:50 |
| VectorSearchRadius | 否 | Float | 向量搜索的相似度搜索半径,取值范围[-1, 1];仅当SearchMode为2时支持自定义设置,默认为0.5 示例值:0.5 |
| VectorSearchTopK | 否 | Integer | 指定向量搜索最相似的 Top K;仅当SearchMode为2时支持自定义设置,默认为100 示例值:100 |
| Order | 否 | String | 搜索结果的排序方式,可选值: - CORRELATION:按相关性(默认)- TIME_ASC:按时间升序- TIME_DESC:按时间降序示例值:CORRELATION |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Summary | String | 基于搜索结果的总结 示例值:共1段视频:雨后路滑,浅色路人正小心行走。安全起见,请防滑慢行哦! |
| Targets | Array of TargetInfo | 视频结果集 |
| VideoURL | String | 视频回放URL 示例值:https://domain.com/video.m3u8 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 视频语义搜索
输入示例
POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: InvokeAISearchService
<公共请求参数>
{
"ProductId": "4AHMY9X89Y",
"DeviceName": "dev20260428a",
"Query": "有人走过"
}
输出示例
{
"Response": {
"Summary": "共1段视频:雨后路滑,浅色路人正小心行走。安全起见,请防滑慢行哦!",
"Targets": [
{
"ChannelId": 0,
"DeviceName": "dev20260428a",
"EndTimeMs": 1777357077918,
"EventId": "_sys_id1_data",
"Id": "019dd2bc-baa9-70ff-acd3-b7e88473c32d_1",
"ProductId": "4AHMY9X89Y",
"StartTimeMs": 1777357076918,
"Summary": "穿浅色衣物的人在雨后湿滑的路边行走",
"Thumbnail": "/700000975417/4AHMY9X89Y/dev20260428a/events/1777357076.jpg"
}
],
"VideoURL": "https://1259367869.vod2.myqcloud.com/timeshift/live/dev20260428a/timeshift.m3u8",
"RequestId": "5485cc1a-5c7a-4d86-98f9-da7bba179f6c"
}
}
示例2 视频语义搜索(英文)
输入示例
POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: InvokeAISearchService
<公共请求参数>
{
"ProductId": "4AHMY9X89Y",
"DeviceName": "dev20260428en",
"Query": "person walking",
"SummaryLang": "en-US"
}
输出示例
{
"Response": {
"Summary": "1 video shows a person walking safely on a wet sidewalk after rain. Stay cautious on slippery paths!",
"Targets": [
{
"ChannelId": 0,
"DeviceName": "dev20260428en",
"EndTimeMs": 1777356974727,
"EventId": "",
"Id": "019dd2bb-273c-7a95-bf08-8da22f56f415_1",
"ProductId": "4AHMY9X89Y",
"StartTimeMs": 1777356973727,
"Summary": "A person in light-colored clothes walking on a wet and slippery roadside after the rain",
"Thumbnail": "/700000975417/4AHMY9X89Y/dev20260428en/events/1777356973.jpg"
}
],
"VideoURL": "https://1259367869.vod2.myqcloud.com/timeshift/live/dev20260428en/timeshift.m3u8",
"RequestId": "b91d707d-bb24-40e8-8887-1984a58de77a"
}
}
示例3 视频语义搜索(结果按时间升序排序)
输入示例
POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: InvokeAISearchService
<公共请求参数>
{
"ProductId": "4AHMY9X89Y",
"DeviceName": "dev20260426",
"Query": "今天的视频",
"Order": "TIME_ASC"
}
输出示例
{
"Response": {
"Summary": "共2段视频:雨后湿滑路面行人慢行,蓝色货车弯道行驶。雨天路滑,请注意交通安全哦!",
"Targets": [
{
"ChannelId": 0,
"DeviceName": "dev20260426",
"EndTimeMs": 1777212005402,
"EventId": "",
"Id": "019dca17-1c33-7650-8294-bb99e524059b_1",
"ProductId": "4AHMY9X89Y",
"StartTimeMs": 1777212005402,
"Summary": "穿浅色衣物的人在雨后湿滑的路边行走",
"Thumbnail": "/700000975417/4AHMY9X89Y/dev20260426/events/1777212005.jpg"
}
],
"VideoURL": "https://1259367869.vod2.myqcloud.com/timeshift/live/dev20260426/timeshift.m3u8",
"RequestId": "6e9d71e1-b778-415d-a276-59de83ecab97"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |