物联网开发平台同步执行 TWeSee 语义理解任务

1. 接口描述

接口请求域名： iotexplorer.tencentcloudapi.com 。

同步执行 TWeSee 语义理解任务

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：InvokeTWeSeeRecognitionTask。
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
SummaryConfig	否	VisionSummaryConfig	摘要输出配置
ServiceType	否	String	算法类型，可能取值： - `Summary`：视频/图片摘要 - `ObjectDetect`：目标检测示例值：Summary
ObjectDetectConfig	否	VisionObjectDetectConfig	目标检测配置

3. 输出参数

参数名称	类型	描述
TaskId	String	任务 ID 示例值：fb066d7a-baac-4706-acda-058f56f82759
Completed	Boolean	任务是否执行完成示例值：true
Result	VisionRecognitionResult	语义理解任务结果（仅当 Completed 为 true 时包含该出参）
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建视频摘要任务并等待结果返回

最大超时时间为 20 秒

输入示例

POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: InvokeTWeSeeRecognitionTask
<公共请求参数>

{
    "ProductId": "4AHMY9X89Y",
    "DeviceName": "example_device_name",
    "InputURL": "https://example.qq.com/video.mp4",
    "ServiceType": "Summary"
}

输出示例

{
    "Response": {
        "Completed": true,
        "RequestId": "dc51b72e-872d-4908-82c3-f2e2794f2f60",
        "Result": {
            "DetectedClassifications": [
                "person"
            ],
            "Status": 3,
            "Summary": "穿白衣服的人正在公园的小路上行走"
        },
        "TaskId": "0198cbcc-d65f-7606-b4ac-664381086005"
    }
}

示例2 创建视频摘要任务并等待结果返回（使该视频可被搜索）

输入示例

POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: InvokeTWeSeeRecognitionTask
<公共请求参数>

{
    "ProductId": "4AHMY9X89Y",
    "DeviceName": "example_device_name",
    "InputURL": "https://example.qq.com/video.mp4",
    "EnableSearch": true,
    "StartTimeMs": 1755765320366,
    "EndTimeMs": 1755765328366,
    "ServiceType": "Summary"
}

输出示例

{
    "Response": {
        "Completed": true,
        "RequestId": "dc51b72e-872d-4908-82c3-f2e2794f2f60",
        "Result": {
            "DetectedClassifications": [
                "person"
            ],
            "Status": 3,
            "Summary": "穿白衣服的人正在公园的小路上行走"
        },
        "TaskId": "0198cbcc-d65f-7606-b4ac-664381086005"
    }
}

示例3 创建视频摘要任务并等待结果返回（使用未创建的设备名）

输入示例

POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: InvokeTWeSeeRecognitionTask
<公共请求参数>

{
    "ProductId": "4AHMY9X89Y",
    "DeviceName": "not_exist_device_name",
    "InputURL": "https://example.qq.com/video.mp4",
    "IsCustomDevice": true,
    "ServiceType": "Summary"
}

输出示例

{
    "Response": {
        "Completed": true,
        "RequestId": "dc51b72e-872d-4908-82c3-f2e2794f2f60",
        "Result": {
            "DetectedClassifications": [
                "person"
            ],
            "Status": 3,
            "Summary": "穿白衣服的人正在公园的小路上行走"
        },
        "TaskId": "0198cbcc-d65f-7606-b4ac-664381086005"
    }
}

示例4 创建图片摘要任务并等待结果返回

输入示例

POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: InvokeTWeSeeRecognitionTask
<公共请求参数>

{
    "ProductId": "4AHMY9X89Y",
    "DeviceName": "example_device_name",
    "InputURL": "https://example.qq.com/image.jpg",
    "InputType": "image",
    "ServiceType": "Summary"
}

输出示例

{
    "Response": {
        "Completed": true,
        "RequestId": "dc51b72e-872d-4908-82c3-f2e2794f2f60",
        "Result": {
            "DetectedClassifications": [
                "person"
            ],
            "Status": 3,
            "Summary": "穿白衣服的人正在公园的小路上行走"
        },
        "TaskId": "0198cbcc-d65f-7606-b4ac-664381086005"
    }
}

示例5 创建视频摘要任务并等待结果返回（包含多路摄像头的视频）

输入示例

POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: InvokeTWeSeeRecognitionTask
<公共请求参数>

