数美智能图片识别产品API接口文档#


版权所有 翻版必究


目录

同步单张上传接口#

同步单条请求#

请求URL:#

集群URL支持产品列表
北京http://api-img-bj.fengkongcloud.com/image/v4图片
上海http://api-img-sh.fengkongcloud.com/image/v4图片
新加坡http://api-img-xjp.fengkongcloud.com/image/v4图片
印度http://api-img-yd.fengkongcloud.com/image/v4图片
硅谷http://api-img-gg.fengkongcloud.com/image/v4图片

请求方法:#

POST

字符编码:#

UTF-8

建议超时时间:#

5s

请求参数:#

放在HTTP Body中,采用Json格式,具体参数如下:

请求参数名类型参数说明传入说明规范
accessKeystring接口认证密钥
用于权限认证,开通账号服务时由数美提供或使用开通邮箱登录数美后台右上角相关文档处查看
必传参数accessKey
appIdstring应用标识,用于区分相同公司的不同应用数据必传参数默认应用值:default
传递其他值时需联系数美服务协助开通
eventIdstring事件标识必传参数需要联系数美服务开通,请使用数美单独提供的传值为准
可选值:
headImage:头像
album:相册
dynamic:动态
article:帖子
comment:评论
roomCover:房间封面
groupMessage:群聊图片
message:私聊图片
product:商品图片
typestring检测的风险类型必传参数监管一级标签
可选值:
POLITICS:涉政识别
VIOLENCE:暴恐识别
BAN:违禁识别
PORN:色情识别
AD:广告识别
OCR:识别图片中所有文字
FACECOMPARE:人脸比对
如果需要多个识别功能,通过下划线连接(该字段与businessType字段必须选择一个传入)
businessTypestring业务标签类型业务一级标签
可选值:
LOGO:商企LOGO识别
OCR:识别图片中所有文字
MINOR:未成年人识别
SCREEN:特殊画面识别
SCENCE:场景画面识别
QR:二维码识别
QUALITY: 图像质量识别
FACE:人脸识别
STAR:公众人物识
PORTRAIT:人像识别
BEAUTY: 颜值识别
ANIMAL: 动物识别
OBJECT:物品识别
IMAGECONTENT: 画面属性识别
FACECOMPARE: 人脸比对
PLANT: 植物
BODY: 人体
如果需要多个识别功能,通过下划线连接,该字段和type必须选择一个传入
datajson_object请求的数据内容必传参数请求的数据内容,最长10MB,详见data参数
callbackstring回调请求url,传callback表示走异步回调逻辑,否则走同步逻辑非必传参数异步回调逻辑支持30M图片
同步支持10M图片

其中,data的内容如下:

请求参数名类型参数说明是否必传规范
tokenIdstring用户账号标识,建议使用贵司用户UID(可加密)自行生成 , 标识用户唯一身份用作灌水和广告等行为维度风控。如无用户uid的场景建议使用唯一的数据标识传值必传参数由数字、字母、下划线、短杠组成的长度小于等于64位的字符串
imgstring要检测的图片,可使用base64编码的图片数据或者图片的url链接 建议图片下载从CDN源站下载,并且源站不能为单点
风险:如果不是从源站下载,可能存在图片下载失败,导致无法审核
必传参数支持格式:
jpgjpegpngwebpgiftifftifheif
建议图片像素不小于256*256, 目前最低支持20*20分辨率的图片,图片大小最大10MB
imgCompareBasestring要检测比对的基准图片,请求参数Type字段包含标签FACECOMPARE时存在
可使用base64编码的图片数据或者图片的url链接
非必传参数支持格式:
jpgjpegpngwebpgiftifftifheif
建议图片像素不小于256*256图片大小最大10MB

基准图暂时不支持长图和动图格式
roomstring直播房间号,高曝光群聊等业务场景建议传入房间号非必传参数仅当event取值为 videoClip 时,可传入该字段
rolestring用户角色非必传参数用户角色,必须在可选范围有效对不同角色可配置不同策略。(默认为USER)
直播领域可取值:
ADMIN:房管
HOST:主播
SYSTEM:系统角色
游戏领域可取值:
ADMIN:管理员
USER:普通用户
ipstringip地址非必传参数发送该图片的用户公网ipv4地址
deviceIdstring数美设备指纹标识非必传参数数美设备指纹生成的设备唯一标识
maxFrameintgif图片的最大截帧数量非必传参数截取gif等动图帧数,最大为20帧,默认为3帧
intervalintgif图片的截帧间隔非必传参数默认值为1,代表每一帧都需要进行检测,服务会自动调整该值以保证完全覆盖全部帧
extrajson_object辅助参数非必传参数用于辅助检测的相关信息,详见extra参数
streamInfojson_object相似帧审核参数非必传参数用于检测相似帧的相关信息,详见streamInfo参数
receiveTokenIdstring接收者的tokenId非必传参数接收者的tokenId,私聊场景必选

data中,streamInfo的内容如下:

参数名称参数类型参数说明是否必返规范
similarDedupbool是否开启相似功能
streamIdstring透传参数唯一标识id similarDedup为true时,必传
timeWindowint透传参数时间窗口,单位秒。similarDedup为true时,必传
frameTimeint透传参数截帧时间,单位ms, similarDedup为true时,必传
riskNumint透传参数相似截帧图片不改变张数 数量范围(1-5),默认为1

data中,extra的内容如下:

参数名称参数类型参数说明是否必返规范
isIgnoreTlsbool辅助参数可选值(默认为false):
true:忽略证书信任
false:校验证书
passThroughjson_object透传参数客户传入透传字段,数美内部不回对该字段进行识别处理,随结果返回给用户,必须为json_object类型
isTokenSeparateint是否区分不同应用下的账号非必传参数是否区分不同应用下的账号,可能取值:
0:不区分
1:区分
默认值为0

同步返回结果#

放在HTTP Body中,采用Json格式,具体参数如下:

参数名称参数类型参数说明是否必返规范
codeint返回码1100:成功
1901:QPS超限
1902:参数不合法
1903:服务失败
1911:图片下载失败
9101:无权限操作
除message和requestId之外的字段,只有当code为1100时才会存在
messagestring返回码描述和code对应:成功QPS超限参数不合法服务失败余额不足无权限操作
requestIdstring请求标识请求唯一标识,用于排查问题和后续效果优化,强烈建议保存
riskLevelstring处置建议可能返回值:
PASS:正常,建议直接放行
REVIEW:可疑,建议人工审核
REJECT:违规,建议直接拦截
riskLabel1string一级风险标签当riskLevel为PASS时返回normal
riskLabel2string二级风险标签当riskLevel为PASS时为空
riskLabel3string三级风险标签当riskLevel为PASS时为空
riskDescriptionstring风险原因当riskLevel为PASS时为正常
riskDetailjson_object风险详情详见riskDetail参数
auxInfojson_object其他辅助信息详见auxInfo参数
allLabelsjson_array风险标签详情返回命中的所有风险标签以及详情信息
businessLabelsjson_array业务标签详情请求参数Type字段包含OCRSCREENSCENCEMINORQRFACEQUALITYFACECOMPARE以上标签时不为空,详见businessLabels参数
tokenLabelsjson_object账号标签信息见下面详情内容,仅在tokenId传入且联系数美开通时返回

