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后7天内的数据, 反之EndTimeMs也一样) 3. 只要指定了其中一个参数,接口则会忽略Query参数中关于时间的描述;(例如Query为"过去三天关于猫咪的视频", 则会将"过去三天忽略") 示例值:1750158420000 |
EndTimeMs | 否 | Integer | 结束时间。 注: 1. 单位为毫秒(ms) 2. 如果同时指定了StartTimeMs与EndTimeMs,时间区间不能大于7天;如果只指定其中一个(例如只指定StartTimeMs,则查询自StartTimeMs后7天内的数据, 反之EndTimeMs也一样) 3. 只要指定了其中一个参数,接口则会忽略Query参数中关于时间的描述;(例如Query为"过去三天关于猫咪的视频", 则会将"过去三天忽略") 示例值:1750244820000 |
TimeZone | 否 | String | 时区。默认值:Asia/Shanghai 注: 符合iana标准 https://www.iana.org/time-zones,例如Asia/Shanghai、Asia/Bangkok 示例值:Asia/Shanghai |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Summary | String | 基于搜索结果的总结 示例值:What happened on April 1st |
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": "MVTYMD8YCD",
"DeviceName": "dev001",
"Query": "What happened on April 1st"
}
输出示例
{
"Response": {
"RequestId": "a9a9d232-01c0-494a-baa3-57c384463c3f",
"Summary": "Nine videos captured various scenes on April 1st, showcasing pets eating and playing, a peaceful baby interaction, a resting child, and diligent workers like cleaners and delivery men, all without any safety concerns.",
"Targets": [
{
"ProductId": "MVTYMD8YCD",
"DeviceName": "dev001",
"StartTimeMs": 1743456533000,
"EndTimeMs": 1743456543000,
"EventId": "alarm",
"Summary": "Two cats and a dog eating"
}
]
}
}
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: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。