帮你快速理解、总结文档立即下载

创建批量视频标注任务

最近更新时间:2026-09-04 02:04:17
我的收藏

1. 接口描述

接口请求域名: trro.tencentcloudapi.com 。

提交S3兼容存储桶数据源的目录前缀创建批量标注任务。创建后,服务端异步列举前缀下全部视频逐个建立处理项(受配额上限控制,超限截断)。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateBatchVideoAnnotationJob。
Version String 公共参数,本接口取值:2022-03-25。
Region String 公共参数,本接口不需要传递此参数。
InputStorage BatchS3SourceInfo

批量输入源信息(目录前缀)

AnnotationType Integer

标注模式(当前仅开放精标注)

枚举值:

  • 3: 精标注

示例值:3
AnnotationContext AnnotationContext

标注上下文信息

ProcessParams ProcessParams

标注处理参数,预留字段,当前无效

OutputStorage OutputStorage

批量结果输出存储信息,不传则不投递

CallbackInfo CallbackInfo

回调信息,配置后当任务下子处理项状态从处理中变为其他状态时,服务端会向回调地址发送请求(退避重试三次,不保证回调一定送达,需保证目标地址接收服务有效),建议接收方做好幂等处理。回调请求格式如下:
请求头

名称
X-Annotation-Signaturehex(HMAC-SHA256(请求体原始字节, CallbackInfo.Secret))

请求体(application/json)

参数名类型必选描述
JobIdstring任务 ID
TaskIdstring处理项 ID
FileNamestring视频文件名
Statusint触发本次回调的处理项状态:3 超时,4 异常,5 待确认,6 成功
StatusChangedAtint状态变更时间,Unix 时间戳(秒)
RawResultstring当前生效的结果 JSON 原文:成功=标注产物;待确认=原始标注;确认后=确认版内容。超时/异常无内容

3. 输出参数

参数名称 类型 描述
JobId String

任务 ID


示例值:3uixqpy6yywr
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 调用示例1

输入示例

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

{
    "InputStorage": {
        "Bucket": "ai-annotation-test-input-1258344699",
        "Endpoint": "cos-internal.ap-guangzhou.tencentcos.cn",
        "Region": "ap-guangzhou",
        "Prefix": "batch-test/",
        "Secret": {
            "SecretId": "************************************",
            "SecretKey": "********************************"
        },
        "Filter": "^1qLI.*\\.mp4$",
        "IsCos": 1
    },
    "AnnotationType": 3,
    "AnnotationContext": {
        "TaskGoal": "把香蕉从盘子中夹起来",
        "KeyObjects": [
            "香蕉"
        ],
        "AtomicVerbs": [
            "拿取"
        ]
    },
    "OutputStorage": {
        "Bucket": "ai-annotation-test-input-1258344699",
        "Endpoint": "cos-internal.ap-guangzhou.tencentcos.cn",
        "Region": "ap-guangzhou",
        "Secret": {
            "SecretId": "************************************",
            "SecretKey": "********************************"
        },
        "Prefix": "batch-result/",
        "NameRule": "$YYYY$mm$dd_$FileName_$TaskId.json"
    },
    "CallbackInfo": {
        "Url": "https://callback.example.com/annotation",
        "Secret": "test-callback-secret-0f1e2d3c"
    }
}

输出示例

{
    "Response": {
        "JobId": "3uixqpy6yywr",
        "RequestId": "e2fb02e7-7dad-40bf-a100-69e6eab7af28"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.StorageCheckFailed 存储连通性测试失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue.InvalidFilterRegex 批量列举 Filter 正则表达式非法。
InvalidParameterValue.InvalidRegion 存储区域与桶实际地域不匹配。
InvalidParameterValue.NoVideoFiles 指定前缀下没有视频文件。
InvalidParameterValue.StorageUnreachable 存储服务地址不可达。
MissingParameter 缺少参数错误。
OperationDenied.AnnotationTypeNotEnabled 标注模式未开放。
ResourceNotFound 资源不存在。
UnauthorizedOperation.StorageAuthFailed 存储密钥无效或无权限。