1. 接口描述
接口请求域名: iotexplorer.tencentcloudapi.com 。
创建 TWeSee 语义理解任务
默认接口请求频率限制:1000次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateTWeSeeRecognitionTask。 |
Version | 是 | String | 公共参数,本接口取值:2019-04-23。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-bangkok, ap-guangzhou 。 |
ProductId | 是 | String | 产品ID 示例值:product |
DeviceName | 是 | String | 设备名称 示例值:devicename |
InputURL | 是 | String | 输入视频 / 图片的 URL 示例值:https://example.com/video.mp4 |
CustomId | 否 | String | 自定义事件 ID 示例值:alarm |
EnableSearch | 否 | Boolean | 是否保存该事件使其可被搜索 示例值:false |
StartTimeMs | 否 | Integer | 事件起始时间事件起始时间(毫秒级 UNIX 时间戳,若不传则默认为接口调用时间) 示例值:1743650670000 |
EndTimeMs | 否 | Integer | 事件结束时间事件起始时间(毫秒级 UNIX 时间戳,若不传则默认为接口调用时间) 示例值:1743650680500 |
Config | 否 | String | 算法配置 示例值:{"config_key":"config_value"} |
IsCustomDevice | 否 | Boolean | 是否自定义设备,为 true 时不检查设备存在性,默认为 false 示例值:false |
InputType | 否 | String | 输入类型。可选值: - video :视频(默认值)- image :图片示例值:video |
SummaryQOS | 否 | String | 摘要服务质量。可选值: - minutely :分钟级(默认值)- immediate :立即示例值:minutely |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 任务 ID 示例值:fb066d7a-baac-4706-acda-058f56f82759 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建 TWeSee 语义理解任务
输入示例
POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateTWeSeeRecognitionTask
<公共请求参数>
{
"ProductId": "4AHMY9X89Y",
"DeviceName": "dev001",
"InputURL": "hhttps://example.com/video.mp4",
"CustomId": "event-1",
"EnableSearch": true,
"StartTimeMs": 1744389074077,
"EndTimeMs": 1744389075077
}
输出示例
{
"Response": {
"RequestId": "26083bec-a7bd-491f-b6df-45e7f143638c",
"TaskId": "019625b1-15d6-72d8-a5d6-388b45c92c67"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
ResourceInsufficient.CloudStorageAIServiceTaskQuotaInsufficient | 云存 AI 分析任务创建额度不足 |
UnsupportedOperation | 操作不支持。 |