数美智能视频文件识别产品API文档#

视频文件上传请求#

接口描述#

该接口用于提交视频相关信息,自定义截帧频率等参数。识别结果需客户自行定期调用查询接口获取。

请求URL:#

集群URL
北京http://api-video-bj.fengkongcloud.com/video/v4
上海http://api-video-sh.fengkongcloud.com/video/v4
新加坡http://api-video-xjp.fengkongcloud.com/video/v4
硅谷http://api-video-gg.fengkongcloud.com/video/v4
印度http://api-video-yd.fengkongcloud.com/video/v4

请求方法:#

POST

字符编码:#

UTF-8

建议超时时间:#

7s

视频格式限制:#

AVIFLVMP4MPGWMVMOVWMARMVBm3u8

视频大小限制:#

小于等于300MB

视频时长限制:#

小于等于2小时

请求参数:#

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

请求参数名类型参数说明传入说明规范
accessKeystring公司密钥必传参数由数美提供,数美分配
appIdstring应用标识必传参数用于区分应用,需要联系数美服务开通,请使用数美单独提供的传值为准
eventIdstring事件标识必传参数用于区分场景数据,需要联系数美服务开通,请使用数美单独提供的传值为准
imgTypestring视频中的画面需要识别的监管类型,和imgBusinessType至少传一个非必传参数监管一级标签
可选值:
POLITY:涉政识别
EROTIC:色情&性感违规识别
VIOLENT:暴恐&违禁识别
QRCODE:二维码识别
ADVERT:广告识别
IMGTEXTRISK:图片文字违规识别
如果需要识别多个功能,通过下划线连接,如POLITY_QRCODE_ADVERT用于涉政、二维码和广告组合识别
audioTypestring视频中的音频需要识别的监管类型非必传参数监管一级标签
可选值:
POLITICS:涉政识别
PORN:色情识别
AD:广告识别
MOAN:娇喘识别
ABUSE:辱骂识别
ANTHEN:国歌识别
AUDIOPOLITICAL:声音涉政
NONE:不检测音频
如需做组合识别,通过下划线连接即可,例如POLITICAL_PORN_MOAN用于广告、色情和涉政识别
imgBusinessTypestring视频中的画面需要识别的业务类型, 和imgType至少传一个非必传参数可选值参考imgBusinessType可选值列表
如果需要识别多个功能,通过下划线连接
audioBusinessTypeString视频中的音频业务识别类型非必传参数业务一级标签
可选值:
SING:唱歌识别
LANGUAGE:语种识别(中文、英文、粤语、藏语、维吾尔语、朝鲜语、蒙语、其他)
MINOR:未成年人识别
GENDER:性别识别
TIMBRE:音色识别,需要同时传入GENDER才能生效
如果需要识别多个功能,通过下划线连接
callbackstring指定回调url地址非必传参数当该字段非空时,服务将根据该字段回调通知用户审核结果(支持http/https
datajson_object本次请求相关信息,最长1MB必传参数最长1MB,其中data内容如下
其中,data的内容如下:
请求参数名类型参数说明传入说明规范
btIdstring视频唯一标识必传参数视频唯一标识,用于查询识别结果,最长64位
urlstring要检测的视频url地址必传参数
tokenIdstring必传参数客户端用户账号唯一标识,用于用户行为分析,建议传入用户UID; 最长40位
langstring语言类型非必传参数可选值:
zh :中文
en :英文
ar :阿拉伯语
不传默认进行中文检测
detectFrequencyfloat截帧频率间隔,单位为秒非必传参数取值范围为0.5~60s;如不传递默认5s截帧一次
advancedFrequencyjson_object高级截帧间隔,单位为秒非必传参数高级截帧设置,此项填写,默认截帧策略失效
参数配置如下
{"durationPoints":[300,600],"frequencies":[1,5,10]}
含义为:
视频文件时长≤300s ——选用1s一截帧
300s<视频文件时长≤600s ——选用5s一截帧
视频文件时长>600s ——选用10s一截帧
ipstring客户端IP非必传参数用于IP维度的用户行为分析,同时可用于比对数美IP黑库
audioDetectStepint视频文件中的音频审核步长非必传参数单位为个,取值范围为1-36整数,取1表示跳过一个10S的音频片段审核,取2表示跳过二个,以此类推。不使用该功能时音频内容全部过审
returnAllImgint非必传参数选择返回视频截帧图片的等级:0:返回风险等级为非pass的图片;1:返回所有风险等级的图片。默认为0
returnAllAudioint非必传参数选择返回视频音频片段的等级:0:返回风险等级为非pass的音频片段1:返回所有风险等级的音频片段默认为0
videoTitlestring视频名称非必传参数视频名称,用于后台界面展示
extrajson_object扩展信息非必传参数详见extra说明
data 中,advancedFrequency的内容如下
请求参数名类型参数说明传入说明规范
durationPointsObject[]视频时长区间分割非必传参数用于规定视频文件支持动态截帧频率的时长区间,数组最多为5个
frequenciesObject[]视频时长区间对应的截帧频率非必传参数可设置范围为0.5~60秒,数组最多6个
说明:frequencies数组设置的个数需要比durationPoints数组个数多1个,传错或传空报错返回1902
data 中,extra的内容如下
请求参数名类型参数说明传入说明规范
passThroughjson_object透传字段非必传参数该字段内容会随着回调结果一起原样返回

返回参数:#

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

返回结果参数名参数类型参数说明是否必返规范
requestIdstring本次请求的唯一标识请求唯一标识
codeint请求返回码详见接口响应码列表
messagestring请求返回描述详情描述如上
btIdstring唯一标识客户上传的视频仅当code=1100时返回,与请求参数中的btId字段对应

异步回调结果#

接口描述#

用户如果需要服务端主动对视频检测结果进行回调,则需要在请求参数中指定回调协议接口URL callback参数,服务端根据该参数在视频审核完成后,主动回调用户。

请求方法:#

POST

字符编码:#

UTF-8

建议超时时间:#

5s

支持协议:#

HTTPHTTPS

回调策略:#

当用户收到推送结果,并返回HTTP状态码为200时,表示推送成功;否则回调失败,系统将进行重试,最多20次推送。

回调参数:#

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

参数名类型参数说明是否必返规范
codeint返回码详见接口响应码列表
messagestring返回码详情描述
requestIdstring请求唯一标识
btIdstring视频唯一标识最长64位
riskLevelstring风险级别,code为1100时存在返回值:
PASS:正常内容,建议直接放行
REVIEW:可疑内容,建议人工审核
REJECT:违规内容,建议直接拦截
frameDetailjson_array风险详情有风险片段或returnAllImg=1时返回,详见frameDetail说明
audioDetailjson_array音频片段信息有风险片段或returnAllAudio=1时返回,详见audioDetail说明
auxInfojson_object辅助信息code为1100时存在,详见auxInfo说明
tokenProfileLabelsjson_array账号属性标签仅在开启功能时返回,详见tokenProfileLabels说明
tokenRiskLabelsjson_array账号风险标签仅在开启功能时返回,详见tokenRiskLabels说明
其中,auxInfo中的具体内容如下:
参数名类型参数说明是否必返规范
frameCountint返回的视频截帧数量。returnAllImg=0时为风险数量,returnAllImg=1时为全部数量
timeint视频时长
passThroughjson_object透传字段,该字段内容与请求参数data中extra的passThrough的值相同
其中,frameDetail数组中每个成员的具体内容如下:
参数名类型参数说明是否必返规范
timefloat截帧在视频文件中的时间,单位为秒截帧图片相对视频文件的时间
requestIdstring当前截帧片段的唯一标识
imgUrlstring当前截帧的URL
imgTextstring截帧图片OCR文本内容截帧图片OCR文字识别,识别类型包含OCR时会有
riskLevelstring当前截帧的处置建议PASS:正常内容
REVIEW:可疑内容
REJECT:违规内容
riskLabel1string各个一级标签之间是并列的关系,当riskLevel为PASS时返回normal一级标签
riskLabel2string二级标签归属于一级标签,当riskLevel为PASS时为空二级标签
riskLabel3string三级标签归属于二级标签,当riskLevel为PASS时为空三级标签
riskDescriptionstring标签解释对于命中用户自定义名单时返回:命中自定义名单;当riskLevel为PASS时返回:正常;其他情况展现形式为一级标签:二级标签:三级标签的中文名
riskDetailjson_object风险详情信息详见riskDetail说明
allLabelsjson_array全部的风险标签列表全部的风险标签列表,详见allLabels说明
businessLabelsjson_array业务标签列表传入imgBusinessType时返回,详见businessLabels说明
auxInfojson_object辅助信息一些辅助信息放在这里,详见auxInfo说明
frameDetail中,auxInfo的内容如下:
参数名类型参数说明是否必返规范
qrContentstring截帧图片二维码链接识别截帧图片二维码链接识别,如有需要可联系数美开启
注意:开启该功能后,只有完整,可以正常识别到的二维码才会返回且imgType传值需要包含AD
similarityfloat当前截帧图片和上一帧截帧图片的相似度有图片则该字段就会返回,视频文件初始第一帧将比对纯黑背景图片
frameDetail中,riskDetail的内容如下:
参数名类型参数说明是否必返规范
riskSourceint风险来源可选值:
1000:无风险
1001:文本风险
1002:视觉风险
1003:音频风险
facesjson_array人脸信息返回图片中涉政人物的名称及位置信息,详见faces说明
face_numint人脸数量
objectsjson_array物品信息返回图片中标识或物品的名称及位置信息,详见objects说明
personsjson_array人像信息
person_numint人像数量
ocrTextjson_object文字信息返回图片中文字相关信息,详见ocrText说明
riskDetail中,faces数组的每个元素的内容如下:
参数名类型参数说明是否必返规范
idstring编号
namestring人名
locationint_array位置坐标该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567]
207代表的是左上角的x坐标
522代表左上角的y坐标
340代表的是右下角的x坐标
567代表的是右下角的y坐标
probabilityfloat置信度可选值在0~1之间,值越大,可信度越高
face_ratiofloat人脸占比
riskDetail中,objects数组的每个元素的内容如下:
参数名类型参数说明是否必返规范
idstring编号
namestring名称
locationint_array位置坐标该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567]
207代表的是左上角的x坐标
522代表左上角的y坐标
340代表的是右下角的x坐标
567代表的是右下角的y坐标
probabilityfloat置信度可选值在0~1之间,值越大,可信度越高
qrContentstring二维码信息

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