其中,riskDetail结构如下:

返回结果参数名参数类型参数说明是否必返规范
facesjson_array返回图片中涉政人物的名称及位置信息
objectsjson_array返回图片中标识或物品的名称及位置信息
ocrTextjson_object返回图片中违规文字相关信息,当请求参数type字段包含OCR时存在
riskSourceint标识资源哪里违规标识风险结果的来源:
1000:无风险
1001:文字风险
1002:视觉图片风险

riskDetail中,faces数组每个元素的内容如下:

返回结果参数名参数类型参数说明是否必返规范
namestring人物名称风险人物名称
locationint_array人物位置信息,该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567]
207代表的是左上角的x坐标
522代表左上角的y坐标
340代表的是右下角的x坐标
567代表的是右下角的y坐标
probabilityfloat置信度,可选值在0~1之间,值越大,可信度越高0~1之间的浮点数

riskDetail中,objects数组每个元素的内容如下:

返回结果参数名参数类型参数说明是否必返规范
namestring标识名称
locationint_array标识位置信息,该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567]
207代表的是左上角的x坐标
522代表左上角的y坐标
340代表的是右下角的x坐标
567代表的是右下角的y坐标
probabilityfloat置信度,可选值在0~1之间,值越大,可信度越高0~1之间的浮点数

riskDetail中,ocrText的内容如下:

返回结果参数名参数类型参数说明是否必返规范
textstring识别出的文字
matchedListsjson_array命中的客户自定义名单列表
riskSegmentsjson_array高风险片段内容,检测图片包含涉政、暴恐、违禁、广告法等风险内容的时候存在

ocrText中,matchedLists数组每个元素的内容如下:

返回结果参数名参数类型参数说明是否必返规范
namestring命中的名单名称
wordsjson_array命中的敏感词信息

matchedLists中,words数组每个元素的内容如下:

返回结果参数名参数类型参数说明是否必返规范
wordstring命中的敏感词
positionint_array敏感词所在位置

ocrText中,riskSegments的每个元素的详细内容如下:

返回结果参数名参数类型参数说明是否必返规范
segmentstring高风险内容片段
positionint_array高风险内容片段所在位置

其中,auxInfo的内容如下:

返回结果参数名参数类型参数说明是否必返规范
segmentsint实际处理的图片数量
typeVersionjson_object针对各个传入type的效果版本号
errorCodeint2001:输入数据格式不对,不是合法的json数据
2002:输入的参数字段不合法(必填字段缺失、类型不对、值不合法等)
2003:图片下载失败
2004:图片过大,超过了10M
2005:非法图片格式
2006:无效风险监测类型
passThroughjson_object客户传入的透传字段
streamIdstring请求参数中传入streamInfo功能时满足相似功能会返回
frameTimeint请求参数中传入streamInfo功能时满足相似功能会返回
qrContentstring返回识别的二维码地址需要联系数美配置返回

auxInfo中,typeVersion的内容如下:

返回结果参数名参数类型参数说明是否必返规范
POLITICSstring涉政版本号组成形式为X.YX为主版本号,一般代表模型整体的效果迭代;Y为子版本号,一般代表日常的例行迭代
例如1001001.2代表主版本号为1001001,子版本号为2
VIOLENCEstring暴恐版本号组成形式同上
BANstring违禁版本号组成形式同上
PORNstring色情版本号组成形式同上
MINORstring未成年人版本号组成形式同上
ADstring广告版本号组成形式同上
SPAMstring灌水版本号组成形式同上
LOGOstring商企LOGO版本号组成形式同上
STARstring公众人物版本号组成形式同上
OCRstringOCR版本号组成形式同上
IMGTEXTstring违规文字版本号组成形式同上
SCREENstring特殊画面版本号组成形式同上
SCENCEstring场景画面版本号组成形式同上
QRstring二维码版本号组成形式同上
FACEstring人脸版本号组成形式同上
QUALITYstring图像质量版本号组成形式同上
PORTRAITstring人像版本号组成形式同上
ANIMALstring动物版本号组成形式同上
BEAUTYstring颜值版本号组成形式同上

其中allLabels数组的每个成员的内容如下:

返回结果参数名参数类型参数说明是否必返规范
riskLabel1string一级风险标签一级风险标签
riskLabel2string二级风险标签二级风险标签
riskLabel3string三级风险标签三级风险标签
riskDescriptionstring风险原因
probabilityfloat置信度,可选值在0~1之间,值越大,可信度越高
riskDetailjson_object风险详情

allLabels每个成员的riskDetail结构如下:

返回结果参数名参数类型参数说明是否必返规范
facesjson_array人物信息,返回图片中涉政人物的名称及位置信息,内容与外层riskDetail.faces格式一致
objectsjson_array标识信息,返回图片中标识或物品的名称及位置信息,内容与外层riskDetail.objects格式一致

其中businessLabels数组的每个成员的内容如下:

返回结果参数名参数类型参数说明是否必返规范
businessLabel1string一级业务标签,当请求参数type字段包含业务标签传值时存在:SCREEN,SCENCE,QR,FACE,QUALITY,MINOR,LOGO,OCR,BEAUTY,FACECOMPARE一级业务标签
businessLabel2string二级业务标签二级业务标签
businessLabel3string三级业务标签三级业务标签
businessDescriptionstring业务标签描述中文标签描述
businessDetailjson_object业务标签详情格式详见下方businessDetail结构
probabilityfloat置信度
可选值在0~1之间,值越大,可信度越高
confidenceLevelint置信等级
可选值在0~2之间,值越大,可信度越高
注意:当检测模型是QR,OCR时不返回
注意:当检测模型是FACE且riskLabe2不等于gender时不返回

businessLabels数组中的businessDetail的内容如下:

返回结果参数名参数类型参数说明是否必返规范
namestring明星人物名称
图片中的明星人名type传值包含FACE时存在
probabilityfloat明星人物置信区间
可选值在0~1之间,值越大,可信度越高,当且仅当name存在时出现
face_ratiofloat人脸占比
在区间0-1,数值越大,人脸占比越高type传值包含FACE时存在
face_numint人脸数检测
图片中检测到的人脸个数
type传值包含FACEFACECOMPARE时存在
face_compare_numint人脸比对人脸数检测
图片中检测到的人脸个数,type传值包含FACECOMPARE时存在
locationint_array标识位置信息
type传值包含OBJECT且时存在,该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567]
207代表的是左上角的x坐标
522代表左上角的y坐标
340代表的是右下角的x坐标
567代表的是右下角的y坐标
person_numint人体数量检测
图片中检测到的人体个数type传值包含PORTRAIT且时存在
person_ratiofloat人像占比
在区间0-1,数值越大,人脸占比越高type传值包含PORTRAIT时存在

