有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

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

创建智能标签任务。

请注意,本接口为异步接口,返回TaskId只代表任务创建成功,不代表任务执行成功

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateTask。
Version String 公共参数,本接口取值:2021-09-03。
Region String 公共参数,详见产品支持的 地域列表
MediaId String 媒资文件ID,最长32B
示例值:"media-12345678"
MediaPreknownInfo MediaPreknownInfo 媒资素材先验知识,相关限制参考MediaPreknownInfo
TaskName String 任务名称,最长100个中文字符
示例值:"新闻30分"
UploadVideo Boolean 是否上传转码后的视频,仅设置true时上传,默认为false
示例值:false
Label String 自定义标签,可用于查询
示例值:tag
CallbackURL String 任务分析完成的回调地址,该设置优先级高于控制台全局的设置;
示例值:http;//xxx

3. 输出参数

参数名称 类型 描述
TaskId String 智能标签视频分析任务ID
示例值:"56789"
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 输入普通话新闻素材,发起智能标签任务

输入示例

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

{
    "MediaPreknownInfo": {
        "MediaLang": 1,
        "MediaSecondLabel": 0,
        "MediaLabel": 1,
        "MediaType": 2
    },
    "TaskName": "demo-task-0",
    "MediaId": "media-a1b2c3d4",
    "UploadVideo": false
}

输出示例

{
    "Response": {
        "RequestId": "2713de41-b294-429b-ac13-2c3f5c49b1db",
        "TaskId": "task-g8lqk737"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure.UserInvalidStatus 用户状态异常。
AuthFailure.UserNotFound 用户无权限。
AuthFailure.UserStopArrear 用户已欠费停服。
FailedOperation.AiTemplateNotExist 匹配的模板不存在。
FailedOperation.MediaExpired 媒资文件已经过期。
FailedOperation.MediaNotReady 媒体文件未就绪。
FailedOperation.TaskAlreadyExist 存在相同的任务。
FailedOperation.TaskNotFinished 视频分析未完成。
InternalError.DBOperationError 内部DB操作错误。
InternalError.InnerError 内部错误。
InvalidParameter.InvalidMediaId 媒体ID不合法。
InvalidParameter.InvalidMediaLabel MediaLabel无效。
InvalidParameter.InvalidMediaLang MediaLang无效。
InvalidParameter.InvalidMediaName 媒体名称非法。
InvalidParameter.InvalidMediaType MediaType无效。
InvalidParameter.InvalidName 名称不合法。
InvalidParameter.InvalidParam 输入字段 %!s(MISSING) 不合法。
InvalidParameter.InvalidURL URL不合法。
InvalidParameter.NameTooLong 名称超过长度限制。
InvalidParameter.ParamTooLong 参数超过长度限制。
InvalidParameter.URLNotResolved 输入URL域名无法解析。
ResourceNotFound.MediaNotFound 媒资文件不存在。
UnauthorizedOperation.UnauthorizedProduct 用户未激活该产品。