文档

ImAudit - 提交图文审核作业

进行图片、文本内容审核,审核结果同步返回。

接口说明

  • 本接口审核完成后审核结果同步返回。
  • 图文审核功能,目前开通的地域为华北 2(北京)、华东 2(上海)、亚太东南 1(新加坡),其他地域暂不支持。

QPS 限制

本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
Imagesstring

图片 URL 的 JSON 数组,默认最多处理 5 张。可以通过 MPS 控制台 > 媒体管理 > 媒体列表获取。图片和文本至少填写一个。待审核图片文件需要符合下述限制,否则可能导致任务失败:

  • 图片大小不超过 20 MB,高度或宽度不超过 30000px,且图片总像素不超过 2.5 亿 px。

  • (建议)图片像素不低于 256×256px,像素过低可能会影响审核效果。

["http://127.66.**.**/image.jpeg","http://127.66.**.**/photo.jpeg"]
Contentsstring

文本 JSON 数组,用户自定义数组,默认最多处理 5 段文本,每段文本最长 10,000 个字符(包含标点)。图片和文本至少填写一个。

["你好呀","你是谁","我在哪里"]
Scenesstring

场景说明,用于指定审核场景。支持指定多个场景,用半角逗号(,)分隔。例如,{"porn","terrorism"}表示对图片同时进行智能鉴黄和暴恐涉政检测。取值:

  • porn:图片智能鉴黄。

  • terrorism:图片暴恐涉政。

  • ad:图文违规。

  • qrcode:图片二维码。

  • live:图片不良场景。

  • logo:图片 logo。

  • antispam:文本反垃圾(仅对文本生效)。

["porn","terrorism","ad"]
BizTypestring

默认为公共配置。

139440480445****

返回参数

名称类型描述示例值
object

返回参数。

TextQuotaExceedboolean

文本审核 QPS 是否超过限制,取值:true(超过)、false(不超过)。默认文本审核的 QPS 是 5。

false
ImageQuotaExceedboolean

图片审核 QPS 是否超过限制。取值:true(超过)、false(不超过)。默认图片审核 QPS 是 5。

false
RequestIdstring

请求 ID。

5210DBB0-E327-4D45-ADBC-0B83C8793421
ImageResultsobject

图片审核返回结果。调用成功是(code=200),返回结果中包含一个或多个元素。参数详情请参见图文审核接口返回数据

resultobject []

图片审核结果。

codelong

错误码,和 HTTP 状态码一致。如果执行成功则此参数不返回。

200
dataIdstring

检测对象对应的数据 ID。

说明 如果在检测请求参数中传入了 dataId,则此处返回对应的 dataId。
uuid-1234-1234-1234
extrasobject

额外附加信息。图文违规(ad)场景中,该参数可能返回以下内容。 hitLibInfo:如果图片中的文字命中了自定义文本库,则返回命中的文本库信息。格式为数组,更多结构描述请参见 hitLibInfo

{"hitLibInfo":[{"context":"检测视频","libCode":"1234567","libName":"相似文本库a"}]}
msgstring

请求信息的响应信息。

ok
resultsobject []

返回结果。调用成功时,返回结果中包含一个或多个元素。每个元素是一个结构体。

Labelstring

检测结果的分类。不同检测场景的结果分类不同,具体如下:

  • 图片智能鉴黄(porn)结果分类:

    • normal:正常。

    • sexy:性感。

    • porn:色情。

  • 图片暴恐涉政(terrorism)结果分类:

    • normal:正常。

    • bloody:血腥。

    • explosion:爆炸烟光。

    • outfit:特殊装束。

    • logo:特殊标识。

    • weapon:武器。

    • politics:涉政。

    • violence:打斗。

    • crowd:聚众。

    • parade:游行。

    • carcrash:车祸现场。

    • flag:旗帜。

    • location:地标。

    • others:其他。

  • 图文违规(ad)结果分类:

    • normal:正常。

    • ad:其他广告。

    • politics:文字含涉政内容。

    • porn:文字含涉黄内容。

    • abuse:文字含辱骂内容。

    • terrorism:文字含暴恐内容。

    • contraband:文字含违禁内容。

    • spam:文字含其他垃圾内容。

    • npx:牛皮癣广告。

    • qrcode:含二维码。

    • programCode:含小程序码。

  • 图片二维码(qrcode)结果分类:

    • normal:正常。

    • qrcode:含二维码。

    • programCode:含小程序码。

  • 图片不良场景(live)结果分类:

    • normal:正常。

    • meaningless:图片中无内容(例如,黑屏、白屏)。

    • PIP:画中画。

    • smoking:吸烟。

    • drivelive:车内直播。

  • 图片 logo(logo)结果分类:

    • normal:正常。

    • TV:含受管控的 logo。

    • trademark:含商标。

