ScanImage用于检测图片中的违规内容,实时返回检测结果。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ScanImage

系统规定参数。取值:ScanImage。

Scene.N RepeatList porn

指定图片检测的应用场景,可选值包括:

  • porn:图片智能鉴黄
  • terrorism:图片暴恐涉政识别
  • ad:图文违规识别
  • live:图片不良场景识别
  • logo:图片logo识别
说明 支持多场景(scenes)一起检测。例如,使用scenes=[“porn”, “terrorism”],对一张图片同时进行鉴黄和暴恐识别,计费时也将按照两个场景计费。
Task.N.ImageURL String http://xxx.xxx.com/xxx.jpg

待检测图像的URL。支持HTTP和HTTPS协议。

Task.N.DataId String uuid-xxxx-xxxx-1234

数据ID。需要保证在一次请求中所有的ID不重复。

Task.N.ImageTimeMillisecond Long 1

图片创建/编辑时间,单位为ms。

Task.N.Interval Integer 1

截帧频率,GIF图/长图检测专用。GIF图可理解为图片数组,每interval张图片抽取一张进行检测。只有该值存在时,才会对GIF进行截帧。长图同时支持长竖图和长横图。

  • 长竖图(高大于400像素,高宽比大于2.5),会按照(高:宽)取整来计算总图数,并进行切割。
  • 长横图(宽大于400像素,宽高比大于2.5),会按照(宽:高)取整来计算总图数,并进行切割。
说明 默认只会检测GIF图/长图的第一帧,interval参数用于指示后台在检测时可按照该间隔跳着检测,以节省检测成本。需要与maxFrames参数组合使用。例如,设置interval为2,maxFrames为100,检测长图/GIF图时,将每间隔1帧检测一次,最多检测100帧,计费则按照实际检测的数量计算。
Task.N.MaxFrames Integer 1

最大截帧数量,GIF图/长图检测专用,默认值为1。

当interval*maxFrames小于该图片所包含的图片数量时,截帧间隔会自动修改为该图片所包含的图片数/maxFrames,以提高整体检测效果。

说明 最多指定10个检测对象,即对10张图片进行检测。

返回数据

名称 类型 示例值 描述
RequestId String 69B41AE8-1234-1234-1234-12D395695D2D

当前请求的request id。

Data Struct

返回的数据内容。

Results Array

图片检测结果。

DataId String uuid-xxxx-xxx-1234

数据ID。

TaskId String img4wlJcb7p4wH4lAP3111111-123456

任务ID。

ImageURL String http://xxx.xxx.xxx/xxx.jpg

图像URL地址。

SubResults Array

单张图片的检测结果。

Label String normal

检测结果的分类,与具体的scene对应。取值范围参见scene和label说明。

Suggestion String block

建议您执行的操作。

  • pass:图片正常,无需进行其余操作;或者未识别出目标对象。
  • review:检测结果不确定,需要进行人工审核;或者识别出目标对象。
  • block:图片违规,建议执行进一步操作(如直接删除或做限制处理)。
Rate Float 99.91

结果为该分类的概率,取值范围为0~100。值越高,表示越有可能属于该分类。

Scene String ad

图片检测场景,和调用请求中的场景(scenes)对应。

Frames Array

如果待检测图片因为过长被截断,该参数返回截断后的每一帧图像的临时访问地址供您参考。

Rate Float 89.85

结果为该分类的概率,取值范围为0~100。值越高,表示越有可能属于该分类。

URL String http://xxx.xxx.com/xxx-0.jpg

被截断的图片的临时访问url,地址有效期是5分钟。

HintWordsInfoList Array

图片中含有广告时,返回图片中广告文字命中的风险关键词信息。格式为数组。

说明 仅适用于ad场景。示例值:”hintWordsInfo”:[{“context”:”敏感词”}]
Context String abc

图片中文字命中的风险关键词内容。

ProgramCodeDataList Array

图片中含有小程序码时,返回小程序码的位置信息。

