1. 接口描述
接口请求域名: vm.tencentcloudapi.com 。
通过查看任务详情 DescribeTaskDetail 接口,可主动轮询获取检测结果详情。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeTaskDetail。 |
Version | 是 | String | 公共参数,本接口取值:2021-09-22。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
TaskId | 是 | String | 任务ID,创建任务后返回的TaskId字段 示例值:task-video-Xw0mjnmaiu-Uv1fs |
ShowAllSegments | 否 | Boolean | 是否展示所有分片,默认只展示命中规则的分片 示例值:true |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 该字段用于返回创建视频审核任务后返回的任务ID(在Results参数中),用于标识需要查询任务详情的审核任务。 注意:此字段可能返回 null,表示取不到有效值。 示例值:task-video-XwxJtbkKXWgCt8AZ |
DataId | String | 该字段用于返回调用视频审核接口时传入的数据ID参数,方便数据的辨别和管理。 注意:此字段可能返回 null,表示取不到有效值。 示例值:data_test_01 |
BizType | String | 该字段用于返回调用视频审核接口时传入的BizType参数,方便数据的辨别和管理。 注意:此字段可能返回 null,表示取不到有效值。 示例值:1001 |
Name | String | 该字段用于返回调用视频审核接口时传入的TaskInput参数中的任务名称,方便任务的识别与管理。 注意:此字段可能返回 null,表示取不到有效值。 示例值:22 |
Status | String | 该字段用于返回所查询内容的任务状态。 取值:FINISH(任务已完成)、PENDING (任务等待中)、RUNNING (任务进行中)、ERROR (任务出错)、CANCELLED (任务已取消)。 注意:此字段可能返回 null,表示取不到有效值。 示例值:FINISH |
Type | String | 该字段用于返回调用视频审核接口时输入的视频审核类型,取值为:VIDEO(点播视频)和LIVE_VIDEO(直播视频),默认值为VIDEO。 注意:此字段可能返回 null,表示取不到有效值。 示例值:VIDEO |
Suggestion | String | 该字段用于返回基于恶意标签的后续操作建议。当您获取到判定结果后,返回值表示系统推荐的后续操作;建议您按照业务所需,对不同违规类型与建议值进行处理。 返回值:Block:建议屏蔽,Review :建议人工复审,Pass:建议通过 注意:此字段可能返回 null,表示取不到有效值。 示例值:Block |
Labels | Array of TaskLabel | 该字段用于返回检测结果所对应的恶意标签。 返回值:Porn:色情,Abuse:谩骂,Ad:广告,Custom:自定义违规;以及其他令人反感、不安全或不适宜的内容类型。 注意:此字段可能返回 null,表示取不到有效值。 |
MediaInfo | MediaInfo | 该字段用于返回输入媒体文件的详细信息,包括编解码格式、分片时长等信息。详细内容敬请参考MediaInfo数据结构的描述。 注意:此字段可能返回 null,表示取不到有效值。 |
InputInfo | InputInfo | 该字段用于返回审核服务的媒体内容信息,主要包括传入文件类型和访问地址。 注意:此字段可能返回 null,表示取不到有效值。 |
CreatedAt | String | 该字段用于返回被查询任务创建的时间,格式采用 ISO 8601标准。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2020-07-13T11:47:01.925Z |
UpdatedAt | String | 该字段用于返回被查询任务最后更新时间,格式采用 ISO 8601标准。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2020-07-13T11:47:25.840Z |
TryInSeconds | Integer | 在秒后重试 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
ImageSegments | Array of ImageSegments | 该字段用于返回视频中截帧审核的结果,详细返回内容敬请参考ImageSegments数据结构的描述。 注意:此字段可能返回 null,表示取不到有效值。 |
AudioSegments | Array of AudioSegments | 该字段用于返回视频中音频审核的结果,详细返回内容敬请参考AudioSegments数据结构的描述。 注意:此字段可能返回 null,表示取不到有效值。 |
ErrorType | String | 当任务状态为Error时,返回对应错误的类型,取值: DECODE_ERROR: 解码失败。(输入资源中可能包含无法解码的视频) URL_ERROR:下载地址验证失败。 TIMEOUT_ERROR:处理超时。 CALLBACK_ERRORR:回调错误。 MODERATION_ERROR:审核失败。 URL_NOT_SUPPORTED:源文件太大或没有图片音频帧 任务状态非Error时默认返回为空。 注意:此字段可能返回 null,表示取不到有效值。 |
ErrorDescription | String | 当任务状态为Error时,该字段用于返回对应错误的详细描述,任务状态非Error时默认返回为空。 注意:此字段可能返回 null,表示取不到有效值。 |
Label | String | 该字段用于返回检测结果所对应的标签。如果未命中恶意,返回Normal,如果命中恶意,则返回Labels中优先级最高的标签 注意:此字段可能返回 null,表示取不到有效值。 示例值:Normal |
AudioText | String | 该字段用于返回音频文件识别出的对应文本内容,最大支持前1000个字符。 注意:此字段可能返回 null,表示取不到有效值。 |
Asrs | Array of RcbAsr | 该字段用于返回音频文件识别出的对应文本内容。 注意:此字段可能返回 null,表示取不到有效值。 |
SegmentCosUrlList | SegmentCosUrlList | 该字段用于返回检测结果明细数据相关的cos url 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查看任务详情
在创建任务后,可以通过TaskId查看任务详情
输入示例
POST / HTTP/1.1
Host: vm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTaskDetail
<公共请求参数>
{
"TaskId": "task-video-Xw0mjnmaiu-Uv1fs"
}
输出示例
{
"Response": {
"TaskId": "task-video-XwxJtbkKXWgCt8AZ",
"DataId": "data_test_01",
"BizType": "1001",
"Name": "",
"Status": "FINISH",
"Type": "VIDEO",
"Suggestion": "Block",
"Labels": [
{
"Label": "Porn",
"Suggestion": "Block",
"Score": 99,
"SubLabel": ""
},
{
"Label": "Hot",
"Suggestion": "Block",
"Score": 70,
"SubLabel": ""
}
],
"MediaInfo": {
"Codecs": "h264 aac",
"Duration": 36,
"Width": 352,
"Height": 640,
"Thumbnail": ""
},
"InputInfo": {
"Type": "URL",
"Url": "https://tianyu-cms-ap-guangzhou-xxxx.cos.ap-guangzhou.myqcloud.com/huang.mp4",
"BucketInfo": null
},
"CreatedAt": "2020-07-13T11:47:01.925Z",
"UpdatedAt": "2020-07-13T11:47:25.840Z",
"ImageSegments": [
{
"Result": {
"HitFlag": 1,
"Label": "Porn",
"Suggestion": "Block",
"Score": 85,
"Results": [
{
"Scene": "Porn",
"HitFlag": 1,
"Suggestion": "Block",
"Label": "Porn",
"SubLabel": "",
"Score": 85,
"Names": [],
"Text": "",
"Details": []
}
],
"Url": "https://cos.ap-zhou.myqcloud.com/c019/image_1.jpg",
"Extra": "{}"
},
"OffsetTime": "1"
}
],
"AudioSegments": [
{
"Result": {
"HitFlag": 1,
"Url": "https://cos.ap-guangzhou.myqcloud.com/xxx",
"Suggestion": "Block",
"Label": "Illegal",
"Text": "全民制作人们大家好,我是练习时长。",
"TextResults": [],
"MoanResults": [
{
"Label": "Moan",
"Score": 0,
"StartTime": 0,
"EndTime": 4000,
"Suggestion": "Pass",
"SubLabel": "",
"SubLabelCode": ""
}
],
"LanguageResults": [],
"Duration": "4000",
"Score": 1,
"Extra": "{}",
"SubLabel": "Anthem",
"RecognitionResults": [
{
"Label": "Teenager",
"Tags": [
{
"Name": "Teenager",
"Score": 0,
"StartTime": 0,
"EndTime": 4050
}
]
}
]
},
"OffsetTime": "0"
}
],
"AudioText": "",
"Asrs": [
{
"Text": "",
"CreatedAt": ""
}
],
"SegmentCosUrlList": {
"ImageAllUrl": "https://tianyu-cms-ap-guangzhou-xxxx.cos.ap-guangzhou.myqcloud.com/segment-/video/w-video-ZN3KK99etTNyRHYu/image_all.json",
"AudioAllUrl": "https://tianyu-cms-ap-guangzhou-xxxx.cos.ap-guangzhou.myqcloud.com/segment-/video/w-video-ZN3KK99etTNyRHYu/audio_all.json",
"ImageBlockUrl": "https://tianyu-cms-ap-guangzhou-xxxx.cos.ap-guangzhou.myqcloud.com/segment-/video/w-video-ZN3KK99etTNyRHYu/image_block.json",
"AudioBlockUrl": "https://tianyu-cms-ap-guangzhou-xxxx.cos.ap-guangzhou.myqcloud.com/segment-/video/w-video-ZN3KK99etTNyRHYu/audio_block.json",
"AsrUrl": "https://tianyu-cms-ap-guangzhou-xxxx.cos.ap-guangzhou.myqcloud.com/segment-/video/w-video-ZN3KK99etTNyRHYu/asr_txt.json"
},
"TryInSeconds": 0,
"RequestId": "8d3e4765-48db-40b5-8fdb-aaf1d7225a60",
"ErrorType": "",
"ErrorDescription": "",
"Label": "Porn"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |