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

版权所有 翻版必究

目录

智能文档过滤服务接入说明#

请求参数#

请求URL：#

集群URL支持产品列表
北京http://api-article-bj.fengkongcloud.com/v1/saas/anti_fraud/article文档产品

字符编码格式：#

UTF-8字符集编码

请求方法：#

POST

建议超时时长：#

15s

请求参数：#

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

请求参数名类型参数说明是否必传规范
accessKeystring接口认证密钥Y由数美提供
typestring平台业务类型N可选值：
ZHIBO:直播
ECOM:电商
GAME:游戏
NEWS:新闻资讯
FORUM:论坛
SOCIAL:社交
NOVEL:小说
imgTypestring文档中的图片识别类型N可选值：
POLITICS:涉政识别
PORN:色情识别
AD:广告识别
LOGO:水印logo识别
BEHAVIOR:不良场景识别，支持吸烟、喝酒、赌博、吸毒、避孕套和无意义画面
OCR:图片中的OCR文字识别
VIOLENCE:暴恐识别
NONE:不需要识别图片
如需做组合识别，通过下划线连接即可，例 如 POLITICS_PORN_AD 用于广告、色情和涉政识别
不传时按涉政、色情、广告进行识别。
txtTypestring文档中的文字识别类型N可选值：
DEFAULT:识别涉政、暴恐、违禁、色情、辱骂、广告
NONE:不需要识别文本
不传时按传入default处理。
appIdstring应用标识N用于区分相同公司的不同应用，该参数传递值可与数美服务协商
callbackstring回调http接口N当该字段非空时，服务将根据该字段回调通知用户审核结果；当传入fileFormat时必传
callbackParamjson_object透传字段N当 callback 存在时可选，发送回调请求时服务将该字段内容同审核结果一起返回
datajson_object请求的数据内容Y最长1MB, 详见data参数

其中，data的内容如下：

请求参数名类型参数说明是否必传规范
contentsstring要检测的内容Y可填入url链接
其中url支持网址链接或文档下载链接
文件大小500m以内，文本长度限制50w字。图片张数限制500张。
fileFormatstring要检测的文档格式Y可选值：
DOCX
PDF
DOC
XLS
XLSX
PPT
PPTX
PPS
PPSX
XLTX
XLTM
XLSB
XLSM
TXT
CSV
EPUB
SRT
VTT
若fileFormat与文档实际格式不一致，则返回报错参数错误
tokenIdstring客户端用户账号唯一标识，用于用户行为分析，建议传入用户UIDY
channelstring业务场景N渠道表配置
returnHtmlbool是否需要返回数美审核后高亮框处风险内容的html，用与展示给审核人员看N可选值:
true
false
默认为false
nicknamestring用户昵称，强烈建议传递此参数，几乎所有平台的恶意用户都会通过昵称散播垃圾信息，存在涉政违禁和导流信息等风险N
ipstring客户端ip地址，该参数用于IP维度的用户行为分析，同时可用于比对数美IP黑库N
passThroughjson_object透传参数，原样返回N

返回结果#

回调模式#

系统会自动推送机审结果至callback字段指定的URL上

请求返回参数：#

参数名称类型参数说明是否必返规范
codeint返回码Y1100：成功
1901：QPS超限
1902：参数不合法
1903：服务失败
9100：余额不足
9101：无权限操作
messagestring返回码描述Y和code对应：
成功
QPS超限
参数不合法
服务失败
余额不足
无权限操作
requestIdstring请求标识Y本次请求数据的唯一标识,用于问题排查和效果优化，强烈建议保存
scoreint风险分数Ncode为1100时存在，取值范围[0,1000]，分数越高风险越大
riskLevelstring处置建议N可能返回值：
PASS：正常，建议直接放行
REVIEW：可疑，建议人工审核
REJECT：违规，建议直接拦截
detailjson_object风险详情N详见detail参数

回调返回参数：#