参数名类型参数说明是否必返规范
idstring编号
locationint_array位置坐标该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567]
207代表的是左上角的x坐标
522代表左上角的y坐标
340代表的是右下角的x坐标
567代表的是右下角的y坐标
probabilityfloat置信度可选值在0~1之间,值越大,可信度越高
person_ratiofloat人像占比
riskDetail中,ocrText数组每个成员的具体内容如下:
参数名类型参数说明是否必返规范
textstring图片中识别出的文字识别出来所有文字内容
matchedListsjson_array命中的客户自定义名单信息仅在命中客户自定义名单时返回,详见matchedLists说明
riskSegmentsjson_array高风险内容片段在启用涉政、暴恐、违禁、广告等功能时存在,详见riskSegments说明
ocrText中,matchedLists数组每个成员的具体内容如下:
参数名类型参数说明是否必返规范
namestring客户自定义名单名称
wordsjson_array命中的这个名单中的敏感词信息下标从0开始计数,详见words说明
matchedLists中,words数组每个成员的具体内容如下:
参数名类型参数说明是否必返规范
wordstring敏感词
positionint_array敏感词所在位置下标从0开始计数

ocrText中,riskSegments每个成员的具体内容如下:

参数名类型参数说明是否必返规范
segmentstring高风险内容片段
positionint_array高风险内容片段所在位置下标从0开始计数
frameDetail中,allLabels数组的每个成员的内容如下:
参数名类型参数说明是否必返规范
riskLabel1string一级风险标签一级风险标签
riskLabel2string二级风险标签二级风险标签
riskLabel3string三级风险标签三级风险标签
riskDescriptionstring风险描述格式为"一级风险标签:二级风险标签:三级风险标签"的中文名称
对于命中用户自定义名单时返回:命中自定义名单
riskLevelstring处置建议PASS:正常内容
REVIEW:可疑内容
REJECT:违规内容
probabilityfloat置信度可选值为0~1,值越大,可信度越高
riskDetailjson_object风险详情同frameDetail中的riskDetail结构一致
frameDetail中,businessLabels数组的每个成员的内容如下:
参数名类型参数说明是否必返规范
businessLabel1string一级标签一级标签
businessLabel2string二级标签二级标签
businessLabel3string三级标签三级标签
businessDescriptionstring标签描述格式为"一级标签:二级标签:三级标签"的中文名称
confidenceLevelint置信等级可选值在0~2之间,值越大,可信度越高
probabilityfloat置信度可选值为0~1,值越大,可信度越高
businessDetailJson_object详细信息

