1. 接口描述
接口请求域名： iotexplorer.tencentcloudapi.com 。
调用 TWeSee 视觉理解算法
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：InvokeTWeSeeComprehension。 |
| Version | 是 | String | 公共参数，本接口取值：2019-04-23。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-bangkok, ap-guangzhou 。 |
| InputURL | 是 | String | 输入视频 / 图片的 URL 示例值：https://-test-125*22.cos.ap-guangzhou.myqcloud.com/****.jpg |
| ServiceType | 是 | String | 算法类型。可选值： - VID_COMP：视频理解- IMG_COMP：图片理解示例值：IMG_COMP |
| Metadata | 否 | SeeTaskMetadata | 任务元数据 |
| ComprehensionConfig | 否 | SeeComprehensionConfig | 视觉理解配置项 |
| WaitResultTimeout | 否 | Integer | 等待结果的超时时间（单位：秒）。填 0 表示无需等待结果。最大超时时长 25 秒，默认超时时长 20 秒。 示例值：20 |
| CallbackId | 否 | String | 回调目标 ID 示例值：cb-n9sl1wur |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 任务 ID 示例值：comp-12e89917-c932-c27d-977f-bd16cc5c3b92 |
| Status | Integer | 任务状态。可能取值： - 1：失败- 2：空结果- 3：有效结果- 4：处理中示例值：3 |
| ComprehensionResult | SeeComprehensionResult | 视觉理解结果 |
| CostBasic | Integer | 完成该任务所消耗的基础能力额度 示例值：1 |
| CostAdvanced | Integer | 完成该任务所消耗的高级能力额度 示例值：0 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 调用 TWeSee 图片理解算法
输入示例
POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: InvokeTWeSeeComprehension
<公共请求参数>
{
"InputURL": "https://****-test-125*****22.cos.ap-guangzhou.myqcloud.com/********.jpg",
"ServiceType": "IMG_COMP",
"WaitResultTimeout": 20,
"CallbackId": "cb-n9sl1wur"
}输出示例
{
"Response": {
"ComprehensionResult": {
"DetectedClassifications": [
"cat"
],
"Summary": "一只猫坐在吉他盒里，旁边有只小鸟飞过"
},
"CostAdvanced": 0,
"CostBasic": 1,
"Status": 3,
"TaskId": "comp-12e89917-c932-c27d-977f-bd16cc5c3b92",
"RequestId": "2063f9bf-ecad-499c-8f03-220c911385e9"
}
}示例2 调用 TWeSee 视频理解算法
输入示例
POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: InvokeTWeSeeComprehension
<公共请求参数>
{
"InputURL": "https://*********-125*******.cos.ap-guangzhou.tencentcos.cn/*******.mp4",
"ServiceType": "VID_COMP"
}输出示例
{
"Response": {
"ComprehensionResult": {
"DetectedClassifications": [
"person"
],
"Summary": "穿浅色衣物的人在湿滑路边行走"
},
"CostAdvanced": 0,
"CostBasic": 1,
"Status": 3,
"TaskId": "comp-8c47f42e-c9fd-3e6a-a0c5-64da344c013d",
"RequestId": "2d126014-5991-490d-8f4a-75991ad5871e"
}
}示例3 调用 TWeSee 视频理解算法（含高级功能）
对该视频生效视频搜索高级功能
输入示例
POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: InvokeTWeSeeComprehension
<公共请求参数>
{
"InputURL": "https://kero-test-1255707222.cos.ap-guangzhou.tencentcos.cn/jiwei/4.mp4",
"ServiceType": "VID_COMP",
"ComprehensionConfig": {
"EnableSearch": true
}
}输出示例
{
"Response": {
"ComprehensionResult": {
"DetectedClassifications": [
"person"
],
"Summary": "穿浅色衣物的人在雨后湿滑的路边行走"
},
"CostAdvanced": 1,
"CostBasic": 1,
"Status": 3,
"TaskId": "comp-c01e4d7f-2bf5-3e6e-e865-bc495b954b23",
"RequestId": "296e405d-fe5f-4ed0-a2c4-f34fd70f4ab2"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.SeePostPaidServiceIsolated | TWeSee 后付费服务已隔离 |
| FailedOperation.SeePostPaidServiceIsolatedByAccount | TWeSee 后付费服务已隔离（账号欠费） |
| FailedOperation.SeePostPaidServiceNotExists | 未开通 TWeSee 算法的后付费服务 |
| InternalError | 内部错误。 |
| InternalError.DBOperationError | DB操作错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.InvalidURL | URL 格式有误或无法访问 |
| ResourceNotFound.SeeCallbackNotExist | 指定的 TWeSee 回调目标不存在 |
| UnsupportedOperation | 操作不支持。 |
| UnsupportedOperation.CapabilityNotSupportedInSeeServiceType | 指定的 TWeSee 服务类型不支持该能力项 |