参数名称类型参数说明是否必返规范
codeint返回码Y1100：成功
1901：QPS超限
1902：参数不合法
1903：服务失败
9100：余额不足
9101：无权限操作
messagestring返回码描述Y和code对应：
成功
QPS超限
参数不合法
服务失败
余额不足
无权限操作
requestIdstring请求标识Y本次请求数据的唯一标识,用于问题排查和效果优化，强烈建议保存
scoreint风险分数Ncode为1100时存在，取值范围[0,1000]，分数越高风险越大
riskLevelstring处置建议N可能返回值：
PASS：正常，建议直接放行
REVIEW：可疑，建议人工审核
REJECT：违规，建议直接拦截
detailjson_object风险详情N详见detail参数
statusint提示服务是否超时Y可能返回值：
0：正常
501：超时
auxInfojson_object辅助信息Y详见auxInfo参数
callbackParamjson_object透传字段N透传参数，原样返回
其中detail字段如下：
参数名称类型是否必选说明
modelstringY规则标识
descriptionstringY策略规则风险原因描述
riskSummaryjson objectN风险摘要，目前包括各种风险类型的次数，如果type为NOVEL才返回
格式请见riskSummary结果详情
riskDetailjson arrayN每一段内容的风险详情，如果type为NOVEL才返回。如果returnHtml参数为true只返回REJECT和REVIEW的风险内容片段，如果returnHtml参数为false会返回全部内容片段（包括REJECT和REVIEW和PASS）。
格式请见riskDetail结果详情
riskHtmlstringN风险内容标记的html,可嵌入需要展示的html页面，如果type为NOVEL且returnHtml参数为true才返回。
hitsjson_arrayN命中信息，一般为空。命中详情在riskDetail中。
passThroughjson_objectN透传参数，原样返回

其中，riskSummary内容是风险类型，具体如下：

参数名称类型参数说明是否必返规范
riskTypeint对应riskType风险出现的次数N风险类型：
0：正常
100：涉政
200：色情
210：辱骂
300：广告
400：灌水
500：无意义
600：违禁
700：黑名单
710：白名单
800：高危账号
900：自定义

其中，riskDetail是json array，其中每一项是一个内容片段的风险详情，具体如下：

参数名称类型参数说明是否必返规范
typestring当前内容片段的类型Y可选值：
text：文本
image：图片
contentstring当前内容片段的内容Ytext是文本内容，image是图片url
beginPositionint当前内容片段在输入中的起始位置，当type为image时该字段不返回N检测出的文本内容，从0开始计算位置；文本切分后，每个片段的文本内容的首字在全局检测出文本中的位置
endPositionint当前内容片段在输入中的结束位置，当type为image时该字段不返回N检测出的文本内容，从0开始计算位置；文本切分后，每个片段的文本内容的末尾字在全局检测出文本中的位置
descriptionstring当前内容片段的风险描述Y命中的对应名单中的所有敏感词
riskLevelstring当前内容片段的处置建议Y可选值：
PASS：通过
REVIEW：审核
REJECT: 拒绝
riskTypeint当前内容片段的标识风险类型Y当type为文本时：
0：正常
100：涉政
200：色情
210：辱骂
300：广告
400：灌水
500：无意义
600：违禁
700：黑名单
710：白名单
800：高危账号
900：自定义

当type为图片时：
0：正常
100：涉政
200：色情
210：性感
300：广告
310：二维码
320：水印
400：暴恐
500：违规
510：不良场景
520：未成年人
700：黑名单
710：白名单
800：高危账号
900：自定义
riskTypeDecstringriskType对应的描述N
modelstring规则标识，用来标识文本命中的策略规则N
matchedListstring命中敏感词所在的名单名称（该参数仅在命中敏感词时存在）N
matchedItemstring命中的具体敏感词（该参数仅在命中敏感词时存在）N
matchedFieldstring标识昵称或文本内容命中了敏感词（该参数仅在命中敏感词时存在）N可选值：
text：文本命中敏感词
nickname：昵称命中敏感词
matchedDetailjson_array命中的名单详情N详见详细结构
indexint当前处理的片段索引N索引不区分文本和图片
keywordsPositionstring命中的敏感词位置N在该段中的位置
textstring图片中的ocr内容N图片片段识别出ocr内容时会返回该字段

其中，matchedDetail结构如下:

参数名称类型参数说明是否必返规范
listIdstringY返回码
matchedFiledstring_arrayN标识昵称或文本内容命中了敏感词（该参数仅在命中敏感词时存在），可选值：
text：文本命中敏感词
nickname：昵称命中敏感词
namestringY命中敏感词所在的名单名称
organizationstringN命中名单所属的公司标识，其中“GLOBAL”为全局名单
wordsstring_arrayN命中的对应名单中的所有敏感词
wordPositionsjson_arrayN命中的对应名单中的所有敏感词及位置。详见wordPositions
wordPositions中的每一项内容：
参数名称类型参数说明是否必返规范
wordstring辅助信息N命中的敏感词
positionstring辅助信息N敏感词所在位置
其中auxInfo字段如下：
参数名称类型参数说明是否必返规范
textNumint当前请求中的字符数，与计费数目一致Y当前请求中的字符数，其中字符数包括汉字，英文，标点符号，空格等
imgNumint当前请求中的图片数，与计费数目一致Y当前请求中的图片数，如遇动图会截取3帧；如遇长图会进行切分

示例#

回调模式#

请求示例#

{"accessKey":"xxxxxxxx",
"type":"NOVEL",
"appId":"xxxx",
"callback":"",
"callbackParam":{
"callbackId":"Id123"
},
"data":{
"tokenId":"xxxx",
"contents":"xxxx",
"returnHtml":true
}
}

响应示例#

{
"code": 1100,
"message": "成功",
"requestId": "xxxxxxxxxxxxxxxxxx",
"score": 0,
"riskLevel": "PASS",
"detail": {
"description": "正常",
"model": "M1000",
"riskType": 0
},
"status": 0
}
回调结果:
{
"code":1100,
"message":"成功",
"requestId":"xxxxxxxxxxxxxxxxxx",
"score":700,
"riskLevel":"REJECT",
"callbackParam":{
"callbackId":"Id123"
}
"detail":{
"description":"图片违规",
"hits":[
],
"model":"M04301",
"riskDetail":[
{
"beginPosition":1235,
"content":"为了防范电信网络诈骗，如网民接到962110电话，请立即接听",
"description":"包含联系方式",
"endPosition":1264,
"index":287,
"model":"",
"riskLevel":"REJECT",
"riskType":300,
"type":"text"
},
{
"content":"http://icon.qiantucdn.com/img/searchnew/wechat-g.png",
"description":"二维码",
"index":281,
"model":"",
"riskLevel":"REJECT",
"riskType":300,
"type":"image"
}
],
"riskHtml":"xxxx",
"riskSummary":{
"300":5
}
},
"status":0,
"auxInfo":{
"textNum":"100",
"imgNum":"10"
}
}

智能文档过滤上传接口#

请求参数#

请求URL：#

集群URL支持产品列表
北京http://api-article-bj.fengkongcloud.com/v1/saas/anti_fraud/article_async文档产品

字符编码格式：#

UTF-8字符集编码

请求方法：#

POST

建议超时时长：#

5s

请求参数：#

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

请求参数名类型参数说明是否必传规范
accessKeystring接口认证密钥Y由数美提供
typestring平台业务类型N可选值：
ZHIBO:直播
ECOM:电商
GAME:游戏
NEWS:新闻资讯
FORUM:论坛
SOCIAL:社交
NOVEL:小说
imgTypestring文档中的图片识别类型N可选值：
POLITICS:涉政识别
PORN:色情识别
AD:广告识别
LOGO:水印logo识别
BEHAVIOR:不良场景识别，支持吸烟、喝酒、赌博、吸毒、避孕套和无意义画面
OCR:图片中的OCR文字识别
VIOLENCE:暴恐识别
NONE:不需要识别图片
如需做组合识别，通过下划线连接即可，例 如 POLITICS_PORN_AD 用于广告、色情和涉政识别
txtTypestring文档中的文字识别类型N可选值：
DEFAULT:识别涉政、暴恐、违禁、色情、辱骂、广告
NONE:不需要识别文本
不传时按传入default处理。
appIdstring应用标识N用于区分相同公司的不同应用，该参数传递值可与数美服务协商
datajson_object请求的数据内容Y最长1MB, 详见data参数

其中，data的内容同同步接口：

返回结果#

请求返回参数#

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

参数名称类型参数说明是否必返规范
codeint返回码Y1100：成功
1901：QPS超限
1902：参数不合法
1903：服务失败
9100：余额不足
9101：无权限操作
messagestring返回码描述Y和code对应：
成功
QPS超限
参数不合法
服务失败
余额不足
无权限操作
requestIdstring请求标识Y本次请求数据的唯一标识,用于问题排查和效果优化，强烈建议保存

示例#

请求示例#

{
"accessKey":"xxxxxxxx",
"type":"NOVEL",
"callback":"",
"txtType":"",
"imgType":"",
"requestId":"",
"tokenId":"",
"serviceId":"POST_ARTICLE",
"appId":"",
"data":{
"channel":"",
"contents":"<div>凡涉及到发进来客人爱斯达克解放军阿卡丽色绕口令加凉开水的解放路口而爱上对方<img src=\"http://www.chedan5.net/upload/article/202012/05/1854275fcb66e37e370KkBbBv_thumb.jpg\" alt=\"图片加载失败\"></div>",
"returnHtml":true,
"itemId":"CHAPTER_CONTENT_0",
"tokenId":"49930319"
}
}

响应示例#

{
"code":1100,
"message":"\u6210\u529f",
"requestId":"tye7ert12asdfasdf31236444442333312"
}

结果查询接口#

该接口用于查询机审和人审识别结果

请求参数#

请求URL：#

集群URL支持产品列表
北京http://api-article-bj.fengkongcloud.com/v1/saas/anti_fraud/article/query文档产品

字符编码格式：#

UTF-8字符集编码

请求方法：#

POST

建议超时时长：#

1s

请求参数：#

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

请求参数名类型参数说明是否必传规范
accessKeystring接口认证密钥Y由数美提供
requestIdsarray机器审核流水号Y最多支持10条 字符串数组 item 为数美返回的流水号

返回结果#

请求返回参数#

请求参数名类型参数说明是否必传规范
codeint返回码Y
messagestring返回码描述Y
contentsjson array内容Y详见contents内容
其中contents组成如下
请求参数名类型参数说明是否必传规范
requestIdstring请求唯一标识Y
humanResultjson object人审结果，人审完成后才会存在N
machineResultjson object机审结果，机审完成后才会存在N参考回调接口返回字段
mergeResultjson_object统一人审和机审结果N优先返回人审结果，如果人审结果没有，返回机审结果，如果都没有不存在

其中，humanResult/mergeResult的内容如下：

请求参数名类型参数说明是否必传规范
riskLevelstring处置指令Y建议取值：
REJECT:删除
PASS:发布

示例#

请求示例#

{
"accessKey":"xxxxxxxx",
"requestIds":[
"tye7ert12asdfasdf31236633346662333312"
]
}

响应示例#

{
"code":1100,
"message":"正常",
"contents":[
{
"requestId":"tye7ert12asdfasdf31236633346662333312",
"machineResult":{
"code":1100,
"detail":{
"description":"文本违规",
"hits":[
{
"description":"广告：广告：广告",
"descriptionV2":"广告：广告：广告",
"model":"MA000007020001001",
"riskLevel":"REJECT",
"riskType":300,
"score":650,
"type":"text"
}
],
"model":"M03101",
"riskDetail":[
{
"beginPosition":0,
"content":"凡涉及到发进来客人爱斯达克解放军阿卡丽色绕口令加凉开水的解放路口而爱上对方",
"description":"广告：广告：广告",
"endPosition":36,
"index":0,
"keywordsPosition":"8",
"matchedDetail":[
{
"listId":"9da189a5bf1919d242d745f19ea3e5d7",
"matchedFiled":[
"text"
],
"name":"原文名单",
"organization":"12312312",
"wordPositions":[
{
"position":"8",
"word":"人"
}
],
"words":[
"人"
]
},
{
"listId":"cf5c160194954812fc279d3045fe3237",
"matchedFiled":[
"text"
],
"name":"同音",
"organization":"RlokQwRlVjUrTUlkIqOg",
"wordPositions":[
{
"position":"22",
"word":"零"
}
],
"words":[
"零"
]
},
{
"listId":"d75d056d88702cbf6198e2aa82eb0fdc",
"matchedFiled":[
"text"
],
"name":"涉政_国家机构_军队",
"organization":"GLOBAL",
"wordPositions":[
{
"position":"13,14,15",
"word":"解放軍"
}
],
"words":[
"解放軍"
]
},
{
"listId":"70cecfffebf31c2ac2b612cc3b6af142",
"matchedFiled":[
"text"
],
"name":"涉政词库3",
"organization":"RlokQwRlVjUrTUlkIqOg",
"wordPositions":[
{
"position":"0",
"word":"解放軍"
}
],
"words":[
"解放軍"
]
}
],
"matchedItem":"人",
"matchedList":"原文名单",
"model":"MA000007020001001",
"riskLevel":"REJECT",
"riskType":300,
"type":"text"
}
],
"riskHtml":"\u003cdiv class=\"list\" style=\"position: relative;\"\u003e\u003cdiv class=\"list\" style=\"position: relative;\"\u003e\u003cdiv style=\"width: 70%;text-align: left;padding: 0px 20px;min-height: 20px;margin-bottom: 5px;line-height: 1.5;word-break: break-all;display:inline-block;border: 1px solid red;padding:10px;\"\u003e\u003cspan\u003e凡涉及到发进来客\u003cspan style=\"color:red;font-weight:bold;display:inline-block;\"\u003e人\u003c/span\u003e爱斯达克解放军阿卡丽色绕口令加凉开水的解放路口而爱上对方\u003c/span\u003e\u003c/div\u003e\u003cdiv style=\"position: absolute;top: 50%;left: 75%;transform: translateY(-50%);width: 20px;height: 20px;background-color: rgb(255, 255, 255);color:red;\"\u003e\u0026gt;\u003c/div\u003e\u003cdiv style=\"width: 30%;position: absolute;right: 20px;top: 50%;transform: translateY(-50%);text-align: center;display:inline-block;\"\u003eMA000007020001001(广告：广告：广告-人)\u003c/div\u003e\u003c/div\u003e\u003cdiv class=\"list\" style=\"position: relative;\"\u003e\u003cdiv style=\"width: 70%;text-align: left;padding: 0px 20px;min-height: 20px;margin-bottom: 5px;line-height: 1.5;word-break: break-all;display:inline-block;border: 1px ;padding:10px;text-align:center;\"\u003e\u003cimg src=\"http://www.chedan5.net/upload/article/202012/05/1854275fcb66e37e370KkBbBv_thumb.jpg\" alt=\"图片加载失败\"/\u003e\u003c/div\u003e\u003c/div\u003e",
"riskSummary":{
"300":1
}
},
"message":"正常",
"requestId":"tye7ert12asdfasdf31236633346662333312",
"riskLevel":"REJECT",
"score":700,
"auxInfo":{
"textNum":"100",
"imgNum":"10"
},
"mergeResult":{
"riskLevel":"REJECT"
}
}
]
}
7天免费试用

  • 专属顾问全程服务

  • 个性化制定解决方案

  • 全天候响应问题随时解决

在线咨询

京公网安备 11010502032103号 | 京ICP备15044177号

Copyright©2015-2024 shumei All Rights Reserved