businessLabels中,businessDetail的内容如下:

参数名类型参数说明是否必返规范
facesjson_array人脸信息
face_numint人脸数量
objectsjson_array物品信息
personsJson_array人像信息
person_numint人像数量

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

参数名类型参数说明是否必返规范
idstring编号
namestring人名
locationint_array位置坐标该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567]
207代表的是左上角的x坐标
522代表左上角的y坐标
340代表的是右下角的x坐标
567代表的是右下角的y坐标
probabilityfloat置信度可选值在0~1之间,值越大,可信度越高
face_ratiofloat人脸占比

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

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

businessDetail中,persons数组的每个元素的内容如下:

参数名类型参数说明是否必返规范
idstring编号
locationint_array位置坐标该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567]
207代表的是左上角的x坐标
522代表左上角的y坐标
340代表的是右下角的x坐标
567代表的是右下角的y坐标
probabilityfloat置信度可选值在0~1之间,值越大,可信度越高
person_ratiofloat人像占比
其中,audioDetail数组中每个成员的具体内容如下:
参数名类型参数说明是否必返规范
requestIdstring请求唯一标识
audioStarttimefloat音频片段发生时间
audioEndtimefloat音频片段结束时间
audioUrlstring音频片段地址
audioTextstring音转文文字识别出文本会返回
riskLevelstring当前事件的处置建议PASS:正常内容
REVIEW:可疑内容
REJECT:违规内容
riskLabel1string各个一级标签之间是并列的关系,riskLevel为PASS时返回normal一级标签
riskLabel2string二级标签归属于一级标签,当riskLevel为PASS时为空二级标签
riskLabel3string三级标签归属于二级标签,当riskLevel为PASS时为空三级标签
riskDescriptionstring标签解释格式为"一级风险标签:二级风险标签:三级风险标签"的中文名称
对于命中用户自定义名单时返回:命中自定义名单
riskDetailjson_object风险详情信息详见riskDetail说明
allLabelsjson_array全部的风险标签列表全部的风险标签列表,详见allLabels说明
businessLabelsjson_array业务标签列表传入audioBusinessType时会返回,详见businessLabels说明
audioDetail中,riskDetail的每个元素详细内容如下:
参数名类型参数说明是否必返规范
riskSourceint风险来源风险来源,可选值:
1000:无风险
1001:文本风险
1002:视觉风险
1003:音频风险
audioTextstring音频转译文本的结果
matchedListsjson_array命中的客户自定义名单信息命中客户自定义名单时返回,其他时不存在,详见matchedLists说明
riskSegmentsjson_array高风险内容片段在涉政、暴恐、违禁、竞品、广告法等功能的时候存在,详见riskSegments说明
riskDetail中,matchedLists的每个元素详细内容如下:
参数名类型参数说明是否必返规范
namestring客户自定义名单名
wordsjson_array命中的这个名单中的敏感词信息下标从0开始计数,详见words说明
matchedLists中,words的每个元素详细内容如下:
参数名类型参数说明是否必返规范
wordstring敏感词
positionint_array敏感词所在位置下标从0开始计数
riskDetail中,riskSegments的每个元素详细内容如下:
参数名类型参数说明是否必返规范
segmentstring高风险内容片段
positionint_array高风险内容片段所在位置下标从0开始计数
audioDetail中,allLabels数组的每个成员的内容如下:
参数名类型参数说明是否必返规范
riskLabel1string一级风险标签一级风险标签
riskLabel2string二级风险标签二级风险标签
riskLabel3string三级风险标签三级风险标签
riskDescriptionstring风险描述格式为"一级风险标签:二级风险标签:三级风险标签"的中文名称
对于命中用户自定义名单时返回:命中自定义名单
riskLevelstring处置建议PASS:正常内容
REVIEW:可疑内容
REJECT:违规内容
probabilityfloat置信度可选值为0~1,值越大,可信度越高
riskDetailjson_object风险详情同audioDetail中的riskDetail结构一致
audioDetail中,businessLabels数组的每个成员的内容如下:
参数名类型参数说明是否必返规范
businessLabel1string一级标签一级标签
businessLabel2string二级标签二级标签
businessLabel3string三级标签三级标签
businessDescriptionstring标签描述格式为"一级标签:二级标签:三级标签"的中文名称
confidenceLevelint置信等级可选值在0~2之间,值越大,可信度越高
probabilityfloat置信度可选值为0~1,值越大,可信度越高
businessDetailJson_object详细信息
其中,tokenProfileLabels数组每个成员的具体内容如下:
参数名类型参数说明是否必返规范
label1string一级标签
label2string二级标签
label3string三级标签
descriptionstring标签描述
timestampint打标签时间戳13位Unix时间戳,单位:毫秒
其中,tokenRiskLabels数组每个成员的具体字段同tokenProfileLabels