tokenLabels的详情内容如下:

返回结果参数名参数类型参数说明规范
machine_account_riskjson_object机器控制相关风险
UGC_account_riskjson_objectUGC内容相关风险
scene_account_riskjson_object场景账号风险特殊场景才可取到,如航司等

machine_account_risk的详情内容如下:

返回结果参数名参数类型参数说明规范
b_machine_control_tokenidint机器账号0:非机器控制账号1:机器控制账号
b_machine_control_tokenid_last_tsint机器账号时间
b_offer_wall_tokenidint积分墙账号0:非积分墙账号1:积分墙账号
b_offer_wall_tokenid_last_tsint积分墙账号时间

UGC_account_risk的详情内容如下:

返回结果参数名参数类型参数说明规范
b_politics_risk_tokenidint涉政风险0:暂未发现涉政风险1:存在涉政风险
b_politics_risk_tokenid_last_tsint涉政风险时间
b_sexy_risk_tokenidint色情风险0:暂未发现色情风险1:存在色情风险
b_sexy_risk_tokenid_last_tsint色情风险时间
b_advertise_risk_tokenidint广告风险0:暂未发现广告风险1:存在广告风险
b_advertise_risk_tokenid_last_tsint广告风险时间

scene_account_risk的详情内容如下:

返回结果参数名参数类型参数说明规范
i_tout_risk_tokenidint航司占座账号0:非航司占座账号1:航司占座账号
i_tout_risk_tokenid_last_tsint航司占座时间

回调的同步返回参数#

返回结果参数名参数类型参数说明是否必返规范
codeint返回码1100:成功
1901:QPS超限
1902:参数不合法
1903:服务失败
9101:无权限操作<r=br>除message和requestId之外的字段,只有当code为1100时才会存在
messagestring返回码描述和code对应:成功QPS超限参数不合法服务失败余额不足无权限操作
requestIdstring请求标识图片的流水号

如果在请求参数中指定了回调协议接口URL callback,则需要支持POST方法,传输编码采用utf-8,审核结果放在HTTP Body中,采用Json格式,具体参数和V4单张同步请求结果相同。

同步单张示例:#

同步请求示例:#

{
"accessKey":"",
"eventId":"",
"type":"",
"data":{
"tokenId":"username123",
"img":""
}
}

同步返回示例:#

{
"requestId":"9l25odfa5280c50f49f7c40988a1e400",
"code":1100,
"message":"成功",
"riskLevel":"PASS",
"riskLabel1":"normal",
"riskLabel2":"",
"riskLabel3":"",
"riskDescription":"正常",
"riskDetail":{
"riskSource":1000
},
"auxInfo":{
"segments":1,
"typeVersion":{
"LOGO":"1001049.11"
}
},
"allLabels":[
{
"probability":0.53285801410675,
"riskDescription":"涉政:国内领导人:国外领导",
"riskDetail":{
},
"riskLabel1":"politics",
"riskLabel2":"lingdaoren",
"riskLabel3":"guowailingdao"
},
{
"probability":0.537527859210968,
"riskDescription":"涉政:涉政:涉政简图",
"riskDetail":{
},
"riskLabel1":"politics",
"riskLabel2":"shezheng",
"riskLabel3":"shezhengjiantu"
},
{
"probability":0.536710560321808,
"riskDescription":"涉政:一号领导:一号领导",
"riskDetail":{
},
"riskLabel1":"politics",
"riskLabel2":"yihaolingdao",
"riskLabel3":"yihaolingdao"
},
{
"probability":0.983799457550049,
"riskDescription":"::",
"riskDetail":{
"objects":[
{
"location":[
595,
459,
645,
671
],
"name":"south_weekend",
"probability":0.983799457550049
}
]
},
"riskLabel1":"business",
"riskLabel2":"logo",
"riskLabel3":"south_weekend"
},
{
"probability":0.53285801410675,
"riskDescription":"涉政:反动分裂:港独人物",
"riskDetail":{
},
"riskLabel1":"politics",
"riskLabel2":"fandongfenlie",
"riskLabel3":"gangdurenwu"
},
{
"probability":0.529117465019226,
"riskDescription":"涉政:反动分裂:异见人士",
"riskDetail":{
},
"riskLabel1":"politics",
"riskLabel2":"fandongfenlie",
"riskLabel3":"yijianrenshi"
},
{
"probability":0.529117465019226,
"riskDescription":"涉政:国内领导人:常委领导",
"riskDetail":{
},
"riskLabel1":"politics",
"riskLabel2":"lingdaoren",
"riskLabel3":"changweilingdao"
}
],
"businessLabels":[
{
"businessDescription":"商企LOGO:商企LOGO:商企LOGO",
"businessDetail":{
"location":[
595,
459,
645,
671
]
},
"businessLabel1":"logo",
"businessLabel2":"south_weekend",
"businessLabel3":"south_weekend",
"confidenceLevel":2,
"probability":0.983799457550049
}
],
"tokenLabels":{
"UGC_account_risk":{
"sexy_risk_tokenid":0
}
}
}

回调的同步返回参数#

{
"code":1100,
"message":"成功",
"requestId":"69dbc1f81dc5c914b1f1b8a267fb9ec1"
}

异步单张上传接口#

异步单条请求#

请求URL:#

集群URL支持产品列表
北京http://api-img-bj.fengkongcloud.com/v4/saas/async/img图片
上海http://api-img-sh.fengkongcloud.com/v4/saas/async/img图片

请求方法:#

POST

字符编码:#

UTF-8

建议超时时间:#

5s

请求参数:#

放在HTTP Body中,采用Json格式,具体参数如下:

请求参数名类型参数说明传入说明规范
accessKeystring接口认证密钥必传参数公司密钥:用于权限认证,开通账号服务时由数美提供或使用开通邮箱登录数美后台右上角相关文档处查看
appIdstring应用标识必传参数应用标识:用于区分相同公司的不同应用数据默认应用值:
default传递其他值时需联系数美服务协助开通
eventIdstring事件标识必传参数需要联系数美服务开通,请使用数美单独提供的传值为准,可选值:
headImage:头像
album:相册
dynamic:动态
article:帖子
comment:评论
roomCover:房间封面
groupMessage:群聊图片
message:私聊图片
product:商品图片
typestring检测的风险类型必传参数请使用数美单独提供的传值为准,可选值:
POLITICS:涉政识别
VIOLENCE:暴恐识别
BAN:违禁识别
PORN:色情识别
AD:广告识别
OCR:识别图片中所有文字
FACECOMPARE:人脸比对
如果需要多个识别功能,通过下划线连接(该字段与businessType字段必须选择一个传入)
businessTypestring业务标签类型业务标签识别类型,可选值:
LOGO:商企LOGO识别
OCR:识别图片中所有文字
MINOR:未成年人识别
SCREEN:特殊画面识别
SCENCE:场景画面识别
QR:二维码识别
QUALITY: 图像质量识别
FACE:人脸识别
STAR:公众人物识
PORTRAIT:人像识别
BEAUTY: 颜值识别
ANIMAL: 动物识别
OBJECT:物品识别
IMAGECONTENT: 画面属性识别
FACECOMPARE: 人脸比对
PLANT: 植物
BODY: 人体
如果需要多个识别功能,通过下划线连接
datajson_object请求的数据内容必传参数请求的数据内容,最长10MB