sexy
Ratedouble

置信度分数,取值范围:0(表示置信度最低)~100(表示置信度最高)。如果 suggestion 为 pass,则置信度越高,表示内容正常的可能性越高;如果 suggestion 为 review 或 block,则置信度越低,表示内容违规的可能性越高。

说明 该值仅作为参考,强烈建议您不要在业务中使用。建议您参考 suggestion 和 label(或者部分接口返回的 sublabel)结果用于内容违规判定。
91.54
Scenestring

图片检测场景。可取值:

  • porn:图片智能鉴黄。

  • terrorism:图片暴恐涉政。

  • ad:图文违规。

  • qrcode:图片二维码。

  • live:图片不良场景。

  • logo:图片 logo。

porn
Suggestionstring

建议您执行的后续操作。可取值:

  • pass:结果正常,无需进行其余操作。

  • review:结果不确定,需要进行人工审核。

  • block:结果违规,建议直接删除或者限制公开。

block
hintWordsInfoobject []

图片中含有广告或文字违规信息时,返回图片中广告文字命中的风险关键词信息。

contextstring

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

敏感词
qrcodeDataarray

图片中含有二维码时,返回图片中所有二维码包含的文本信息。

string

二维码包含的文本信息。

"http://example.com/01ZZOliO"
qrcodeLocationsobject []

返回图片中识别到的二维码的坐标信息。

xfloat

以图片左上角为坐标原点,二维码区域左上角到 y 轴距离,单位:像素。

11
yfloat

以图片左上角为坐标原点,二维码区域左上角到 x 轴距离,单位:像素。

0
wfloat

二维码区域宽度,单位:像素。

402.0
hfloat

二维码区域高度,单位:像素。

413.0
qrcodestring

识别到的二维码链接。

http://xxx
programCodeDataobject []

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

xfloat

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

11.0
yfloat

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

0.0
wfloat

小程序码区域宽度,单位:像素。

402.0
hfloat

小程序码区域高度,单位:像素。

413.0
logoDataobject []

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

typestring

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

TV
namestring

识别出的 logo 名称。

湖南台
xfloat

以图片左上角为坐标原点,logo 区域左上角到 y 轴距离,单位:像素。

140
yfloat

以图片左上角为坐标原点,logo 区域左上角到 x 轴距离,单位:像素。

68
wfloat

logo 区域宽度,单位:像素。

106
hfloat

logo 区域高度,单位:像素。

106
sfaceDataobject []

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

xfloat

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

49
yfloat

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

39
wfloat

人脸区域宽度,单位:像素。

47
hfloat

人脸区域高度,单位:像素。

121
facesobject []

识别出的人脸信息。

namestring

字符串类型,相似人物的名称。

命中人名
refloat

浮点数类型,置信度分数,取值范围:0(表示置信度最低)~100(表示置信度最高)。置信度越高表示人物识别结果的可信度越高。

91.54
ididstring

字符串类型,人脸 ID。

AliFace_0001234
ocrDataarray

ocrData

string

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

识别结果
framesobject []

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

ratefloat

置信度分数,取值范围:0~100,置信度越高表示检测结果的可信度越高。建议您不要在业务中使用该分数。

89.85
urlstring

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

http://example.com/test-01.jpg
taskIdstring

检测任务的 ID。

img4wlJcb7p4wH4lAP3111111-12****
urlstring

检测对象的 URL。

http://example.com/example-****.jpg
TextResultsobject

文本审核返回结果。调用成功是(code=200),返回结果中包含一个或多个元素。参数详情请参见图文审核接口返回数据

resultobject []

文本审核结果。

codelong

错误码,和 HTTP 状态码一致。更多信息,请参见错误码表

200
contentstring

被检测文本,和调用请求中的待检测文本对应。

这是一段测试文本
dataIdstring

文字的顺序号。

cfd33235-71a4-468b-8137-a5ffe323****
msgstring

请求消息的响应消息。

OK
resultsobject []

返回结果。调用成功时(code=200),返回结果中包含一个或多个元素。每个元素是个结构体。

detailsobject []

命中风险信息,一条文本可能命中多条风险详情。

Labelstring

文本命中风险的分类。取值:

  • spam:含垃圾信息。

  • ad:广告。

  • politics:涉政。

  • terrorism:暴恐。

  • abuse:辱骂。

  • porn:色情。

  • flood:灌水。

  • contraband:违禁。

  • meaningless:无意义。

  • customized:自定义(例如命中自定义关键词)。

porn
contextsobject []

命中该风险的上下文信息。

contextstring