查询视频结果#

该接口用于客户主动查询视频文件识别结果,建议每30s进行一次查询。

接口描述#

该接口用于客户主动查询视频文件识别结果,建议每30s进行一次查询, 支持近三天结果的查询。

请求URL:#

集群URL支持产品列表
北京http://api-video-bj.fengkongcloud.com/video/query/v4中文视频文件
上海http://api-video-sh.fengkongcloud.com/video/query/v4中文视频文件
新加坡http://api-video-xjp.fengkongcloud.com/video/query/v4中文视频文件
硅谷http://api-video-gg.fengkongcloud.com/video/query/v4中文视频文件
印度http://api-video-yd.fengkongcloud.com/video/query/v4中文视频文件

请求方法:#

POST

支持协议:#

HTTPHTTPS

字符编码:#

UTF-8

建议超时时间:#

1s

请求参数:#

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

参数名类型参数说明传入说明规范
accessKeystring用于权限认证,开通账号服务时由数美提供必传参数
btIdstring视频唯一标识,用于查询识别结果,最长64位必传参数

返回参数#

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

参数名类型参数说明是否必返规范
codeint返回码详见接口响应码列表
messagestring返回码详情描述
requestIdstring请求唯一标识
btIdstring视频唯一标识最长64位
riskLevelstring风险级别,code为1100时存在可能返回值:
PASS:正常内容,建议直接放行
REVIEW:可疑内容,建议人工审核
REJECT:违规内容,建议直接拦截
frameDetailjson_array风险详情code为1100时存在,详见frameDetail
audioDetailjson_array音频片段信息code为1100时存在,详见audioDetail
auxInfojson_object辅助信息code为1100时存在,扩展辅助信息,详见auxInfo说明
tokenProfileLabelsjson_array账号属性标签仅在开启功能时返回,详见tokenProfileLabels说明
tokenRiskLabelsjson_array账号风险标签仅在开启功能时返回,详见tokenRiskLabels说明
其中,auxInfo数组中每个成员的具体内容如下:
参数名类型参数说明是否必返规范
frameCountint辅助信息视频文件的截帧总数
timeint辅助信息视频时长
其中,frameDetail数组中每个成员的具体内容如下:
参数名类型参数说明是否必返规范
timefloat截帧在视频文件中的时间,单位为秒截帧图片相对视频文件的时间
requestIdstring当前截帧片段的唯一标识
imgUrlstring当前截帧的URL
imgTextstring截帧图片OCR文本内容截帧图片OCR文字识别,识别类型包含OCR时会有
riskLevelstring当前截帧的处置建议PASS:正常内容
REVIEW:可疑内容
REJECT:违规内容
riskLabel1string各个一级标签之间是并列的关系,当riskLevel为PASS时返回normal一级标签
riskLabel2string二级标签归属于一级标签,当riskLevel为PASS时为空二级标签
riskLabel3string三级标签归属于二级标签,当riskLevel为PASS时为空三级标签
riskDescriptionstring标签解释对于命中用户自定义名单时返回:命中自定义名单;当riskLevel为PASS时返回:正常;其他情况展现形式为一级标签:二级标签:三级标签的中文名
riskDetailjson_object风险详情信息风险详情,详见riskDetail说明
allLabelsjson_array全部的风险标签列表全部的风险标签列表,详见allLabels说明
businessLabelsjson_array业务标签列表传入imgBusinessType时返回,详见businessLabels说明
auxInfojson_object辅助信息一些辅助信息放在这里,详见auxInfo说明
frameDetail中,auxInfo的内容如下:
参数名类型参数说明是否必返规范
qrContentstring截帧图片二维码链接识别截帧图片二维码链接识别,如有需要可联系数美开启
注意:开启该功能后,只有完整,可以正常识别到的二维码才会返回且imgType传值需要包含AD
similarityfloat当前截帧图片和上一帧截帧图片的相似度有图片则该字段就会返回,视频文件初始第一帧将比对纯黑背景图片
frameDetail中,riskDetail的内容如下:
参数名类型参数说明是否必返规范
riskSourceint风险来源可选值:
1000:无风险
1001:文本风险
1002:视觉风险
1003:音频风险
facesjson_array人脸信息返回图片中涉政人物的名称及位置信息,详见faces说明
face_numint人脸数量
objectsjson_array物品信息返回图片中标识或物品的名称及位置信息,详见objects说明
personsjson_array人像信息
person_numint人像数量
ocrTextjson_object文字信息返回图片中文字相关信息,详见ocrText说明
riskDetail中,faces数组的每个元素的内容如下:
参数名类型参数说明是否必返规范
idstring编号
namestring人名
locationint_array位置坐标该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567]
207代表的是左上角的x坐标
522代表左上角的y坐标
340代表的是右下角的x坐标
567代表的是右下角的y坐标
probabilityfloat置信度可选值在0~1之间,值越大,可信度越高
face_ratiofloat人脸占比
riskDetail中,objects数组的每个元素的内容如下:
参数名类型参数说明是否必返规范
idstring编号
namestring名称
locationint_array位置坐标该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567]
207代表的是左上角的x坐标
522代表左上角的y坐标
340代表的是右下角的x坐标
567代表的是右下角的y坐标
probabilityfloat置信度可选值在0~1之间,值越大,可信度越高
qrContentstring二维码信息

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