其中,data的内容如下:

请求参数名类型参数说明是否必传规范
tokenIdstring用户账号标识必传参数建议使用贵司用户UID(可加密)自行生成 , 标识用户唯一身份用作灌水和广告等行为维度风控。如无用户uid的场景建议使用唯一的数据标识传值
imgstring要检测的图片,可使用base64编码的图片数据或者图片的url链接 建议图片下载从CDN源站下载,并且源站不能为单点
风险:如果不是从源站下载,可能存在图片下载失败,导致无法审核
必传参数支持格式:
jpgjpegpngwebpgiftifftifheif
建议图片像素不小于256*256, 目前最低支持20*20分辨率的图片,图片大小最大10MB
imgCompareBasestring要检测比对的基准图片,请求参数Type字段包含标签FACECOMPARE时存在
可使用base64编码的图片数据或者图片的url链接
非必传参数支持格式:
jpgjpegpngwebpgiftifftifheif
建议图片像素不小于256*256图片大小最大10MB

基准图暂时不支持长图和动图格式
roomstring直播房间号非必传参数仅当event取值为 videoClip 时,可传入该字段
rolestring用户角色非必传参数用户角色,必须在可选范围有效对不同角色可配置不同策略。(默认为USER)
直播领域可取值:
ADMIN:房管
HOST:主播
SYSTEM:系统角色
游戏领域可取值:
ADMIN:管理员
USER:普通用户
ipstringip地址非必传参数发送该图片的用户公网ipv4地址
deviceIdstring数美设备指纹标识非必传参数数美设备指纹生成的设备唯一标识
maxFrameintgif图片的最大截帧数量非必传参数截取gif等动图帧数,最大为20帧,默认为3帧
intervalintgif图片的截帧间隔非必传参数默认值为1,代表每一帧都需要进行检测,服务会自动调整该值以保证完全覆盖全部帧
extrajson_object辅助参数非必传参数用于辅助检测的相关信息
receiveTokenIdstring接收者的tokenId非必传参数接收者的tokenId,私聊场景必选

其中,extra内容如下:

参数名称参数类型参数说明是否必返规范
isIgnoreTlsbool辅助参数可选值(默认为false):
true:忽略证书信任
false:校验证书
passThroughjson_object透传参数客户传入透传字段,数美内部不回对该字段进行识别处理,随结果返回给用户,必须为json_object类型

返回结果#

放在HTTP Body中,采用Json格式,具体参数如下:

参数名称参数类型参数说明是否必返规范
codeint返回码1100:成功
1901:QPS超限
1902:参数不合法
1903:服务失败
1911:图片下载失败
9101:无权限操作
除message和requestId之外的字段,只有当code为1100时才会存在
messagestring返回码描述和code对应:成功QPS超限参数不合法服务失败余额不足无权限操作
requestIdstring请求标识请求唯一标识,用于排查问题和后续效果优化,强烈建议保存

异步单条示例#

异步单条请求示例#

{
"accessKey":"",
"eventId":"",
"type":"",
"data":{
"tokenId":"username123",
"img":""
}
}

异步单条返回示例#

{
"requestId":"9l25odfa5280c50f49f7c40988a1e400",
"code":1100,
"message":"成功"
}

同步批量接口#

同步批量请求参数#

请求URL:#

集群URL支持产品列表
北京http://api-img-bj.fengkongcloud.com/images/v4图片
上海http://api-img-sh.fengkongcloud.com/images/v4图片
新加坡http://api-img-xjp.fengkongcloud.com/images/v4图片
印度http://api-img-yd.fengkongcloud.com/images/v4图片
硅谷http://api-img-gg.fengkongcloud.com/images/v4图片

请求方法:#

POST

字符编码:#

UTF-8

建议超时时间:#

60s

请求参数:#

放在HTTP Body中,采用Json格式,具体参数如下:

请求参数名类型参数说明传入说明规范
accessKeystring接口认证密钥必传参数由数美提供
appIdstring应用标识必传参数用于区分相同公司的不同应用数据
默认应用值:default
传递其他值时需联系数美服务协助开通
eventIdstring事件标识必传参数需要联系数美服务开通,请使用数美单独提供的传值为准,可选值:default:默认
headImage:头像
album:相册
dynamic:动态
article:帖子
comment:评论
roomCover:房间封面
groupMessage:群聊图片
message:私聊图片
product:商品图片
typestring检测的风险类型必传参数请使用数美单独提供的传值为准,可选值:
POLITICS:涉政识别
VIOLENCE:暴恐识别
BAN:违禁识别
PORN:色情识别
AD:广告识别
OCR:识别图片中所有文字
FACECOMPARE:人脸比对
如果需要多个识别功能,通过下划线连接(该字段与businessType字段必须选择一个传入)
businessTypestring业务标签类型业务标签识别类型,可选值:
LOGO:商企LOGO识别
OCR:识别图片中所有文字
MINOR:未成年人识别
SCREEN:特殊画面识别
SCENCE:场景画面识别
QR:二维码识别
QUALITY: 图像质量识别
FACE:人脸识别
STAR:公众人物识
PORTRAIT:人像识别
BEAUTY: 颜值识别
ANIMAL: 动物识别
OBJECT:物品识别
IMAGECONTENT: 画面属性识别
FACECOMPARE: 人脸比对
PLANT: 植物
BODY: 人体
如果需要多个识别功能,通过下划线连接,该字段和type必须选择一个传入
datajson_object请求数据内容必传参数请求的数据内容,最长10MB
callbackstring回调请求url非必传参数传callback表示走异步回调逻辑,异步回调逻辑支持30M图片;否则走同步逻辑,同步支持10M图片。

其中,data的内容如下:

请求参数名类型参数说明传入说明规范
imgsjson_array要检测的图片数组必传参数
tokenIdstring用户账号标识必传参数用于区分用户账号,建议传入用户ID
ipstringipv4地址非必传参数发送该图片的用户公网ipv4地址
deviceIdstring数美设备指纹标识非必传参数数美设备指纹生成的设备唯一标识
maxFrameintgif图片的最大截帧数量非必传参数截取gif等动图帧数,最大为20帧,默认为3帧
intervalintgif图片的截帧间隔非必传参数默认值为1,代表每一帧都需要进行检测,服务会自动调整该值以保证完全覆盖全部帧
roomstring直播房间号非必传参数仅当event取值为 videoClip 时,可传入该字段
extrajson_object辅助参数非必传参数用于辅助文本检测的相关信息
rolestring用户角色非必传参数用户角色,必须在可选范围有效对不同角色可配置不同策略。(默认为USER)
直播领域可取值:
ADMIN:房管
HOST:主播
SYSTEM:系统角色
游戏领域可取值:
ADMIN:管理员
USER:普通用户
receiveTokenIdstring接收者的tokenId非必传参数接收者的tokenId,私聊场景必选

