本文提供了调用视频异步检测任务进行视频标签识别的具体接口和参数说明,帮助您编写程序构建HTTP调用请求。

  • 关于如何构造HTTP请求,请参见请求结构
  • 您也可以直接选用已构造好的HTTP请求,具体请参见SDK 概览

提交视频异步检测任务

业务接口:/green/video/asyncscan

异步检测视频中包含的标签内容,支持通过传入视频URL、本地视频文件、视频二进制流的方式进行检测。

说明 该接口为收费接口,具体计费方式请参见内容安全产品定价

该接口按照“视频的时长(分钟)×视频标签识别单价”计费。

异步检测结果需要通过调用结果查询接口(具体请参见查询视频异步检测结果)进行查询或者通过callback的方式进行接收,检测结果最多保留4个小时。

待检测视频需要满足以下要求:
  • 视频文件链接支持以下协议:HTTP和HTTPS。
  • 视频文件支持以下格式:AVI、FLV、MP4、MPG、ASF、WMV、MOV、WMA、RMVB、RM、FLASH、TS。
  • 视频大小限制:单个视频大小不超过200MB。如果您有特殊需求(大视频),可以提工单进行调整。
  • 视频流支持以下协议:RTMP、HLS、HTTP-FLV、RTSP。
  • 视频流时长限制:单个视频流检测任务最长支持24小时,超过24小时任务自动结束。
  • 视频检测的时间依赖于视频的下载时间。请保证被检测的视频文件所在的存储服务稳定可靠,建议您使用阿里云OSS存储服务存储视频文件。

请求参数

名称 类型 是否必须 描述
bizType 字符串 该字段用于标识业务场景。针对不同的业务场景,您可以配置不同的内容审核策略,以满足不同场景下不同的审核标准或算法策略的需求。您可以通过云盾内容安全控制台创建业务场景(bizType),或者通过工单联系我们帮助您创建业务场景。
live 布尔型 是否直播。默认为false,表示为普通视频检测;若为直播检测,该值必须传入true
offline 布尔型 是否近线检测模式。
  • 默认为false,表示实时检测模式,对于超过了并发路数限制的检测请求会直接拒绝。
  • 如果为true,会进入近线检测模式,提交的任务不保证实时处理,但是可以排队处理,在24小时内开始检测。
说明 该参数仅作用于视频文件检测,不支持流式检测。
scenes 字符串数组 指定视频检测的应用场景,可选值包括:tag
callback 字符串 异步检测结果回调通知您的URL,支持HTTP、HTTPS。当该字段为空时,您必须定时检索检测结果。
seed 字符串 该值用于回调通知请求中的签名。当使用callback时,该字段必须提供。
tasks JSON数组 JSON数组中的每个元素是一个结构体(Video表)。每个元素的具体结构描述请参见task
表 1. task
名称 类型 是否必须 描述
dataId 字符串 数据ID。需要保证在一次请求中所有的ID不重复。
url 字符串 视频URL地址。
说明 如果需要检测本地视频文件,建议您将其上传到OSS后使用文件URL进行检测。

结果回调通知

调用异步检测时,您可以在请求参数中传入回调通知参数(callback),即一个HTTP、HTTPS协议接口的URL,用来接收检测结果。callback接口必须支持POST方法、UTF-8编码的传输数据,以及表单参数checksumcontent。内容安全按照下表描述的生成规则和格式设置checksumcontent,调用您的callback接口返回检测结果。
说明 您的服务端callback接口收到内容安全推送的结果后,如果返回的HTTP状态码为200,则表示接收成功,其他的HTTP状态码均视为接收失败。接收失败时,内容安全将最多重复推送16次检测结果,直到接收成功。重复推送16次后仍未接收成功,则不再推送,建议您检查callback接口的状态。
名称 类型 描述
checksum 字符串 用户uid + seed + content拼成字符串,通过SHA256算法生成。用户UID即阿里云账号ID,可以在阿里云控制台查询。为防篡改,您可以在获取到推送结果时,按上述算法生成字符串,与checksum做一次校验。
说明 用户UID必须是阿里云主账号UID,而非子账号UID。
content 字符串 JSON字符串格式,请自行解析反转成JSON对象。content结果的示例如下。
content结果示例
{
    "code": 200,
    "msg": "OK",
    "dataId": "videoId xxx",
    "taskId": "taskId xxx",
    "results": [
        {
            "label": "tag",
            "rate": 99.2,
            "scene": "tag",
            "suggestion": "review"
        }
    ]
}

返回参数

名称 类型 是否必须 描述
taskId 字符串 该检测任务的ID。
dataId 字符串 检测对象对应的数据ID。
说明 如果在请求参数中传入了dataId,则此处返回对应的dataId

示例

请求示例
{
    "code": 200,
    "msg": "OK",
    "requestId": "requestID xxx",
    "data": [
        {
            "dataId": "videoId xxx",
            "taskId": "taskId xxx"
        }
    ]
}
返回示例
{
    "code": 200,
    "msg": "OK",
    "requestId": "requestID xxx",
    "data": [
        {
            "dataId": "videoId xxx",
            "taskId": "taskId xxx"
        }
    ]
}