参数名类型参数说明是否必返规范
idstring编号
locationint_array位置坐标该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567]
207代表的是左上角的x坐标
522代表左上角的y坐标
340代表的是右下角的x坐标
567代表的是右下角的y坐标
probabilityfloat置信度可选值在0~1之间,值越大,可信度越高
person_ratiofloat人像占比
riskDetail中,ocrText数组每个成员的具体内容如下:
参数名类型参数说明是否必返规范
textstring图片中识别出的文字识别出来所有文字内容
matchedListsjson_array命中的客户自定义名单信息仅在命中客户自定义名单时返回
riskSegmentsjson_array高风险内容片段在启用涉政、暴恐、违禁、广告等功能时存在

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

参数名类型参数说明是否必返规范
namestring客户自定义名单名称
wordsjson_array命中的这个名单中的敏感词信息下标从0开始计数

matchedLists中,words的每个元素详细内容如下:

参数名类型参数说明是否必返规范
wordstring敏感词
positionint_array敏感词所在位置下标从0开始计数

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

参数名类型参数说明是否必返规范
segmentstring高风险内容片段
positionint_array高风险内容片段所在位置下标从0开始计数
frameDetail,allLabels数组的每个成员的内容如下:
参数名类型参数说明是否必返规范
riskLabel1string一级风险标签一级风险标签
riskLabel2string二级风险标签二级风险标签
riskLabel3string三级风险标签三级风险标签
riskDescriptionstring风险描述格式为"一级风险标签:二级风险标签:三级风险标签"的中文名称
对于命中用户自定义名单时返回:命中自定义名单
riskLevelstring处置建议PASS:正常内容
REVIEW:可疑内容
REJECT:违规内容
probabilityfloat置信度可选值为0~1,值越大,可信度越高
riskDetailjson_object风险详情同frameDetail中的riskDetail结构一致
frameDetail中,businessLabels数组的每个成员的内容如下:
参数名类型参数说明是否必返规范
businessLabel1string一级标签一级标签
businessLabel2string二级标签二级标签
businessLabel3string三级标签三级标签
businessDescriptionstring标签描述格式为"一级标签:二级标签:三级标签"的中文名称
confidenceLevelint置信等级可选值在0~2之间,值越大,可信度越高
probabilityfloat置信度可选值为0~1,值越大,可信度越高
businessDetailJson_object详细信息

businessLabels中,businessDetail的内容如下:

参数名类型参数说明是否必返规范
facesjson_array人脸信息
face_numint人脸数量
objectsjson_array物品信息
personsJson_array人像信息
person_numint人像数量

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

参数名类型参数说明是否必返规范
idstring编号
namestring人名
locationint_array位置坐标该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567]
207代表的是左上角的x坐标
522代表左上角的y坐标
340代表的是右下角的x坐标
567代表的是右下角的y坐标
probabilityfloat置信度可选值在0~1之间,值越大,可信度越高
face_ratiofloat人脸占比

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

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

businessDetail中,persons数组的每个元素的内容如下:

参数名类型参数说明是否必返规范
idstring编号
locationint_array位置坐标该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567]
207代表的是左上角的x坐标
522代表左上角的y坐标
340代表的是右下角的x坐标
567代表的是右下角的y坐标
probabilityfloat置信度可选值在0~1之间,值越大,可信度越高
person_ratiofloat人脸占比
其中,audioDetail数组中每个成员的具体内容如下:
参数名类型参数说明是否必返规范
requestIdstring请求唯一标识
audioStarttimefloat音频片段发生时间
audioEndtimefloat音频片段结束时间
audioUrlstring音频片段地址
audioTextstring音转文文字识别出文本会返回
riskLevelstring当前事件的处置建议PASS:正常内容
REVIEW:可疑内容
REJECT:违规内容
riskLabel1string各个一级标签之间是并列的关系,riskLevel为PASS时返回normal一级标签
riskLabel2string二级标签归属于一级标签,当riskLevel为PASS时为空二级标签
riskLabel3string三级标签归属于二级标签,当riskLevel为PASS时为空三级标签
riskDescriptionstring标签解释格式为"一级风险标签:二级风险标签:三级风险标签"的中文名称
对于命中用户自定义名单时返回:命中自定义名单
riskDetailjson_object风险详情信息风险详情,详见riskDetail说明
allLabelsjson_array全部的风险标签列表全部的风险标签列表,详见allLabels说明
businessLabelsjson_array业务标签列表传入audioBusinessType时会有,详见businessLabels说明
audioDetail中,riskDetail的每个元素详细内容如下:
参数名类型参数说明是否必返规范
riskSourceint风险来源风险来源,可选值:
1000:无风险
1001:文本风险
1002:视觉风险
1003:音频风险
audioTextstring音频转译文本的结果
matchedListsjson_array命中的客户自定义名单信息命中客户自定义名单时返回,其他时不存在,详见matchedLists说明
riskSegmentsjson_array高风险内容片段在涉政、暴恐、违禁、竞品、广告法等功能的时候存在,详见riskSegments说明
riskDetail中,matchedLists数组每个成员的具体内容如下:
参数名类型参数说明是否必返规范
namestring客户自定义名单名
wordsjson_array命中的这个名单中的敏感词信息下标从0开始计数,详见words说明
matchedLists中,words的每个元素详细内容如下:
参数名类型参数说明是否必返规范
wordstring敏感词
positionint_array敏感词所在位置下标从0开始计数
riskDetail中,riskSegments数组每个成员的具体内容如下:
参数名类型参数说明是否必返规范
segmentstring高风险内容片段
positionint_array高风险内容片段所在位置下标从0开始计数
audioDetail中,allLabels数组的每个成员的内容如下:
参数名类型参数说明是否必返规范
riskLabel1string一级风险标签一级风险标签
riskLabel2string二级风险标签二级风险标签
riskLabel3string三级风险标签三级风险标签
riskDescriptionstring风险描述格式为"一级风险标签:二级风险标签:三级风险标签"的中文名称
对于命中用户自定义名单时返回:命中自定义名单
riskLevelstring处置建议PASS:正常内容
REVIEW:可疑内容
REJECT:违规内容
probabilityfloat置信度可选值为0~1,值越大,可信度越高
riskDetailjson_object风险详情同audioDetail中的riskDetail结构一致
audioDetail中,businessLabels数组的每个成员的内容如下:
参数名类型参数说明是否必返规范
businessLabel1string一级标签一级标签
businessLabel2string二级标签二级标签
businessLabel3string三级标签三级标签
businessDescriptionstring标签描述格式为"一级标签:二级标签:三级标签"的中文名称
confidenceLevelint置信等级可选值在0~2之间,值越大,可信度越高
probabilityfloat置信度可选值为0~1,值越大,可信度越高
businessDetailJson_object详细信息
其中,tokenProfileLabels数组每个成员的具体内容如下:
参数名类型参数说明是否必返规范
label1string一级标签
label2string二级标签
label3string三级标签
descriptionstring标签描述
timestampint打标签时间戳13位Unix时间戳,单位:毫秒
其中,tokenRiskLabels数组每个成员的具体字段同tokenProfileLabels