检测文本命中的风险关键词,如果命中了关键词会返回该内容,如果命中了算法模型,则不会返回该字段。

上门服务
positionsarray

如果命中关键词,会返回该词在原始文本中的位置。

string

关键词在原始文本中的位置。

{"startPos":1, "endPos":10}
libNamestring

命中自定义词库时,才会返回当前字段。取值为创建词库时设置的词库名称。

您自定义的词库名称
libCodestring

命中您自定义文本库时,才会返回当前字段。取值为创建风险文本库后系统返回的文本库 code。

123456
ruleTypestring

命中行为规则时,才会返回当前字段。取值:

  • user_id
  • ip
  • umid
  • content
  • similar_content
  • imei
  • imsi
ip
labelstring

文本垃圾检测结果的分类。取值:

  • normal:正常文本。

  • spam:含垃圾信息。

  • ad:广告。

  • politics:涉政。

  • terrorism:暴恐。

  • abuse:辱骂。

  • porn:色情。

  • flood:灌水。

  • contraband:违禁。

  • meaningless:无意义。

  • customized:自定义(例如命中自定义关键词)。

porn
ratedouble

置信度分数,取值范围:0(表示置信度最低)~100(表示置信度最高)。如果 suggestion 为 pass,则置信度越高,表示内容正常的可能性越高;如果 suggestion 为 review 或 block,则置信度越低,表示内容违规的可能性越高。

说明 该值仅作为参考,强烈建议您不要在业务中使用。建议您参考 suggestion 和 label(或者部分接口返回的 sublabel)结果用于内容违规判定。
99.90
scenestring

检测场景。

antispam
suggestionstring

建议您执行的后续操作。取值:

  • pass:文本正常,可以直接放行。

  • review:文本需要进一步人工审核。

  • block:文本违规,可以直接删除或者限制公开。

block
taskIdstring

检测任务的 ID。

txt6HB8NQoEbU@5fosnj2xVEM-1t****

示例

正常返回示例

JSON格式

{
  "TextQuotaExceed": false,
  "ImageQuotaExceed": false,
  "RequestId": "5210DBB0-E327-4D45-ADBC-0B83C8793421",
  "ImageResults": {
    "result": [
      {
        "code": 200,
        "dataId": "uuid-1234-1234-1234",
        "extras": {
          "hitLibInfo": [
            {
              "context": "检测视频",
              "libCode": "1234567",
              "libName": "相似文本库a"
            }
          ]
        },
        "msg": "ok",
        "results": [
          {
            "Label": "sexy",
            "Rate": 91.54,
            "Scene": "porn",
            "Suggestion": "block",
            "hintWordsInfo": [
              {
                "context": "敏感词"
              }
            ],
            "qrcodeData": [
              "\"http://example.com/01ZZOliO\""
            ],
            "qrcodeLocations": [
              {
                "x": 11,
                "y": 0,
                "w": 402,
                "h": 413,
                "qrcode": "http://xxx"
              }
            ],
            "programCodeData": [
              {
                "x": 11,
                "y": 0,
                "w": 402,
                "h": 413
              }
            ],
            "logoData": [
              {
                "type": "TV",
                "name": "湖南台",
                "x": 140,
                "y": 68,
                "w": 106,
                "h": 106
              }
            ],
            "sfaceData": [
              {
                "x": 49,
                "y": 39,
                "w": 47,
                "h": 121,
                "faces": [
                  {
                    "name": "命中人名",
                    "re": 91.54,
                    "idid": "AliFace_0001234"
                  }
                ]
              }
            ],
            "ocrData": [
              "识别结果"
            ],
            "frames": [
              {
                "rate": 89.85,
                "url": "http://example.com/test-01.jpg"
              }
            ]
          }
        ],
        "taskId": "img4wlJcb7p4wH4lAP3111111-12****",
        "url": "http://example.com/example-****.jpg"
      }
    ]
  },
  "TextResults": {
    "result": [
      {
        "code": 200,
        "content": "这是一段测试文本",
        "dataId": "cfd33235-71a4-468b-8137-a5ffe323****",
        "msg": "OK",
        "results": [
          {
            "details": [
              {
                "Label": "porn",
                "contexts": [
                  {
                    "context": "上门服务",
                    "positions": [
                      "{\"startPos\":1, \"endPos\":10}"
                    ],
                    "libName": "您自定义的词库名称",
                    "libCode": "123456",
                    "ruleType": "ip"
                  }
                ]
              }
            ],
            "label": "porn",
            "rate": 99.9,
            "scene": "antispam",
            "suggestion": "block"
          }
        ],
        "taskId": "txt6HB8NQoEbU@5fosnj2xVEM-1t****"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2021-12-07API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2021-11-04OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