说明 仅适用于qrcode场景,且已通过工单联系我们开通了小程序码识别。
X Float 11.0

以图片左上角为坐标原点,小程序码区域左上角到y轴距离。

Y Float 0.0

以图片左上角为坐标原点,小程序码区域左上角到x轴距离。

Width Float 402.0

小程序码区域宽度。

Height Float 413.0

小程序码区域高度。

LogoDataList Array

图片中含有Logo时,返回识别出来的Logo信息。

说明 仅适用于Logo场景。
Type String TV

识别出的logo类型,取值为TV(台标)。

Name String abc

识别出的Logo名称。

X Float 140

以图片左上角为坐标原点,Logo区域左上角到y轴距离。

Y Float 68

以图片左上角为坐标原点,Logo区域左上角到x轴距离。

Width Float 106

Logo区域宽度。

Height Float 106

Logo区域高度。

SfaceDataList Array

图片中包含暴恐识涉政内容时,返回识别出来的暴恐涉政信息。

说明 仅适用于terrorism和sface场景。关于该参数在sface场景中的具体内容,请参见敏感人脸检测。
X Float 49

以图片左上角为坐标原点,人脸区域左上角到y轴距离。

Y Float 39

以图片左上角为坐标原点,人脸区域左上角到x轴距离。

Width Float 97

人脸区域宽度。

Height Float 131

人脸区域高度。

Faces Array

识别出的人脸信息。

Name String abc

相似人物的名称。

Rate Float 91.54

相似概率。

Id String AliFace_0001234

人脸ID。

OCRDataList List abc

识别到的图片中的完整文字信息。

说明 默认不返回,如需返回请通过工单联系我们。

示例

请求示例

{
  "scenes": ["porn", "terrorism", "ad", "live", "logo"],
  "tasks": [
    {
      "dataId": "uuid-xxxx-xxxx-1234",
      "imageURL": "http://xxx.xxx.com/xxx.jpg"
    }
  ]
}

正常返回示例

JSON 格式

{
  "Data": {
    "Results": [
      {
        "Code":200,
        "Message":"OK",
        "DataId": "uuid-xxxx-xxx-1234",
        "SubResults": [
          {
            "Rate": 99.63,
            "Suggestion": "block",
            "Label": "sexy",
            "Scene": "porn"
          },
          {
            "Label": "politics",
            "Rate": 91.54,
            "Scene": "terrorism",
            "SfaceDataList": [
              {
                "Faces": [
                  {
                    "Id": "AliFace_0001234",
                    "Name": "命中人名",
                    "Rate": 91.54
                  }
                ],
                "Height": 131,
                "Width": 97,
                "X": 49,
                "y": 39
              }
            ],
            "Suggestion": "block"
          },
          {
            "ProgramCodeDataList": [
              {
                "Width": 402.0,
                "Height": 413.0,
                "X": 11.0,
                "y": 0.0
              }
            ],
            "Frames": [
              {
                "Rate": 89.85,
                "URL": "http://xxx.xxx.com/xxx-0.jpg"
              },
              {
                "Rate": 68.06,
                "URL": "http://xxx.xxx.com/xxx-1.jpg"
              }
            ],
            "Rate": 99.91,
            "Suggestion": "block",
            "Label": "ad",
            "Scene": "ad"
          },
          {
            "Rate": 99.91,
            "Suggestion": "block",
            "Label": "drug",
            "Scene": "live"
          },
          {
            "LogoDataList": [
              {
                "Name": "xxx台",
                "Type": "TV",
                "X": 140,
                "y": 68,
                "Width": 106,
                "Height": 106
              }
            ],
            "Rate": 99.9,
            "Suggestion": "block",
            "Label": "TV",
            "Scene": "logo"
          }
        ],
        "TaskId": "img4wlJcb7p4wH4lAP3111111-123456",
        "ImageURL": "http://xxx.xxx.xxx/xxx.jpg"
      }
    ]
  },
  "RequestId": "69B41AE8-1234-1234-1234-12D395695D2D"
}

错误码

具体请参见常见错误码