查询视频异步检测结果

业务接口:/green/video/results

查询视频异步检测的结果。建议您将查询间隔设置为30秒,最长不能超过4个小时,否则结果将会消失。

说明 该接口为免费接口。

请求参数

名称 类型 是否必须 描述
body JSON数组 要查询的taskId列表。最大长度不超过100。

返回参数

名称 类型 是否必须 描述
code 整型 错误码,和HTTP的status code一致。
msg 字符串 错误描述信息。
dataId 字符串 检测对象对应的数据ID。
说明 如果在请求参数中传入了dataId,则此处返回对应的dataId
taskId 字符串 该检测任务的ID。
results 数组 返回结果,调用成功时(code=200),返回结果中包含一个或多个元素。每个元素是个结构体,具体结构描述请参见result
表 2. result
名称 类型 是否必须 描述
scene 字符串 视频检测场景,取值:tag
label 字符串 检测结果的分类,取值:
  • normal:正常视频,无标签
  • tag:含标签视频
suggestion 字符串 建议用户执行的操作,取值范围:
  • pass:视频不含标签,无需进行其余操作
  • review:视频包含标签,建议执行进一步操作
rate 浮点数 结果为该分类的概率,取值范围为0.00~100.00。值越高,表示越有可能属于该分类。
extras JSON对象 附加信息。
tagData 结构体 标签识别发现标签时(label=tag),返回的标签数据信息。具体结构描述请参见tagData
表 3. tagData
名称 类型 是否必须 描述
summary 数组 标签概要信息。具体结构描述请参见summary
details 数组 标签详细信息。具体结构描述请参见detail
表 4. summary
名称 类型 是否必须 描述
tgCnName 字符串 标签中文名。
tgEnName 字符串 标签英文名。
cnCategory 字符串 标签所属的分类中文名称。
enCategory 字符串 标签所属的分类英文名称。
rate 浮点数 结果为标签的概率,取值范围0~100。取值越大,则越有可能属于标签。
表 5. detail
名称 类型 是否必须 描述
tgCnName 字符串 标签中文名。
tgEnName 字符串 标签英文名。
tagSegment 数组 该标签出现在视频中的分段时间信息。具体结构描述请参见tagSegment
cnCategory 字符串 标签所属的分类中文名称。
enCategory 字符串 标签所属的分类英文名称。
表 6. tagSegment
名称 类型 是否必须 描述
offset 整型 该标签出现在视频中的起始时间位置,单位为秒。
duration 整型 该标签在视频中持续出现的时长,单位为秒。
rate 浮点数 结果为标签的概率,取值范围0~100。取值越大,则越有可能属于标签。

示例

请求示例
[
    "taskId aaa",
    "taskId bbb"
]
返回示例
{
    "msg": "OK",
    "code": 200,
    "data": [
        {
            "msg": "OK",
            "code": 200,
            "dataId": "test35T5XhMsXfV4xKwUv8Ob74-1poXxF",
            "results": [
                {
                    "tagData": {
                        "summary": [
                            {
                                "rate": 37.72,
                                "tagEnName": "Aircraft",
                                "tagCnName": "飞行器",
                                "enCategory": "entities",
                                "cnCategory": "实体"
                            },
                            {
                                "rate": 31.93,
                                "tagEnName": "Hotel",
                                "tagCnName": "旅馆",
                                "enCategory": "entities",
                                "cnCategory": "实体"
                            }
                        ],
                        "details": [
                            {
                                "tagSegment": [
                                    {
                                        "duration": 1,
                                        "offset": 3,
                                        "rate": 40.73
                                    }
                                ],
                                "tagEnName": "balloon",
                                "tagCnName": "气球",
                                "enCategory": "entities",
                                "cnCategory": "实体"
                            },
                            {
                                "tagSegment": [
                                    {
                                        "duration": 1,
                                        "offset": 4,
                                        "rate": 37.72
                                    }
                                ],
                                "tagEnName": "Airship",
                                "tagCnName": "飞艇",
                                "enCategory": "entities",
                                "cnCategory": "实体"
                            },
                            {
                                "tagSegment": [
                                    {
                                        "duration": 2,
                                        "offset": 8,
                                        "rate": 41.48
                                    }
                                ],
                                "tagEnName": "Traffic light",
                                "tagCnName": "交通灯",
                                "enCategory": "entities",
                                "cnCategory": "实体"
                            },
                            {
                                "tagSegment": [
                                    {
                                        "duration": 60,
                                        "offset": 60,
                                        "rate": 31.93
                                    }
                                ],
                                "tagEnName": "Hotel",
                                "tagCnName": "旅馆",
                                "enCategory": "entities",
                                "cnCategory": "实体"
                            }
                        ]
                    },
                    "rate": 99.91,
                    "suggestion": "review",
                    "label": "tag",
                    "scene": "tag"
                }
            ],
            "taskId": "vi636L2Z$Q43i6LRrWdITWhq-1poXxF",
            "url": "https://aligreen-misc-hangzhou.oss-cn-hangzhou.aliyuncs.com/test.mp4"
        }
    ],
    "requestId": "5CAED310-CC31-4E34-9EB5-3C2E741BB870"
}