{
    "ProductId": "4AHMY9X89Y",
    "DeviceName": "example_device_name",
    "InputURL": "https://example.qq.com/video.mp4",
    "SummaryConfig": {
        "MultiCameraLayout": "Vertical,Num=2,Index=0;1"
    },
    "ServiceType": "Summary"
}

输出示例

{
    "Response": {
        "Completed": true,
        "RequestId": "dc51b72e-872d-4908-82c3-f2e2794f2f60",
        "Result": {
            "DetectedClassifications": [
                "person"
            ],
            "Status": 3,
            "Summary": "穿白衣服的人正在公园的小路上行走"
        },
        "TaskId": "0198cbcc-d65f-7606-b4ac-664381086005"
    }
}

示例6 创建目标检测任务并等待结果返回

最大超时时间为 20 秒

输入示例

POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: InvokeTWeSeeRecognitionTask
<公共请求参数>

{
    "ProductId": "4AHMY9X89Y",
    "DeviceName": "example_device_name",
    "InputURL": "https://example.qq.com/video.mp4",
    "ServiceType": "ObjectDetect",
    "ObjectDetectConfig": {
        "DetectTypes": [
            "adult",
            "child"
        ]
    }
}

输出示例

{
    "Response": {
        "Completed": true,
        "RequestId": "dc51b72e-872d-4908-82c3-f2e2794f2f60",
        "Result": {
            "DetectedClassifications": [
                "adult"
            ],
            "Status": 3
        },
        "TaskId": "0198cbcc-d65f-7606-b4ac-664381086005"
    }
}

示例7 创建视频摘要任务后任务执行失败的情况

下载/读取视频/图片失败时，返回 Status = 2，ErrorCode 字段指出具体错误原因

输入示例

POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: InvokeTWeSeeRecognitionTask
<公共请求参数>

{
    "ProductId": "4AHMY9X89Y",
    "DeviceName": "example_device_name",
    "InputURL": "https://example.qq.com/video.mp4",
    "ServiceType": "Summary"
}

输出示例

{
    "Response": {
        "Completed": true,
        "RequestId": "dc51b72e-872d-4908-82c3-f2e2794f2f60",
        "Result": {
            "ErrorCode": "DownloadFailed",
            "Status": 2
        },
        "TaskId": "0198cbcc-d65f-7606-b4ac-664381086005"
    }
}

示例8 创建视频摘要任务后任务执行超时的情况

任务执行 20 秒仍未返回结果，返回 Completed = false，任务将继续执行，后续可凭 TaskId 通过 DescribeTWeSeeRecognitionTask 重新查询该任务的结果

输入示例

POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: InvokeTWeSeeRecognitionTask
<公共请求参数>

{
    "ProductId": "4AHMY9X89Y",
    "DeviceName": "example_device_name",
    "InputURL": "https://example.qq.com/video.mp4",
    "ServiceType": "Summary"
}

输出示例

{
    "Response": {
        "Completed": false,
        "RequestId": "dc51b72e-872d-4908-82c3-f2e2794f2f60",
        "TaskId": "0198cbcc-d65f-7606-b4ac-664381086005"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.WeSeeServiceNotEnabled	未开通 TWeSee 后付费服务
InternalError	内部错误。
InvalidParameter	参数错误。
ResourceInsufficient.CloudStorageAIServiceTaskQuotaInsufficient	云存 AI 分析任务创建额度不足
ResourceUnavailable.WeSeeServiceIsolated	TWeSee 后付费资源已隔离
UnauthorizedOperation.ApiCreateAITaskNotInWhitelist	该账号未在白名单内，不能通过 API 创建 AI 任务
UnsupportedOperation	操作不支持。

同步执行 TWeSee 语义理解任务

本页目录：

1. 接口描述

2. 输入参数

3. 输出参数

4. 示例

示例1 创建视频摘要任务并等待结果返回

输入示例

输出示例

示例2 创建视频摘要任务并等待结果返回（使该视频可被搜索）

输入示例

输出示例

示例3 创建视频摘要任务并等待结果返回（使用未创建的设备名）

输入示例

输出示例

示例4 创建图片摘要任务并等待结果返回

输入示例

输出示例

示例5 创建视频摘要任务并等待结果返回（包含多路摄像头的视频）

输入示例

输出示例

示例6 创建目标检测任务并等待结果返回

输入示例

输出示例

示例7 创建视频摘要任务后任务执行失败的情况

输入示例

输出示例

示例8 创建视频摘要任务后任务执行超时的情况

输入示例

输出示例

5. 开发者资源

腾讯云 API 平台

API Inspector

SDK

命令行工具

6. 错误码