imgBusinessType可选值列表#

业务标签识别类型类型说明备注
AGE人脸 - 年龄可识别未成年人
GENDER人脸 -性别
BEAUTY人脸 - 颜值
FACEDETECTION人脸-人脸检测如识别无人脸、真人、口罩人脸、正脸、侧脸等
FAKEFACE人脸 - 伪造人脸
RACE人脸-人种如黑种人、白种人、黄种人
PUBLICFIGURE人物 - 公众人物如识别知名明星、网红等
TAINTEDSTAR人物 - 劣迹人物
POSTURE人像-人像姿态如识别坐姿、跪姿等
DRESS人像 - 人像穿着如识别jk、汉服等
BODY人体如识别头发、眼睛、鼻子等
PICTUREFORM画面属性 - 画面类型如识别动漫、表情包等
PICTURESTRUCT画面属性-画面结构如识别宫格图、桥段图等
LOWVISION画面属性 - 画面低质如识别模糊、涂抹、马赛克等
LOWCONTNET画面属性 - 内容低质如识别点线密集、虫类密集等
LIVEPICTURE画面属性-直播画面如识别床上直播、开车直播等
SCREENSHOT画面属性 - APP截图(内容搬运)如识别朋友圈截图、聊天截图等
FITNESS场景主题-健身
CATE场景主题-美食
MUSIC场景主题-音乐
SPORTS场景主题-体育
SCENERY场景主题-自然风光如识别天空、大海、草原等
CITYVIEW场景主题-城市风光如识别街景
3CPRODUCTSLOGOLOGO - 3C电子类品牌如识别华为、小米、OPPO等LOGO
SHOPPINGAPPSLOGOLOGO - 购物比价类应用如识别拼多多等LOGO
RETOUCHAPPSLOGOLOGO - 拍摄美化类应用如识别快剪辑、秒拍等LOGO
SOCIALAPPSLOGOLOGO - 社交通讯类应用如识别微博、小红书等LOGO
PHOTOMATERIALLOGOLOGO - 素材版权类应用如识别CFP等LOGO
NEWSAPPSLOGOLOGO - 新闻阅读类应用如识别新浪、视觉中国等LOGO
ENTERTAINMENTAPPSLOGOLOGO - 影音娱乐类应用如识别抖音、快手等LOGO
SPORTSLOGOLOGO - 体育赛事如识别奥运会等LOGO
APPARELLOGOLOGO - 鞋帽服饰类品牌如识别VANS、H&M等LOGO
ACCESSORIESLOGOLOGO - 饰品首饰类品牌如识别AudemarsPiguet、Nomos等LOGO
COSMETICSLOGOLOGO - 化妆品类品牌如识别LOTTE、EyesLipsFace等LOGO
FOODLOGOLOGO - 食品类品牌如识别Starbucks、LOTTE等LOGO
VEHICLE物品-交通工具
BUILDING物品-建筑
TABLEWARE物品-餐具
FOOD物品-食物
HOMEAPPLICATION物品-家用电器
OFFICESUPPLIES物品-办公用品
FASHION物品-穿着用品
SPORTEQUIPMENT物品-运动器材
TOY物品-玩具
MAKEUP物品-化妆品
DRUGS物品-药品
PAINTING物品-绘画作品
ELECTRONIC物品-电子产品
MEDICALIMAGE物品-医疗影像
FURNITURE物品-家居用品
DAILYSUPPLIES物品-生活用品
CONSTELLATION物品-星座占卜
KITCHENWARE物品-厨房用品
KEEPSAKE物品 - 纪念品
MAMMAL动物-哺乳动物
BIRDS动物 - 鸟类
REPTILE动物-爬行动物
FISH动物-鱼
ARTHROPOD动物 - 节肢动物
COELENTERATE动物 - 腔肠动物
MOLLUSKS动物 - 软体动物
CRUSTACEAN动物 - 甲壳动物
PLANT植物
SETTING场所如识别卫生间、酒店、厨房等

接口响应码列表#

code请求返回码列表如下:

codemessage
1100成功
1101请求正在处理
1901QPS超限
1902参数不合法
1903服务失败
1907获取视频长度超时
9100余额不足
9101无权限操作

示例#

上传接口请求示例:#

{
"accessKey": "**********",
"appId": "default",
"btId": "1639824316368",
"eventId": "video",
"imgType": "POLITICS_VIOLENCE_BAN_PORN_MINOR_AD_SPAM_LOGO_STAR_OCR",
"imgBusinessType": "SCREEN_SCENCE_QR_FACE_QUALITY_MINOR_LOGO_BEAUTY_FACECOMPARE",
"audioType": "POLITICAL_PORN_AD_MOAN_ABUSE",
"audioBusinessType": "SING_LANGUAGE_MINOR_GENDER_TIMBRE",
"callback": "http://www.xxx.top/xxx",
"data": {
"btId": "1639824316368",
"channel": "video",
"detectFrequency": 3,
"advancedFrequency": {"durationPoints":[300,600],"frequencies":[1,5,10]},
"tokenId": "test",
"ip":"123.171.34.3",
"url": "http://oss.xxx.com/static/photo/117608703147396.mp4",
"returnAllAudio": 1,
"returnAllImg": 1,
"extra": {
"passThrough": {
"passThrough1": "透传字段1",
"passThrough2": "透传字段2",
"passThrough3": "透传字段3"
}
}
}
}

上传接口返回示例:#

{
"code": 1100,
"message": "成功",
"requestId": "1639824316368",
"btId": "1639824316368"
}

异步回调结果示例:#

{
"code": 1100,
"message": "成功",
"requestId": "66fb85e3149bb9e13d6c72161cc6c6cf",
"btId": "1666684506188",
"frameDetail": [
{
"allLabels": [
{
"probability": 0.665125370025635,
"riskDescription": "涉政:政治象征:党徽",
"riskDetail": {
"ocrText": {
"text": "2022/101/25 09:05"
},
"riskSource": 1002
},
"riskLabel1": "politics",
"riskLabel2": "zhengzhixiangzheng",
"riskLabel3": "danghui",
"riskLevel": "REJECT"
}
],
"auxInfo": {
"similarity": 0.4765625
},
"businessLabels": [
{
"businessDescription": "人脸:人脸姿态:正脸",
"businessDetail": {},
"businessLabel1": "face",
"businessLabel2": "renlianzitai",
"businessLabel3": "zhenglian",
"confidenceLevel": 1,
"probability": 0.450656906102068
},
{
"businessDescription": "人脸:人脸类型:真人",
"businessDetail": {
"face_num": 1,
"faces": [
{
"face_ratio": 0.00227673095650971,
"id": "f7bf8842f80a5a2192781064bd69e776",
"location": [
352,
237,
381,
278
],
"name": "郭荣铿",
"probability": 0.499512671029603
}
]
},
"businessLabel1": "face",
"businessLabel2": "renlianleixing",
"businessLabel3": "zhenren",
"confidenceLevel": 2,
"probability": 0.979977369308472
}
],
"imgText": "2022/101/25 09:05",
"imgUrl": "http://bj-video-1251671073.cos.ap-beijing.myqcloud.com/POST_VIDEO%2FPOST_VIDEO_IMG%2F20221025%2Fedaa113581ec1c18df7b44c86d36ae3b_v81.jpg?q-sign-algorithm=sha1&q-ak=AKIDg9LHyOYSAcmfHekZ6NN6XidHflbASUHn&q-sign-time=1666684548%3B1669276548&q-key-time=1666684548%3B1669276548&q-header-list=host&q-url-param-list=&q-signature=d7692c37694f1219092cbd3d7364481ab690d62e",
"requestId": "edaa113581ec1c18df7b44c86d36ae3b_v81",
"riskDescription": "涉政:政治象征:党徽",
"riskDetail": {
"ocrText": {
"text": "2022/101/25 09:05"
},
"riskSource": 1002
},
"riskLabel1": "politics",
"riskLabel2": "zhengzhixiangzheng",
"riskLabel3": "danghui",
"riskLevel": "REJECT",
"time": 81
},
{
"allLabels": [
{
"probability": 0.553634166717529,
"riskDescription": "涉政:政治象征:党徽",
"riskDetail": {
"ocrText": {
"text": "新器 20210/2509:05"
},
"riskSource": 1002
},
"riskLabel1": "politics",
"riskLabel2": "zhengzhixiangzheng",
"riskLabel3": "danghui",
"riskLevel": "REJECT"
}
],
"auxInfo": {
"similarity": 0.95703125
},
"businessLabels": [
{
"businessDescription": "人脸:人脸类型:无人脸",
"businessDetail": {},
"businessLabel1": "face",
"businessLabel2": "renlianleixing",
"businessLabel3": "wurenlian",
"confidenceLevel": 1,
"probability": 0.457959338261496
}
],
"imgText": "新器 20210/2509:05",
"imgUrl": "http://bj-video-1251671073.cos.ap-beijing.myqcloud.com/POST_VIDEO%2FPOST_VIDEO_IMG%2F20221025%2Fedaa113581ec1c18df7b44c86d36ae3b_v82.jpg?q-sign-algorithm=sha1&q-ak=AKIDg9LHyOYSAcmfHekZ6NN6XidHflbASUHn&q-sign-time=1666684549%3B1669276549&q-key-time=1666684549%3B1669276549&q-header-list=host&q-url-param-list=&q-signature=2606d67861e62622926d9d7f10037d70f068ceb5",
"requestId": "edaa113581ec1c18df7b44c86d36ae3b_v82",
"riskDescription": "涉政:政治象征:党徽",
"riskDetail": {
"ocrText": {
"text": "新器 20210/2509:05"
},
"riskSource": 1002
},
"riskLabel1": "politics",
"riskLabel2": "zhengzhixiangzheng",
"riskLabel3": "danghui",
"riskLevel": "REJECT",
"time": 82
}
],
"audioDetail": [
{
"allLabels": [
{
"probability": 0.998463273048401,
"riskDescription": "辱骂:人身攻击:重度人身攻击",
"riskDetail": {
"audioText": "操你妈,几个,那你几个一起干,操你妈,你和奶奶的都还在不捣蛋也不",
"riskSource": 1001
},
"riskLabel1": "abuse",
"riskLabel2": "renshengongji",
"riskLabel3": "zhongdurenshengongji",
"riskLevel": "REJECT"
}
],
"audioEndtime": 20,
"audioStarttime": 10,
"audioText": "操你妈,几个,那你几个一起干,操你妈,你和奶奶的都还在不捣蛋也不",
"audioUrl": "http://bj-video-1251671073.cos.ap-beijing.myqcloud.com/POST_VIDEO%2FPOST_VIDEO_AUDIO%2F20221025%2Fedaa113581ec1c18df7b44c86d36ae3b_a0001.wav?q-sign-algorithm=sha1&q-ak=AKIDg9LHyOYSAcmfHekZ6NN6XidHflbASUHn&q-sign-time=1666684511%3B1669276511&q-key-time=1666684511%3B1669276511&q-header-list=host&q-url-param-list=&q-signature=e87204b53077ddc763ddd2b7b5bd5e1382d4cc63",
"businessLabels": [],
"requestId": "edaa113581ec1c18df7b44c86d36ae3b_a0001",
"riskDescription": "辱骂:人身攻击:重度人身攻击",
"riskDetail": {
"audioText": "操你妈,几个,那你几个一起干,操你妈,你和奶奶的都还在不捣蛋也不",
"riskSource": 1001
},
"riskLabel1": "abuse",
"riskLabel2": "renshengongji",
"riskLabel3": "zhongdurenshengongji",
"riskLevel": "REJECT"
},
{
"allLabels": [
{
"probability": 0.857458027460472,
"riskDescription": "涉政:国家机构:国家机构",
"riskDetail": {
"audioText": "妈一起干,没事,让他报警,让他报警,找警察来,去干,备",
"riskSource": 1001
},
"riskLabel1": "politics",
"riskLabel2": "guojiajigou",
"riskLabel3": "guojiajigou",
"riskLevel": "REJECT"
}
],
"audioEndtime": 40,
"audioStarttime": 30,
"audioText": "妈一起干,没事,让他报警,让他报警,找警察来,去干,备",
"audioUrl": "http://bj-video-1251671073.cos.ap-beijing.myqcloud.com/POST_VIDEO%2FPOST_VIDEO_AUDIO%2F20221025%2Fedaa113581ec1c18df7b44c86d36ae3b_a0003.wav?q-sign-algorithm=sha1&q-ak=AKIDg9LHyOYSAcmfHekZ6NN6XidHflbASUHn&q-sign-time=1666684511%3B1669276511&q-key-time=1666684511%3B1669276511&q-header-list=host&q-url-param-list=&q-signature=fcf1b1275ca7dbafacaf06bd61cd05f5d612e9dc",
"businessLabels": [],
"requestId": "edaa113581ec1c18df7b44c86d36ae3b_a0003",
"riskDescription": "涉政:国家机构:国家机构",
"riskDetail": {
"audioText": "妈一起干,没事,让他报警,让他报警,找警察来,去干,备",
"riskSource": 1001
},
"riskLabel1": "politics",
"riskLabel2": "guojiajigou",
"riskLabel3": "guojiajigou",
"riskLevel": "REJECT"
},
{
"allLabels": [
{
"probability": 0.998539209365845,
"riskDescription": "辱骂:人身攻击:重度人身攻击",
"riskDetail": {
"audioText": "你别动他,别动他,让他报警,哎呀,日你妈了个逼,继干,你继续干,让他们",
"riskSource": 1001
},
"riskLabel1": "abuse",
"riskLabel2": "renshengongji",
"riskLabel3": "zhongdurenshengongji",
"riskLevel": "REJECT"
}
],
"audioEndtime": 70,
"audioStarttime": 60,
"audioText": "你别动他,别动他,让他报警,哎呀,日你妈了个逼,继干,你继续干,让他们",
"audioUrl": "http://bj-video-1251671073.cos.ap-beijing.myqcloud.com/POST_VIDEO%2FPOST_VIDEO_AUDIO%2F20221025%2Fedaa113581ec1c18df7b44c86d36ae3b_a0006.wav?q-sign-algorithm=sha1&q-ak=AKIDg9LHyOYSAcmfHekZ6NN6XidHflbASUHn&q-sign-time=1666684511%3B1669276511&q-key-time=1666684511%3B1669276511&q-header-list=host&q-url-param-list=&q-signature=55b6544e7408f29d4b7286690eb7494113ad7b31",
"businessLabels": [],
"requestId": "edaa113581ec1c18df7b44c86d36ae3b_a0006",
"riskDescription": "辱骂:人身攻击:重度人身攻击",
"riskDetail": {
"audioText": "你别动他,别动他,让他报警,哎呀,日你妈了个逼,继干,你继续干,让他们",
"riskSource": 1001
},
"riskLabel1": "abuse",
"riskLabel2": "renshengongji",
"riskLabel3": "zhongdurenshengongji",
"riskLevel": "REJECT"
}
],
"riskLevel": "REJECT",
"auxInfo": {
"frameCount": 2,
"time": 85
"passThrough": {
"passThrough1": "透传字段1",
"passThrough2": "透传字段2",
"passThrough3": "透传字段3"
}
}
}

在线咨询