API功能介绍
图片审核2.0版API用于识别图像中是否有违反网络内容传播相关规定、影响平台内容秩序、影响用户体验的内容或元素,支持40+的内容风险标签和40+风险管控项。通过内容安全的图片审核2.0版,您可以根据业务所处的行业场景规范或平台内容治理规则,基于API返回的丰富的风险标签和置信分,对具体图片内容制定进一步的审核或治理措施。更多介绍,请参见图片审核2.0版介绍及计费说明。
接入指引
-
注册阿里云账号:立即注册,按照操作提示完成账号注册。
-
创建AccessKey:请确保您已通过RAM创建AccessKey,如果您使用的是子账号AccessKey,您需要通过主账号给子账号赋予AliyunYundunGreenWebFullAccess权限,具体操作,请参见RAM授权。
-
开发接入:推荐使用SDK方式调用,具体方法请详见图片审核2.0版SDK及接入指南。
使用说明
您可以调用该接口创建图片内容检测任务。关于如何构造HTTP请求,请参见HTTP原生调用;您也可以直接选用已构造好的HTTP请求,更多信息,请参见接入指南。
-
业务接口:ImageModeration
-
支持的地域及接入地址:
地域
外网接入地址
内网接入地址
支持服务
新加坡
green-cip.ap-southeast-1.aliyuncs.com
green-cip-vpc.ap-southeast-1.aliyuncs.com
postImageCheckByVL_global、baselineCheck_global、aigcDetector_global、faceDetect_global、faceDetect_pro_global
英国(伦敦)
green-cip.eu-west-1.aliyuncs.com
暂无
美国(弗吉尼亚)
green-cip.us-east-1.aliyuncs.com
green-cip-vpc.us-east-1.aliyuncs.com
baselineCheck_global、aigcDetector_global
美国(硅谷)
green-cip.us-west-1.aliyuncs.com
暂无
德国(法兰克福)
green-cip.eu-central-1.aliyuncs.com
green-cip-vpc.eu-central-1.aliyuncs.com
说明英国(伦敦)的配置复用新加坡区域控制台配置;美国(硅谷)的配置复用美国(弗吉尼亚)区域控制台配置。
-
计费信息:
该接口为收费接口。仅对HTTP状态码为200的请求进行计量计费,产生其他错误码时不会计费。关于计费方式,请参见计费说明。
-
图片要求:
-
图片支持以下格式:PNG、JPG、JPEG、BMP、WEBP、TIFF、SVG、AVIF、HEIF(该格式最长边需小于8192 px)、GIF(取第一帧)、ICO(取最后一图)。
-
图片大小限制在20 MB以内,高或者宽不能超过30,000 px,且总像素不能超过2.5亿 px。像素建议大于200*200(px),像素过低会影响内容安全检测算法的效果。
-
图片下载时间限制为3秒内,如果下载时间超过3秒,返回下载超时。
-
QPS限制
本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。如果您业务量级较大或者有紧急扩容需求需要更大QPS,请联系您的商务经理。
调试
在接入前,您也可以通过阿里云OpenAPI在线调试图片审核2.0版的接口,查看调用示例代码及SDK依赖信息,方便概览接口的使用方法和参数。
在线调试能力是基于当前登录账号调用内容安全的API接口,因此调用量会计入账号的收费用量中。
请求参数
关于在请求中必须包含的公共请求参数,请参考公共参数。
请求body是一个JSON结构体,包含以下字段:
|
名称 |
类型 |
是否必选 |
示例值 |
描述 |
|
Service |
String |
是 |
baselineCheck_global |
图片检测2.0版支持的检测服务。取值:
说明
不同服务区别请参考服务说明。AIGC专用服务请参考AIGC场景检测服务。出海版只能在海外区域使用。 |
|
ServiceParameters |
JSONString |
是 |
内容检测对象的相关参数集。JSON字符串格式,关于每个字符串的描述,请参见ServiceParameters。 |
表 1. ServiceParameters
|
名称 |
类型 |
是否必选 |
示例值 |
描述 |
|
imageUrl |
String |
是。图片审核增强版支持三种方式传入图片,请您选择其中一种:
|
https://img.alicdn.com/tfs/TB1U4r9AeH2gK0jSZJnXXaT1FXa-2880-480.png |
待检测对象的URL,请确保该URL能通过公网访问到,且URL地址长度不超过2048个字符。 说明
|
|
ossBucketName |
String |
bucket_01 |
已授权OSS空间的Bucket名。 说明
使用OSS图片内网地址时必须先使用阿里云账号(即主账号)访问云资源访问授权页面进行AliyunCIPScanOSSRole的授权。 |
|
|
ossObjectName |
String |
2022023/04/24/test.jpg |
已授权OSS空间的文件名。 说明
1、传入OSS的原始文件名,不支持再添加图片参数处理,如需增加图片处理参数请使用imageUrl地址。 2、文件名称有中文或空格按照原始传入,不需要做URL编码。 |
|
|
ossRegionId |
String |
cn-beijing |
OSS Bucket所在区域。 |
|
|
dataId |
String |
否 |
img123**** |
检测对象对应的数据ID。 由大小写英文字母、数字、下划线(_)、短划线(-)、英文句号(.)组成,不超过64个字符,可以用于唯一标识您的业务数据。 |
|
referer |
String |
否 |
www.aliyun.com |
referer请求头,用于防盗链等场景。长度不超过256个字符。 |
|
infoType |
String |
是 |
customImage,textInImage |
需要获取的辅助信息内容,取值:
支持指定多个内容,以英文逗号分隔。例如, “customImage,textInImage”表示同时返回自定义图库和图片中文字信息。 说明
人物信息、标识标志信息支持在审核类型为图片审核高级的Service中返回。更多信息,请参考Service说明。 |
返回数据
|
名称 |
类型 |
示例值 |
描述 |
|
RequestId |
String |
70ED13B0-BC22-576D-9CCF-1CC12FEAC477 |
本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。 |
|
Data |
Object |
图片内容检测结果。更多信息,请参见Data。 |
|
|
Code |
Integer |
200 |
状态码。更多信息,请参见Code说明。 |
|
Msg |
String |
OK |
本次请求的响应消息。 |
表 2. Data
|
名称 |
类型 |
示例值 |
描述 |
|
Result |
Array |
图片检测的风险标签、置信分等参数结果。更多信息,请参见result。 |
|
|
RiskLevel |
String |
high |
图片风险等级,根据最高风险的标签返回,返回值包括:
说明
高风险内容建议直接处置;中风险内容建议人工复查;低风险内容建议在高召回需求时再做处理,日常建议和未检测到风险做相同处理。风险分值可以在内容安全控制台配置。 |
|
DataId |
String |
img123****** |
检测对象对应的数据ID。 说明
如果在检测请求参数中传入了dataId,则此处返回对应的dataId。 |
|
Ext |
Object |
图片辅助参考信息。更多信息,请参见辅助信息。 |
表 3. result
|
名称 |
类型 |
示例值 |
描述 |
|
Label |
String |
violent_explosion |
图片内容检测运算后返回的标签。同一张图片可能会检出多个标签和分值。支持的标签,请参见: 说明
审核大模型版服务标签请参考审核大模型服务风险标签释义表。 |
|
Confidence |
Float |
81.22 |
置信分值,0到100分,保留到小数点后2位。部分标签无置信分,更多信息,请参见风险标签释义表。 |
|
Description |
String |
烟火类内容 |
对Labal字段的说明。 重要
该字段为Label字段的解释说明,可能会变更调整,实际处理结果时建议处理Label字段,不要基于该字段进行结果处置。 |
|
RiskLevel |
String |
high |
当前标签的风险等级,根据设置的高低风险分返回,返回值包括:
|
示例
请求示例
{
"Service": "baselineCheck_global",
"ServiceParameters": {
"imageUrl": "https://img.alicdn.com/tfs/TB1U4r9AeH2gK0jSZJnXXaT1FXa-2880-480.png",
"dataId": "img123****"
}
}
返回示例
-
系统检测到风险内容时,返回示例:
{ "Msg": "OK", "Code": 200, "Data": { "DataId": "img123****", "Result": [ { "Label": "pornographic_adultContent", "Confidence": 81, "Description": "成人色情" }, { "Label": "sexual_partialNudity", "Confidence": 98, "Description": "肢体裸露或性感" }, { "Label": "violent_explosion", "Confidence": 70, "Description": "烟火类内容" }, { "Label": "violent_explosion_lib", "Confidence": 81, "Description": "烟火类内容_命中自定义库" } ], "RiskLevel": "high" }, "RequestId": "ABCD1234-1234-1234-1234-1234XYZ" } -
当系统没有检测到风险内容时,返回示例:
{ "Msg": "OK", "Code": 200, "Data": { "DataId": "img123****", "Result": [ { "Label": "nonLabel", "Description": "未检测出风险" } ], "RiskLevel": "none" }, "RequestId": "ABCD1234-1234-1234-1234-1234XYZ" }
-
系统检测到您传入的图片命中了您配置的免审图库时,返回示例:
{ "Msg": "OK", "Code": 200, "Data": { "DataId": "img123****", "Result": [ { "Label": "nonLabel_lib", "Confidence": 83, "Description": "命中免审图库" } ], "RiskLevel": "none" }, "RequestId": "ABCD1234-1234-1234-1234-1234XYZ" } -
文档中的请求示例和返回示例为了便于阅读,做了格式化处理,实际返回结果是没有进行换行、缩进等处理。
风险标签释义表
以下是风险标签值、对应的分值区间以及对应的含义。每个风险标签均可以在控制台进行开关配置,部分风险标签会提供更细分检测范围的开关配置。具体操作,请参见控制台操作指南。各图片服务支持标签如下:
|
场景 |
服务及标签 |
|
通用场景 |
|
|
AIGC场景 |
无风险或者命中免审图库时返回标签参考无风险或者命中免审图库时支持标签。
建议您将系统返回的风险标签和置信分做一定周期的数据存储,以便于在后续内容治理时参考,可根据风险标签设定人工审核或标注的优先级、分层分类的内容治理措施。
表 4. 通用基线检测(baselineCheck_global)支持标签
|
标签值(label) |
置信分区间(confidence) |
中文含义 |
|
pornographic_adultContent |
0~100分,分数越高置信度越高 |
画面疑似含有成人色情内容。 |
|
pornographic_cartoon |
0~100分,分数越高置信度越高 |
画面疑似含有卡通色情内容。 |
|
pornographic_adultToys |
0~100分,分数越高置信度越高 |
画面疑似含有成人器具内容。 |
|
pornographic_art |
0~100分,分数越高置信度越高 |
画面疑似含有艺术品色情内容。 |
|
pornographic_adultContent_tii |
0~100分,分数越高置信度越高 |
图中文字含色情内容。 |
|
pornographic_suggestive_tii |
0~100分,分数越高置信度越高 |
图中文字含低俗内容。 |
|
pornographic_o_tii |
0~100分,分数越高置信度越高 |
图中文字含特殊类内容。更多信息,请参见内容安全控制台。 |
|
pornographic_organs_tii |
0~100分,分数越高置信度越高 |
图中文字含性器官描述内容。 |
|
pornographic_adultToys_tii |
0~100分,分数越高置信度越高 |
图中文字含成人玩具类内容。 |
|
sexual_suggestiveContent |
0~100分,分数越高置信度越高 |
疑似含有疑似低俗或性暗示内容。 |
|
sexual_femaleUnderwear |
0~100分,分数越高置信度越高 |
画面疑似含有内衣泳衣内容。 |
|
sexual_cleavage |
0~100分,分数越高置信度越高 |
画面疑似含有女性乳沟特征。 |
|
sexual_maleTopless |
0~100分,分数越高置信度越高 |
画面疑似含有男性赤膊内容。 |
|
sexual_cartoon |
0~100分,分数越高置信度越高 |
疑似含有动漫类性感内容。 |
|
sexual_shoulder |
0~100分,分数越高置信度越高 |
画面疑似含有肩部性感内容。 |
|
sexual_femaleLeg |
0~100分,分数越高置信度越高 |
画面疑似含有腿部性感内容。 |
|
sexual_pregnancy |
0~100分,分数越高置信度越高 |
画面疑似含有孕照哺乳内容。 |
|
sexual_feet |
0~100分,分数越高置信度越高 |
画面疑似含有脚部性感内容。 |
|
sexual_kiss |
0~100分,分数越高置信度越高 |
画面疑似含有亲吻内容。 |
|
sexual_intimacy |
0~100分,分数越高置信度越高 |
画面疑似含有亲密行为内容。 |
|
sexual_intimacyCartoon |
0~100分,分数越高置信度越高 |
画面疑似含有卡通动漫亲密动作。 |
|
violent_explosion |
0~100分,分数越高置信度越高 |
疑似含有烟火类内容元素。更多信息,请参见内容安全控制台。 |
|
violent_burning |
0~100分,分数越高置信度越高 |
画面疑似包含燃烧内容。 |
|
violent_armedForces |
0~100分,分数越高置信度越高 |
画面疑似包含暴恐组织。 |
|
violent_weapon |
0~100分,分数越高置信度越高 |
画面疑似包含军器装备。 |
|
violent_crowding |
0~100分,分数越高置信度越高 |
画面疑似有人群聚集。 |
|
violent_gun |
0~100分,分数越高置信度越高 |
画面疑似包含枪支。 |
|
violent_knives |
0~100分,分数越高置信度越高 |
画面疑似包含刀具。 |
|
violent_horrific |
0~100分,分数越高置信度越高 |
画面疑似包含惊悚内容。 |
|
violent_nazi |
0~100分,分数越高置信度越高 |
画面疑似包含纳粹内容。 |
|
violent_bloody |
0~100分,分数越高置信度越高 |
画面疑似包含血腥内容。 |
|
violent_extremistGroups_tii |
0~100分,分数越高置信度越高 |
图中文字含暴恐组织内容。 |
|
violent_extremistIncident_tii |
0~100分,分数越高置信度越高 |
图中文字含暴恐事件内容。 |
|
violence_weapons_tii |
0~100分,分数越高置信度越高 |
图中文字含枪支刀具的描述。 |
|
violent_ACU |
0~100分,分数越高置信度越高 |
画面疑似包含作战服。 |
|
contraband_drug |
0~100分,分数越高置信度越高 |
画面含有疑似毒品内容。 |
|
contraband_drug_tii |
0~100分,分数越高置信度越高 |
图中文字疑似描述违禁毒品。 |
|
contraband_gamble |
0~100分,分数越高置信度越高 |
画面疑似含有赌博内容。 |
|
contraband_gamble_tii |
0~100分,分数越高置信度越高 |
图中文字疑似描述赌博行为。 |
|
inappropriate_smoking |
0~100分,分数越高置信度越高 |
画面疑似含有烟相关内容。 |
|
inappropriate_drinking |
0~100分,分数越高置信度越高 |
画面疑似含有酒相关内容。 |
|
inappropriate_tattoo |
0~100分,分数越高置信度越高 |
画面疑似含有纹身内容。 |
|
inappropriate_middleFinger |
0~100分,分数越高置信度越高 |
画面疑似含有竖中指内容。 |
|
inappropriate_foodWasting |
0~100分,分数越高置信度越高 |
画面疑似含有浪费粮食内容。 |
|
profanity_Offensive_tii |
0~100分,分数越高置信度越高 |
图中文字疑似含有较严重辱骂,言语攻击/冒犯等内容。 |
|
profanity_Oral_tii |
0~100分,分数越高置信度越高 |
图中文字疑似含有口头语性质的辱骂。 |
|
religion_clothing |
0~100分,分数越高置信度越高 |
画面疑似含有特殊标识和元素。更多信息,请参见内容安全控制台。 |
|
religion_logo |
0~100分,分数越高置信度越高 |
|
|
religion_flag |
0~100分,分数越高置信度越高 |
|
|
religion_taboo1_tii |
0~100分,分数越高置信度越高 |
图中文字含禁忌类内容。更多信息,请参见内容安全控制台。 |
|
religion_taboo2_tii |
0~100分,分数越高置信度越高 |
|
|
flag_country |
0~100分,分数越高置信度越高 |
画面疑似含有旗帜相关内容。 |
|
political_historicalNihility |
0~100分,分数越高置信度越高 |
图中含特定内容。更多信息,请参见内容安全控制台。 |
|
political_historicalNihility_tii |
0~100分,分数越高置信度越高 |
|
|
political_politicalFigure_1 |
0~100分,分数越高置信度越高 |
|
|
political_politicalFigure_2 |
0~100分,分数越高置信度越高 |
|
|
political_politicalFigure_3 |
0~100分,分数越高置信度越高 |
|
|
political_politicalFigure_4 |
0~100分,分数越高置信度越高 |
|
|
political_politicalFigure_name_tii |
0~100分,分数越高置信度越高 |
|
|
political_prohibitedPerson_1 |
0~100分,分数越高置信度越高 |
|
|
political_prohibitedPerson_2 |
0~100分,分数越高置信度越高 |
|
|
political_prohibitedPerson_tii |
0~100分,分数越高置信度越高 |
|
|
political_taintedCelebrity |
0~100分,分数越高置信度越高 |
|
|
political_taintedCelebrity_tii |
0~100分,分数越高置信度越高 |
|
|
political_CNFlag |
0~100分,分数越高置信度越高 |
|
|
political_CNMap |
0~100分,分数越高置信度越高 |
|
|
political_logo |
0~100分,分数越高置信度越高 |
|
|
political_outfit |
0~100分,分数越高置信度越高 |
|
|
political_badge |
0~100分,分数越高置信度越高 |
|
|
pt_logo |
0~100分,分数越高置信度越高 |
画面疑似含有LOGO内容。 |
|
QRCode |
0~100分,分数越高置信度越高 |
画面疑似含有二维码内容。 |
|
pt_custom_01 |
0~100分,分数越高置信度越高 |
自定义标签01。 |
|
pt_custom_02 |
0~100分,分数越高置信度越高 |
自定义标签02。 |
tii为text in image的缩写,结尾为tii的标签代表命中了图片中的文字违规内容。
此外,上述每个风险标签也支持配置自定义图库实现,如检测的图片与自定义图库中的图片相似度高,则系统会返回对应的风险标签。为了便于区分,标签值(label)格式为原风险标签值_lib。例如,您对“violent_explosion”配置了自定义图库,当检测的图片匹配到自定义图库中的任一一张图片且相似度较高,系统会在label参数中返回violent_explosion_lib,对应的 confidence参数会以分值的形式代表相似程度。
Code说明
以下为接口返回code的含义说明,系统仅对code返回为200的请求计量计费,其他code不会计费。
|
Code |
说明 |
|
200 |
请求正常。 |
|
400 |
请求参数为空。 |
|
401 |
请求参数错误。 |
|
402 |
请求参数长度不符合接口规定,请检查并修改。 |
|
403 |
请求超过QPS限制,请检查并调整并发。 |
|
404 |
传入的图片下载遇到错误或超时,请检查或重试。 |
|
405 |
传入的图片下载超时,可能是因为图片无法访问,请检查调整后重试。 |
|
406 |
传入的图片过大,请检查调整图片大小后再重试。 |
|
407 |
传入的图片格式暂不支持,请检查调整后重试。 |
|
408 |
该账号无权限调用该接口,可能是账号未开通或者已欠费,或者调用账号未被授权访问。 |
|
500 |
系统异常。 |