其中,extra的内容如下:

请求参数名类型参数说明传入说明规范
passThroughjson_object透传参数客户传入透传字段,数美内部不回对该字段进行识别处理,随结果返回给用户,必须为json_object类型
isTokenSeparateint是否区分不同应用下的账号非必传参数是否区分不同应用下的账号,可能取值:
0:不区分
1:区分
默认值为0

其中,imgs数组每个元素的具体内容如下:

请求参数名类型参数说明传入说明规范
imgstring要检测的图片,可使用base64编码的图片数据或者图片的url链接 建议图片下载从CDN源站下载,并且源站不能为单点
风险:如果不是从源站下载,可能存在图片下载失败,导致无法审核
必传参数支持格式:
jpgjpegpngwebpgiftifftifheif
建议图片像素不小于256*256, 目前最低支持20*20分辨率的图片,图片大小最大10MB
imgCompareBasestring要检测比对的基准图片,请求参数Type字段包含标签FACECOMPARE时存在
可使用base64编码的图片数据或者图片的url链接
非必传参数支持格式:
jpgjpegpngwebpgiftifftifheif
建议图片像素不小于256*256图片大小最大10MB

基准图暂时不支持长图和动图格式
btIdstring图片唯一标识必传参数同一次请求中不可重复,btId长度在30以内

同步批量返回参数#

放在HTTP Body中,采用Json格式,具体参数如下:

返回结果参数名参数类型参数说明是否必返规范
codeint返回码1100:成功
1901:QPS超限
1902:参数不合法
1903:服务失败
1911:图片下载失败
9101:无权限操作
除message和requestId之外的字段,只有当code为1100时才会存在
messagestring返回码描述和code对应:成功QPS超限参数不合法服务失败余额不足无权限操作
requestIdstring请求标识
imgsjson_array图片识别结果
auxInfojson_object其他辅助信息

其中,外层auxInfo内容如下:

返回结果参数名参数类型参数说明是否必返规范
passThroughjson_object透传参数客户传入透传字段,数美内部不回对该字段进行识别处理,随结果返回给用户,必须为json_object类型

其中,imgs数组每个元素的具体内容如下:

返回结果参数名参数类型参数说明是否必返规范
codeint该图片对应的返回码1100:成功
1901:QPS超限
1902:参数不合法
1903:服务失败
1911:图片下载失败
9101:无权限操作
除message和requestId之外的字段,只有当code为1100时才会存在
messagestring该图片对应的返回码描述和code对应:成功QPS超限参数不合法服务失败余额不足无权限操作
requestIdstring该图片对应的请求标识
btIdstring图片唯一标识用于区分图片,和传入参数中的btId对应
riskLevelstring处置建议可能返回值:
PASS:正常,建议直接放行
REVIEW:可疑,建议人工审核
REJECT:违规,建议直接拦截
riskLabel1string一级风险标签,当riskLevel为PASS时返回normal一级风险标签
riskLabel2string二级风险标签,当riskLevel为PASS时为空二级风险标签
riskLabel3string三级风险标签,当riskLevel为PASS时为空三级风险标签
riskDescriptionstring当riskLevel为PASS时为正常风险原因
riskDetailjson_object风险详情风险详情
auxInfojson_object其他辅助信息其他辅助信息
allLabelsjson_array当riskLevel为PASS时为空命中的所有风险标签以及详情信息
businessLabelsjson_array业务标签详情,请求参数Type字段包含OCRSCREENSCENCEMINORQRFACEQUALITYFACECOMPARE以上标签时不为空业务标签详情

imgs中,riskDetail的内容如下:

返回结果参数名参数类型参数说明是否必返规范
facesjson_array返回图片中涉政人物的名称及位置信息
objectsjson_array返回图片中标识或物品的名称及位置信息
ocrTextjson_object返回图片中违规文字相关信息,当请求参数type字段包含OCR时存在
riskSourceint标识资源哪里违规标识风险结果的来源:
1000:无风险
1001:文字风险
1002:视觉图片风险

riskDetail中,faces数组每个元素的内容如下:

返回结果参数名参数类型参数说明是否必返规范
namestring人物名称风险人物名称
locationint_array人物位置信息,该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567]
207代表的是左上角的x坐标
522代表左上角的y坐标
340代表的是右下角的x坐标
567代表的是右下角的y坐标
probabilityfloat置信度,可选值在0~1之间,值越大,可信度越高0~1之间的浮点数

riskDetail中,objects数组每个元素的内容如下:

返回结果参数名参数类型参数说明是否必返规范
namestring标识名称
locationint_array标识位置信息,该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567]
207代表的是左上角的x坐标
522代表左上角的y坐标
340代表的是右下角的x坐标
567代表的是右下角的y坐标
probabilityfloat置信度,可选值在0~1之间,值越大,可信度越高0~1之间的浮点数

riskDetail中,ocrText的内容如下:

返回结果参数名参数类型参数说明是否必返规范
textstring识别出的文字
matchedListsjson_array命中的客户自定义名单列表
riskSegmentsjson_array高风险片段内容检测图片包含涉政、暴恐、违禁、竞品、广告法等风险内容的时候存在

ocrText中,matchedLists数组每个元素的内容如下:

返回结果参数名参数类型参数说明是否必返规范
namestring命中的名单名称
wordsjson_array命中的敏感词信息

matchedLists中,words数组每个元素的内容如下:

返回结果参数名参数类型参数说明是否必返规范
wordstring命中的敏感词
positionint_array敏感词所在位置

ocrText中,riskSegments的每个元素的详细内容如下:

返回结果参数名参数类型参数说明是否必返规范
segmentstring高风险内容片段
positionint_array高风险内容片段所在位置

imgs中,auxInfo的内容如下:

返回结果参数名参数类型参数说明是否必返规范
segmentsint实际处理的图片数量
typeVersionjson_object针对各个传入type的效果版本号
errorCodeint2001:输入数据格式不对,不是合法的json数据
2002:输入的参数字段不合法(必填字段缺失、类型不对、值不合法等)
2003:图片下载失败
2004:图片过大,超过了10M
2005:非法图片格式
qrContentstring返回识别的二维码地址需要联系数美配置返回

auxInfo中,typeVersion的内容如下:

