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

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

提交视频异步检测任务

描述

业务接口/green/video/asyncscan

异步检测视频文件或视频流中是否包含敏感人脸信息,支持通过传入视频URL、本地视频文件、视频二进制流的方式进行检测。
说明 该接口为收费接口,按照 视频的实际截帧数× 视频敏感人脸识别(系统截帧)单价计费,具体请参考计费说明。

异步检测结果需要通过调用查询视频敏感人脸识别检测结果接口进行查询或者通过callback的方式进行接收,检测结果最多保留4个小时。

关于视频文件的限制
  • 视频文件链接支持以下协议:HTTP和HTTPS。
  • 视频文件支持以下格式:.avi、.flv、.mp4、.mpg、.asf、.wmv、.mov、.wma、.rmvb、.rm、.flash、.mid。
  • 视频流支持以下协议:.rtmp、.hls、.http-flv。
  • 视频大小限制:单个视频大小不超过200MB。如您有特殊需求(大视频),可以提工单进行调整。
  • 视频检测的时间依赖于视频的下载时间。请保证被检测的视频文件所在的存储服务稳定可靠,建议您使用阿里云OSS存储服务存储视频文件。

请求参数

关于在请求中必须包含的公共请求参数,请参考公共参数

请求body是一个JSON对象,字段说明如下:

名称 类型 是否必需 描述
bizType 字符串 自定义业务类型,由业务方提供。
每个bizType对应不同的算法/模型,运维人员可以为某一bizType动态地增加、删除要检测的风险场景。通过配置,后端根据该字段对请求做不同处理。
说明 该字段优先级高于 scenes字段。
scenes 字符串数组 指定视频检测的应用场景,取值:sface
live 布尔型 是否直播。默认为false,表示为普通视频检测;若为直播检测,该值必须传入true
callback 字符串 异步检测结果回调通知您的URL,支持HTTP/HTTPS。当该字段为空时,您必须定时检索检测结果。
seed 字符串 该值用于回调通知请求中的签名。当使用callback时,该字段必须提供。
tasks JSON数组 JSON数组中的每个元素是一个结构体(Video表)。每个元素的具体结构描述见task
表 1. task
名称 类型 是否必需 描述
clientInfo JSON结构体 客户端信息,参考公共参数中的公共查询参数。
服务器会把全局的 clientInfo和此处独立的 clientInfo合并。
说明 独立的 clientInfo优先级更高。
dataId 字符串 数据Id。需要保证在一次请求中所有的Id不重复。
url 字符串 视频地址,不能和frames同时为空,也不能和frames同时有值。
说明 传入本字段时按照传URL方式计费。
frames JSON数组 截帧信息。frames中的每个元素是个结构体(Frame表),每个元素的具体结构描述见frame
说明 传入本字段时按照传图片序列的方式计费。
framePrefix 字符串 frames存在时,截帧的完整URL为:framePrefix + frame.url
interval 整型 视频截帧间隔,单位为秒,取值范围为[1, 60]。默认值为1秒。
maxFrames 整型 截帧最多张数,取值范围为[5, 200]。默认为200张。
说明 当使用OSS地址(以 oss://开头)作为视频源地址,并且授权内容安全服务访问阿里云MTS服务后,最大可截取20,000张,该方式不会产生额外费用。关于授权内容安全访问阿里云MTS服务的方法,请参考授权访问MTS服务
表 2. frame
名称 类型 是否必需 描述
url 字符串 截帧地址。当framePrefix存在时,完整的截帧地址为:framePrefix + url
offset 整型 该截帧距离片头的时间戳,单位为秒。

结果回调通知参数(callback、seed)

使用说明

如果您在请求参数中指定了回调通知参数callback,被回调callback值,即一个http(s)协议接口的URL,则需要支持POST方法,传输数据编码采用utf-8,并且支持两个表单参数checksumcontent。系统将按以下描述的生成规则和格式设置checksum和content的值,调用您的callback接口返回检测内容。

您服务端接收到我们推送的结果后,返回的HTTP状态码为200时,表示推送成功,其他的HTTP状态码均视为您接收失败,我们将最多重复推送16次。

回调结果参数的生成规则
名称 类型 描述
checksum String 用户uid + seed + content拼成字符串,通过SHA256算法生产。用户UID即账号ID,您可在阿里云控制台上查询。为防篡改,您可以在获取到推送结果时,按此算法生成字符串,与checksum做一次校验。
content String JSON字符串格式,请自行解析反转成JSON对象。content结果格式参见下文。
content结果格式
{
      "code":200,
      "msg":"OK",
      "dataId":"videoId xxx",
      "taskId":"taskId xxx",
      "results":[
        {
          "label":"porn",
          "rate":99.2,
          "scene":"porn",
          "suggestion":"block"
        }
      ]
}

返回参数

返回结果说明,参见返回结果

返回body中的Data字段是JSON数组,每一个元素包含如下字段:

名称 类型 是否必需 描述
taskId 字符串 该检测任务的ID。
dataId 字符串 对应请求的dataId

示例

请求示例
  • 视频截帧图片序列检测
    {
    "scenes":["sface"],
    "tasks":[
      {
        "dataId":"videoId xxx",
        "frames":[
          {
            "offset":10,
            "url":"http://g1.ykimg.com/0B860000586C0A0300038A0460000"
          },
          {
            "offset":20,
            "url":"http://g1.ykimg.com/0B860000586C0A0300038A0460001"
          },
          {
            "offset":30,
            "url":"http://g1.ykimg.com/0B860000586C0A0300038A0460002"
          },
          {
            "offset":40,
            "url":"http://g1.ykimg.com/0B860000586C0A0300038A0460003"
          },
          {
            "offset":50,
            "url":"http://g1.ykimg.com/0B860000586C0A0300038A0460003"
          },
          {
            "offset":60,
            "url":"http://g1.ykimg.com/0B860000586C0A0300038A046000x"
          }
        ]
      }
    ]
    }
  • 普通视频文件检测
    {
      "scenes":["sface"],
      "tasks":[
        {
          "dataId":"videoId xxx",
          "url":"http://www.foo.bak/a.mp4",
          "interval":1,
          "maxFrames":200
        }
      ]
    }
  • 视频直播流检测
    {
      "scenes":["sface"],
      "live":true,
      "tasks":[
        {
          "dataId":"videoId xxx",
          "url":"http://www.foo.bak/a.flv",
          "interval":1,
          "maxFrames":200
        }
      ]
    }
返回示例
{
  "code":200,
  "msg":"OK",
  "requestId":"requestID xxx",
  "data":[
    {
      "dataId":"videoId xxx",
      "taskId":"taskId xxx"
    }
  ]
}

查询视频异步检测结果

描述

业务接口/green/video/results

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

请求参数

关于在请求中必须包含的公共请求参数,请参考公共参数

请求body是一个JSON数组,字段说明如下:
名称 类型 是否必需 描述
body JSON数组 要查询的taskId列表。最大长度不超过100。

返回参数

返回结果说明,参见返回结果

返回body中的Data字段是JSON数组,每一个元素包含如下字段:
名称 类型 是否必需 描述
code 整型 错误码,和HTTP的status code一致。
msg 字符串 错误描述信息。
dataId 字符串 对应请求的dataId
taskId 字符串 该检测任务的ID。
results 数组 返回结果,调用成功时(code=200),返回结果中包含一个或多个元素。每个元素是个结构体,具体结构描述见result
表 3. result
名称 类型 是否必需 描述
scene 字符串 视频检测场景,取值:sface
label 字符串 检测结果的分类,取值:
  • normal:正常视频,不包含敏感人脸
  • sface:包含敏感人脸的视频
suggestion 字符串 建议您执行的操作,取值:
  • pass:视频正常,无需进行其余操作
  • review:检测结果不确定,需要进行人工审核
  • block:视频违规,建议执行进一步操作(如直接删除或做限制处理)
rate 浮点数 结果为该分类的概率,取值范围为[0.00-100.00]。值越高,表示越有可能属于该分类。
frames JSON数组 判断为该分类的一些截帧检测结果(FrameScanResult),截帧检测结果表的具体结构描述见frame
extras JSON对象 附加信息。
sfaceData 数组 识别出来的人脸信息,具体结构描述见sfaceData
表 4. frame
名称 类型 是否必需 描述
url 字符串 截帧地址。
offset 整型 该截帧距离片头的时间戳,单位为秒。
rate 浮点数 结果为该分类的概率,取值范围为[0.00-100.00]。值越高,表示越有可能属于该分类。
表 5. sfaceData
名称 类型 是否必需 描述
x 浮点数 以图片左上角为坐标原点,人脸区域左上角到y轴距离。
y 浮点数 以图片左上角为坐标原点,人脸区域左上角到x轴距离。
w 浮点数 人脸区域宽度。
h 浮点数 人脸区域高度。
age 浮点数 年龄。
smileRate 浮点数 微笑的概率。
gender 字符串 性别。
glasses 布尔 是否戴眼镜。
faces 数组 识别出的人脸信息,具体结构描述见face
表 6. face
名称 类型 是否必需 描述
name 字符串 相似人物的名称。
rate 浮点数 相似概率。
id 字符串 人脸Id。
detail 字符串 人脸附加信息。

示例

请求示例
[
  "taskId xxx"
]
返回示例
{
  "code":200,
  "msg":"OK",
  "requestId":"requestID xxx",
  "data":[
    {
      "code":200,
      "msg":"OK",
      "dataId":"videoId xxx",
      "taskId":"taskId xxx",
      "results":[
        {
          "label":   "sface" ,
           "rate":   97.03 ,
           "scene":   "sface" ,
           "sfaceData":  [
            {
               "age":   52.2 ,
               "faces":  [
                {
                   "detail":   "基地首领" ,
                   "id":   "AliFace_0018177" ,
                   "name":   "奥萨马.本.拉登" ,
                   "rate":   97.03 
                }
              ],
              "gender":   "Male" ,
              "glasses":   false ,
              "h":   467 ,
              "smileRate":   0 ,
              "w":   467 ,
              "x":   444 ,
              "y":   174 ,
              "minority":   false,
              "asian":   false
            },
          "frames":[
            {
              "offset":50,
              "url":"http://g1.ykimg.com/0B860000586C0A0300038A0460003",
              "rate":99.1
            }
          ]
        }
      ]
    }
  ]
}