返回结果参数名参数类型参数说明是否必返规范
POLITICSstring涉政版本号组成形式为X.YX为主版本号,一般代表模型整体的效果迭代;Y为子版本号,一般代表日常的例行迭代
例如1001001.2代表主版本号为1001001,子版本号为2
VIOLENCEstring暴恐版本号组成形式同上
BANstring违禁版本号组成形式同上
PORNstring色情版本号组成形式同上
MINORstring未成年人版本号组成形式同上
ADstring广告版本号组成形式同上
SPAMstring灌水版本号组成形式同上
LOGOstring商企LOGO版本号组成形式同上
STARstring公众人物版本号组成形式同上
OCRstringOCR版本号组成形式同上
IMGTEXTstring违规文字版本号组成形式同上
SCREENstring特殊画面版本号组成形式同上
SCENCEstring场景画面版本号组成形式同上
QRstring二维码版本号组成形式同上
FACEstring人脸版本号组成形式同上
QUALITYstring图像质量版本号组成形式同上
PORTRAITstring人像版本号组成形式同上
ANIMALstring动物版本号组成形式同上
BEAUTYstring颜值版本号组成形式同上

imgs中,allLabels数组的每个成员的内容如下:

返回结果参数名参数类型参数说明是否必返规范
riskLabel1string一级风险标签一级风险标签
riskLabel2string二级风险标签二级风险标签
riskLabel3string三级风险标签三级风险标签
riskDescriptionstring风险原因
probabilityfloat置信度,可选值在0~1之间,值越大,可信度越高
riskDetailjson_object风险详情

allLabels每个成员的riskDetail结构如下:

返回结果参数名参数类型参数说明是否必返规范
facesjson_array人物信息返回图片中涉政人物的名称及位置信息,内容与外层riskDetail.faces格式一致
objectsjson_array标识信息返回图片中标识或物品的名称及位置信息,内容与外层riskDetail.objects格式一致

其中imgs中businessLabels数组的每个成员的内容如下:

返回结果参数名参数类型参数说明是否必返规范
businessLabel1string一级业务标签,当请求参数type字段包含业务标签传值时存在:SCREEN,SCENCE,QR,FACE,QUALITY,MINOR,LOGO,OCR,BEAUTY,FACECOMPARE一级业务标签
businessLabel2string二级业务标签二级业务标签
businessLabel3string三级业务标签三级业务标签
businessDescriptionstring业务标签描述中文标签描述
businessDetailjson_object业务标签详情格式详见下方businessDetail结构
probabilityfloat置信度
可选值在0~1之间,值越大,可信度越高
confidenceLevelint置信等级
可选值在0~2之间,值越大,可信度越高
注意:当检测模型是QR,OCR时不返回
注意:当检测模型是FACE且riskLabe2不等于gender时不返回

businessLabels数组中的businessDetail的内容如下:

返回结果参数名参数类型参数说明是否必返规范
namestring明星人物名称
图片中的明星人名type传值包含FACE时存在
probabilityfloat明星人物置信区间
可选值在0~1之间,值越大,可信度越高,当且仅当name存在时出现
face_ratiofloat人脸占比
在区间0-1,数值越大,人脸占比越高type传值包含FACE时存在
face_numint人脸数检测
图片中检测到的人脸个数 type传值包含FACEFACECOMPARE时存在
face_compare_numint人脸比对人脸数检测
图片中检测到的人脸个数,type传值包含FACECOMPARE时存在
locationint_array标识位置信息
type传值包含OBJECT且时存在,该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567]
207代表的是左上角的x坐标
522代表左上角的y坐标
340代表的是右下角的x坐标
567代表的是右下角的y坐标
person_numint人体数量检测
图片中检测到的人体个数type传值包含PORTRAIT且时存在
person_ratiofloat人像占比
在区间0-1,数值越大,人脸占比越高type传值包含PORTRAIT时存在

同步批量回调返回参数#

对于批量接口,和同步批量返回的结果相同。

返回结果参数名参数类型参数说明是否必返规范
codeint返回码1100:成功
1901:QPS超限
1902:参数不合法
1903:服务失败
1911:图片下载失败
9101:无权限操作
除message和requestId之外的字段,只有当code为1100时才会存在
messagestring返回码描述和code对应:成功QPS超限参数不合法服务失败余额不足无权限操作
requestIdsjson_array请求标识多个图片流水号

requestIds详细如下:

返回结果** 参数名 ** 类型 参数说明 是否必返 规范
requestIdstring流水号必返参数返回的requestId
btIdstring图片编号必返参数图片的btId

同步批量示例:#

同步批量请求示例:#

{
"accessKey":"",
"eventId":"",
"type":"",
"data":{
"imgs":[
{
"btId":"123",
"img":""
},
{
"btId":"456",
"img":""
},
]
}
}

同步返回示例:#

{
"message":"成功",
"requestId":"faf10b672ddae5e5e51ea719c44ca94b",
"auxInfo":{
},
"code" :1100,
"imgs":[
{
"allLabels":[
],
"auxInfo":{
"segments":1,
"typeVersion":{
"OCR":"2001003.1",
"PORN":"3043001.1"
}
},
"btId":"123",
"code":1100,
"message":"成功",
"requestId":"faf10b672ddae5e5e51ea719c44ca94b_123",
"riskDescription":"正常",
"riskDetail":{
"riskSource":1000
},
"riskLabel1":"normal",
"riskLabel2":"",
"riskLabel3":"",
"riskLevel":"PASS",
"tokenLabels":{
"UGC_account_risk":{
}
}
},
{
"allLabels":[
],
"auxInfo":{
"segments":1,
"typeVersion":{
"OCR":"2001003.1",
"PORN":"3043001.1"
}
},
"btId":"456",
"code":1100,
"message":"成功",
"requestId":"faf10b672ddae5e5e51ea719c44ca94b_456",
"riskDescription":"正常",
"riskDetail":{
"riskSource":1000
},
"riskLabel1":"normal",
"riskLabel2":"",
"riskLabel3":"",
"riskLevel":"PASS",
"tokenLabels":{
"UGC_account_risk":{
}
}
}
]
}

异步批量接口#

异步批量上传请求#

请求URL:#

集群URL支持产品列表
北京http://api-img-bj.fengkongcloud.com/v4/saas/async/imgs图片
上海http://api-img-sh.fengkongcloud.com/v4/saas/async/imgs图片

请求方法:#

POST

字符编码:#

UTF-8

建议超时时间:#

5s

请求参数:#

放在HTTP Body中,采用Json格式,具体参数如下:

请求参数名类型参数说明传入说明规范
accessKeystring接口认证密钥必传参数由数美提供
appIdstring应用标识必传参数用于区分应用,可选值如下:default:默认应用
额外应用值需数美单独分配提供
eventIdstring事件标识必传参数需要联系数美服务开通,请使用数美单独提供的传值为准,可选值:
default:默认
headImage:头像
album:相册
dynamic:动态
article:帖子
comment:评论
roomCover:房间封面
groupMessage:群聊图片
message:私聊图片
product:商品图片
typestring检测的风险类型必传参数请使用数美单独提供的传值为准,可选值:
POLITICS:涉政识别
VIOLENCE:暴恐识别
BAN:违禁识别
PORN:色情识别
AD:广告识别
OCR:识别图片中所有文字
FACECOMPARE:人脸比对
如果需要多个识别功能,通过下划线连接(该字段与businessType字段必须选择一个传入)
businessTypestring业务标签类型业务标签识别类型,可选值:
LOGO:商企LOGO识别
OCR:识别图片中所有文字
MINOR:未成年人识别
SCREEN:特殊画面识别
SCENCE:场景画面识别
QR:二维码识别
QUALITY: 图像质量识别
FACE:人脸识别
STAR:公众人物识
PORTRAIT:人像识别
BEAUTY: 颜值识别
ANIMAL: 动物识别
OBJECT:物品识别
IMAGECONTENT: 画面属性识别
FACECOMPARE: 人脸比对
PLANT: 植物
BODY: 人体
如果需要多个识别功能,通过下划线连接,该字段和type必须选择一个传入
datajson_object请求数据内容必传参数请求的数据内容,最长10MB

其中,data的内容如下:

请求参数名类型参数说明传入说明规范
imgsjson_array要检测的图片数组必传参数
tokenIdstring用户账号标识必传参数用于区分用户账号,建议传入用户ID
ipstringipv4地址非必传参数发送该图片的用户公网ipv4地址
deviceIdstring数美设备指纹标识非必传参数数美设备指纹生成的设备唯一标识
maxFrameintgif图片的最大截帧数量非必传参数截取gif等动图帧数,最大为20帧,默认为3帧
intervalintgif图片的截帧间隔非必传参数默认值为1,代表每一帧都需要进行检测,服务会自动调整该值以保证完全覆盖全部帧
roomstring直播房间号非必传参数仅当event取值为 videoClip 时,可传入该字段
extrajson_object辅助参数非必传参数用于辅助文本检测的相关信息
rolestring用户角色非必传参数用户角色,默认USER,必须在可选范围有效对不同角色可配置不同策略。直播领域可取值:房管:ADMIN主播:HOST系统角色:SYSTEM游戏领域可取值:管理员:ADMIN普通用户:USER
receiveTokenIdstring接收者的tokenId非必传参数接收者的tokenId,私聊场景必选

其中,extra的内容如下:

请求参数名类型参数说明传入说明规范
passThroughjson_object透传参数客户传入透传字段,数美内部不回对该字段进行识别处理,随结果返回给用户,必须为json_object类型

其中,imgs数组每个元素的具体内容如下:

请求参数名类型参数说明传入说明规范
imgstring要检测的图片,可使用base64编码的图片数据或者图片的url链接 建议图片下载从CDN源站下载,并且源站不能为单点
风险:如果不是从源站下载,可能存在图片下载失败,导致无法审核
必传参数支持格式:
jpgjpegpngwebpgiftifftifheif
建议图片像素不小于256*256, 目前最低支持20*20分辨率的图片,图片大小最大10MB
imgCompareBasestring要检测比对的基准图片,请求参数Type字段包含标签FACECOMPARE时存在
可使用base64编码的图片数据或者图片的url链接
非必传参数支持格式:
jpgjpegpngwebpgiftifftifheif
建议图片像素不小于256*256图片大小最大10MB

基准图暂时不支持长图和动图格式
btIdstring图片唯一标识必传参数同一次请求中不可重复,btId长度在30以内

异步批量返回参数#

放在HTTP Body中,采用Json格式,具体参数如下:

返回结果参数名参数类型参数说明是否必返规范
codeint返回码1100:成功
1901:QPS超限
1902:参数不合法
1903:服务失败
9101:无权限操作
除message和requestId之外的字段,只有当code为1100时才会存在
messagestring返回码描述和code对应:成功QPS超限参数不合法服务失败余额不足无权限操作
requestIdsjson_array请求标识多个图片流水号

requestIds中每一项是:

返回结果参数名类型参数说明是否必返规范
requestIdstring流水号必返参数返回的requestId
btIdstring图片编号必返参数图片的btId

异步批量返回示例#

{
"code":1100,
"message":"成功",
"requestIds":[
{
"reques-tId":"d123456322adasfajfafjaskfjaf",
"btId":"aaeevugq"
},
{
"reques-tId":"d123456322adasfajfafjaskfjaf",
"btId":"vccsewqy"
}
]
}

主动查询接口#

同步查询请求#

请求URL:#

集群URL支持产品列表
北京http://api-img-bj.fengkongcloud.com/v4/image/query图片

请求方法:#

POST

字符编码:#

UTF-8

建议超时时间:#

5s

请求参数:#

放在HTTP Body中,采用json格式,具体参数如下:

请求参数名类型参数说明传入说明规范
accessKeystring接口认证密钥必传参数公司密钥:用于权限认证,开通账号服务时由数美提供或使用开通邮箱登录数美后台右上角相关文档处查看
requestIdsjson_array流水号数组必传参数查询列表,最多支持10个流水号

requestIds每一项是:

请求参数名类型参数说明传入说明规范
requestIdstring流水号必传参数查询的requestId
btIdstring图片编号非必传参数如果存在btId,则返回requestId+btId的批量查询中的单张结果;如果不存在btId,则分为两种情况:第一种情况,返回单张请求的结果;第二种情况,模糊匹配返回批量请求的结果

查询请求示例#

{
"accessKey":"***",
"requestIds":[
{
"requestId":"***",
"btId":""
}
]
}

查询返回参数#

参数名称参数类型参数说明是否必返规范
codeint返回码1100:成功
1901:QPS超限
1902:参数不合法
1903:服务失败
9101:无权限操作
除message和requestId之外的字段,只有当code为1100时才会存在
messagestring返回码描述和code对应:成功QPS超限参数不合法服务失败无权限操作
contentsjson_array查询结果

contents组成如下:

参数名称类型是否必选说明
requestIdstring请求唯一标识
resultjson object返回结果
btIdstring图片id
code(表示该requestId对应的请求的状态)int1102:正在处理
1100:处理完成
1910:失败
1912:处理超时(默认24h)
messagestring和code对应:正在处理处理完成失败(根据不同情况显示具体失败的原因)处理超时(默认24h)

result如下:

参数名称参数类型参数说明是否必返规范
codeint返回码1100:成功
1901:QPS超限
1902:参数不合法
1903:服务失败
1911:图片下载失败
9101:无权限操作
除message和requestId之外的字段,只有当code为1100时才会存在
messagestring返回码描述和code对应:成功QPS超限参数不合法服务失败余额不足无权限操作
requestIdstring请求标识请求唯一标识,用于排查问题和后续效果优化,强烈建议保存
riskLevelstring处置建议可能返回值:
PASS:正常,建议直接放行
REVIEW:可疑,建议人工审核
REJECT:违规,建议直接拦截
riskLabel1string一级风险标签当riskLevel为PASS时返回normal
riskLabel2string二级风险标签当riskLevel为PASS时为空
riskLabel3string三级风险标签当riskLevel为PASS时为空
riskDescriptionstring风险原因当riskLevel为PASS时为正常
riskDetailjson_object风险详情
auxInfojson_object其他辅助信息
allLabelsjson_array风险标签详情返回命中的所有风险标签以及详情信息
businessLabelsjson_array业务标签详情请求参数Type字段包含OCRSCREENSCENCEMINORQRFACEQUALITYFACECOMPARE以上标签时不为空

其中,riskDetail的内容如下:

返回结果参数名参数类型参数说明是否必返规范
facesjson_array返回图片中涉政人物的名称及位置信息
objectsjson_array返回图片中标识或物品的名称及位置信息
ocrTextjson_object返回图片中违规文字相关信息,当请求参数type字段包含OCR时存在
riskSourceint标识资源哪里违规标识风险结果的来源:
1000:无风险
1001:文字风险
1002:视觉图片风险

riskDetail中,faces数组每个元素的内容如下:

返回结果参数名参数类型参数说明是否必返规范
namestring人物名称风险人物名称
locationint_array人物位置信息,该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567]
207代表的是左上角的x坐标
522代表左上角的y坐标
340代表的是右下角的x坐标
567代表的是右下角的y坐标
probabilityfloat置信度,可选值在0~1之间,值越大,可信度越高0~1之间的浮点数

riskDetail中,objects数组每个元素的内容如下:

返回结果参数名参数类型参数说明是否必返规范
namestring标识名称
locationint_array标识位置信息,该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567]
207代表的是左上角的x坐标
522代表左上角的y坐标
340代表的是右下角的x坐标
567代表的是右下角的y坐标
probabilityfloat置信度,可选值在0~1之间,值越大,可信度越高0~1之间的浮点数

riskDetail中,ocrText的内容如下:

返回结果参数名参数类型参数说明是否必返规范
textstring识别出的文字
matchedListsjson_array命中的客户自定义名单列表
riskSegmentsjson_array高风险片段内容,检测图片包含涉政、暴恐、违禁、广告法等风险内容的时候存在

ocrText中,matchedLists数组每个元素的内容如下:

返回结果参数名参数类型参数说明是否必返规范
namestring命中的名单名称
wordsjson_array命中的敏感词信息

matchedLists中,words数组每个元素的内容如下:

返回结果参数名参数类型参数说明是否必返规范
wordstring命中的敏感词
positionint_array敏感词所在位置

ocrText中,riskSegments的每个元素的详细内容如下:

返回结果参数名参数类型参数说明是否必返规范
segmentstring高风险内容片段
positionint_array高风险内容片段所在位置

其中,auxInfo的内容如下:

返回结果参数名参数类型参数说明是否必返规范
segmentsint实际处理的图片数量
typeVersionjson_object针对各个传入type的效果版本号
errorCodeint2001:输入数据格式不对,不是合法的json数据
2002:输入的参数字段不合法(必填字段缺失、类型不对、值不合法等)
2003:图片下载失败
2004:图片过大,超过了10M
2005:非法图片格式
2006:无效风险监测类型
passThroughjson_object客户传入的透传字段
qrContentstring返回识别的二维码地址需要联系数美配置返回

auxInfo中,typeVersion的内容如下:

返回结果参数名参数类型参数说明是否必返规范
POLITICSstring涉政版本号组成形式为X.YX为主版本号,一般代表模型整体的效果迭代;Y为子版本号,一般代表日常的例行迭代
例如1001001.2代表主版本号为1001001,子版本号为2
VIOLENCEstring暴恐版本号组成形式同上
BANstring违禁版本号组成形式同上
PORNstring色情版本号组成形式同上
MINORstring未成年人版本号组成形式同上
ADstring广告版本号组成形式同上
SPAMstring灌水版本号组成形式同上
LOGOstring商企LOGO版本号组成形式同上
STARstring公众人物版本号组成形式同上
OCRstringOCR版本号组成形式同上
IMGTEXTstring违规文字版本号组成形式同上
SCREENstring特殊画面版本号组成形式同上
SCENCEstring场景画面版本号组成形式同上
QRstring二维码版本号组成形式同上
FACEstring人脸版本号组成形式同上
QUALITYstring图像质量版本号组成形式同上
PORTRAITstring人像版本号组成形式同上
ANIMALstring动物版本号组成形式同上
BEAUTYstring颜值版本号组成形式同上

其中allLabels数组的每个成员的内容如下:

返回结果参数名参数类型参数说明是否必返规范
riskLabel1string一级风险标签一级风险标签
riskLabel2string二级风险标签二级风险标签
riskLabel3string三级风险标签三级风险标签
riskDescriptionstring风险原因
probabilityfloat置信度,可选值在0~1之间,值越大,可信度越高
riskDetailjson_object风险详情

allLabels每个成员的riskDetail结构如下:

返回结果参数名参数类型参数说明是否必返规范
facesjson_array人物信息返回图片中涉政人物的名称及位置信息,内容与外层riskDetail.faces格式一致
objectsjson_array标识信息返回图片中标识或物品的名称及位置信息,内容与外层riskDetail.objects格式一致

其中businessLabels数组的每个成员的内容如下:

返回结果参数名参数类型参数说明是否必返规范
businessLabel1string一级业务标签一级业务标签
businessLabel2string二级业务标签二级业务标签
businessLabel3string三级业务标签三级业务标签
businessDescriptionstring业务标签描述中文标签描述
businessDetailjson_object业务标签详情格式详见下方businessDetail结构
probabilityfloat置信度
可选值在0~1之间,值越大,可信度越高
confidenceLevelint置信等级
可选值在0~2之间,值越大,可信度越高
注意:当检测模型是QR,OCR时不返回
注意:当检测模型是FACE且riskLabe2不等于gender时不返回

businessLabels数组中的businessDetail的内容如下:

返回结果参数名参数类型参数说明是否必返规范
namestring明星人物名称
图片中的明星人名type传值包含FACE时存在
probabilityfloat明星人物置信区间
可选值在0~1之间,值越大,可信度越高,当且仅当name存在时出现
face_ratiofloat人脸占比
在区间0-1,数值越大,人脸占比越高type传值包含FACE时存在
face_numint人脸数检测
图片中检测到的人脸个数
type传值包含FACEFACECOMPARE时存在
face_compare_numint人脸比对人脸数检测
图片中检测到的人脸个数,type传值包含FACECOMPARE时存在
locationint_array标识位置信息
type传值包含OBJECT且时存在,该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567]
207代表的是左上角的x坐标
522代表左上角的y坐标
340代表的是右下角的x坐标
567代表的是右下角的y坐标
person_numint人体数量检测
图片中检测到的人体个数type传值包含PORTRAIT且时存在
person_ratiofloat人像占比
在区间0-1,数值越大,人脸占比越高type传值包含PORTRAIT时存在

Demo#

目前提供了 go、java、lua、nodes、php、python 的 demo,代码位置: https://github.com/ishumei/api-demo/tree/master/v4

购买咨询