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

请求参数#

请求URL:#

集群URL支持产品列表
北京http://api-text-bj.fengkongcloud.com/text/v4中文文本
上海http://api-text-sh.fengkongcloud.com/text/v4中文文本
广州http://api-text-gz.fengkongcloud.com/text/v4中文文本
美国(弗吉尼亚)http://api-text-fjny.fengkongcloud.com/text/v4中文文本
国际化文本
新加坡http://api-text-xjp.fengkongcloud.com/text/v4中文文本
国际化文本

字符编码格式:#

UTF-8字符集编码

请求方法:#

POST

建议超时时长:#

1s

请求参数:#

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

请求参数名类型参数说明是否必传规范
accessKeystring接口认证密钥Y由数美提供
appIdstring应用标识Y用于区分应用,需要联系数美服务开通,请使用数美单独提供的传值为准
eventIdstring事件标识Y需要联系数美服务开通,请使用数美单独提供的传值为准
typestring检测的风险类型Y可选值:
POLITY:涉政检测
VIOLENT:暴恐检测
BAN:违禁检测
EROTIC:色情检测
DIRTY:辱骂检测
ADVERT:广告检测
PRIVACY:隐私检测
ADLAW:广告法检测
MEANINGLESS:无意义检测
TEXTRISK:常规风险检测(包含:
涉政、暴恐、违禁、色情、辱骂、广告、隐私、广告法)
FRUAD:网络诈骗检测
UNPOACH:高价值用户防挖检测
TEXTMINOR: 未成年人内容检测
以上type可以下划线组合,如:TEXTRISK_FRUAD
type间组合取并集,如:TEXTRISK_POLITY按照常规风险检测处理
datajson_object请求的数据内容Y最长1MB, 详见data参数
kbTypestring知识库类型N知识库最大支持510个字符长度的输入,超出后本次请求文本内容无法匹配知识库。如需开通使用请联系数美商务
可选值:
PKB:启用涉政知识库功能
其中,data的内容如下:
请求参数名类型参数说明是否必传规范
textstring需要检测的文本Y单次请求字符数上限1万字,超过1万字符时会报错。
若传递nickname字段,则会同时校验文本+昵称内容。
tokenIdstring用户账号标识, 建议使用贵司用户UID(可加密)自行生成 , 标识用户唯一身份用作灌水和广告等行为维度风控。
如无用户uid的场景建议使用唯一的数据标识传值
Y由数字、字母、下划线、短杠组成的长度小于等于64位的字符串
langstring待检测的文本内容语种N可选值和对应语种如下:
zh:中文
en:英文
ar:阿拉伯语
hi:印地语
es:西班牙语
fr:法语
ru:俄语
pt:葡萄牙语
id:印尼语
de:德语
ja:日语
tr:土耳其语
vi:越南语
it:意大利语
th:泰语
tl:菲律宾语
ko:韩语
ms:马来语
auto:自动识别语种类型
默认值zh,国内集群客户可不传或zh;海外文本内容如果不能区分语种建议取值auto,系统会自动检测语种类型
nicknamestring用户昵称N校验昵称内容风险,长度限制150字符,超出部分会被截断
ipstringip地址N发送该文本的的用户公网ipv4地址
deviceIdstring数美设备标识N数美设备指纹生成的设备唯一标识
extrajson_object辅助参数N用于辅助文本检测的相关信息,详见extra参数
dataIdstring数据标识N数据标识
data 中 extra数组每个元素的内容如下:
请求参数名类型参数说明是否必传规范
receiveTokenIdstring私聊场景下消息接收者的tokenIdN由数字、字母、下划线、短杠组成的长度小于等于64位的字符串,eventId值为message时必传
topicstring可为话题编号、书评区编号、论坛帖子编号N传入的是帖子等数据(eventId值为article)时,开启上下文识别功能,建议传入,否则不能关联上下文
atIdstring群聊场景下被@用户的tokenIdN由数字、字母、下划线、短杠组成的长度小于等于64位的字符串,eventId值为groupChat必传
roomstring直播间/游戏房间编号N传入的是直播间、聊天室等数据(eventId值为groupChat)时,开启上下文识别功能,建议传入,否则不能关联上下文
sexint性别N用于用户性别,可选值:
0:男性
1:女性
2:性别不明
passThroughJson透传字段N该字段内容会随着返回值一起返回

返回结果#

返回结果#

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

参数名称类型参数说明是否必返规范
codeint返回码Y1100:成功
1901:QPS超限
1902:参数不合法
1903:服务失败
1905 : 字数超限
9101:无权限操作
messagestring返回码描述Y和code对应:
成功
QPS超限
参数不合法
服务失败
字数超限
无权限操作
requestIdstring请求标识Y本次请求数据的唯一标识,用于问题排查和效果优化,强烈建议保存
riskLevelstring处置建议Y可能返回值:
PASS:正常,建议直接放行
REVIEW:可疑,建议人工审核
REJECT:违规,建议直接拦截
riskLabel1string一级风险标签Y一级风险标签,当riskLevel为PASS时返回normal
riskLabel2string二级风险标签Y二级风险标签,当riskLevel为PASS时为空
riskLabel3string三级风险标签Y三级风险标签,当riskLevel为PASS时为空
riskDescriptionstring风险原因Y当riskLevel为PASS时为"正常"
riskDetailjson_object风险详情Y风险详情,详见riskDetail参数
tokenLabelsjson object辅助信息Y账号风险画像标签信息见下面详情内容。详见tokenLabels参数
auxInfojson_object辅助信息Y详见auxInfo参数
allLabelsjson_array辅助信息Y命中的所有风险标签以及详情信息。详见allLabels参数
businessLabelsjson_array辅助信息Y命中的所有业务标签以及详细信息。详见businessLabels参数
tokenProfileLabelsjson_array辅助信息N属性账号类标签。详见账号标签参数
tokenRiskLabelsjson_array辅助信息N风险账号类标签。详见账号标签参数
langResultjson_object语种信息N语种信息。详见语种信息参数
kbDetailjson_object知识库详情N知识库详情,详见kbDetail参数
finalResultint是否最终结果Y值为1,贵司可直接拿返回结果进行处置、分发等下游场景的使用
值为0,说明该结果为数美风控的过程结果,还需要经过数美人审再次check后回传贵司
resultTypeint当前结果是机审还是人审环节结果Y0:机审,1:人审
disposaljson_object处置和映射结果N数美可按照贵司的标签体系和标识进行返回;未配置自定义标签体系则不返回该字段
其中,disposal结构如下:
返回结果参数名参数类型参数说明是否必返规范
riskLevelstring处置建议若贵司有自己的处置规则,数美可按照贵司的处置逻辑配置并返回对应的处置建议;若规则标签未映射上,则返回默认处置建议
riskLabel1string映射后一级风险标签Y一级风险标签,当数美标签未映射上自定义标签,且disposal下的riskLevel为PASS时,riskLabel1值为normal
riskLabel2string映射后二级风险标签Y二级风险标签,当数美标签未映射上自定义标签,且disposal下的riskLevel为PASS时,riskLabel2值为空
riskLabel3string映射后三级风险标签Y三级风险标签,当数美标签未映射上自定义标签,且disposal下的riskLevel为PASS时,riskLabel3值为空
riskDescriptionstring映射后风险原因Y当riskLevel为PASS时为"正常"
riskDetailjson_object映射后风险详情Y详见riskDetail参数
其中,语种信息langResult结构如下:
参数名称类型参数说明是否必返规范
detectedLangstring语种识别结果N当在国际化文本产品下传入lang的值为auto时返回该字段。值为标准语言代码表,例如:"zh"、"en"、"ar"等
其中auxInfo字段如下:
参数名称类型参数说明是否必返规范
filteredTextstring辅助信息N敏感词被替换为*后的文本(该参数仅在命中敏感词时存在)
语境模型,联系方式相关风险不返回该字段
passThroughjson_object透传字段该字段内容与请求参数data中extra的passThrough的值相同。
contactResultjson_array辅助信息N联系方式识别结果,包含识别出的微信、QQ、手机号的字符串类型和内容。 详见contactResult参数
unauthorizedTypestring辅助信息N未授权的type。
auxInfo中,contactResult数组每个元素的内容如下:
参数名称类型参数说明是否必返规范
contactTypeint辅助信息N联系方式类型,可选值区间【0-3】,详情如下:
0: 手机号
1: QQ号
2: 微信号
contactStringstring辅助信息N联系方式串
其中,riskDetail的内容如下:
参数名称类型参数说明是否必返规范
matchedListsjson_array辅助信息N命中的客户自定义名单列表。详见matchedLists参数
riskSegmentsjson_array辅助信息,高风险内容片段检测文本包含涉政、暴恐、违禁、广告法等风险内容的时候存在N详见riskSegments参数
riskDetail中,matchedLists数组每个元素的内容如下:
参数名称类型参数说明是否必返规范
namestring辅助信息N命中的名单名称
wordsjson_array辅助信息N命中的敏感词数组。详见words参数
matchedLists中,words数组每个元素的内容如下:
参数名称类型参数说明是否必返规范
wordstring辅助信息N命中的敏感词
positionint_array辅助信息N敏感词所在位置
riskDetail中,riskSegments的内容如下:
参数名称类型参数说明是否必返规范
segmentstring辅助信息N高风险内容片段
positionint_array辅助信息N高风险内容片段所在位置
其中,tokenLabels的详情内容:
参数名称类型参数说明是否必返规范
UGC_account_riskjson_object辅助信息NUGC内容相关风险。详见UGC_account_risk参数
tokenLabels中,UGC_account_risk的详情内容如下:
参数名称类型参数说明是否必返规范
sexy_risk_tokenidfloat辅助信息N色情账号风险分取值区间[0-1]
其中,allLabels的内容如下:
参数名称类型参数说明是否必返规范
riskLabel1stringallLabels不为空时必返Y一级风险标签
riskLabel2stringallLabels不为空时必返Y二级风险标签
riskLabel3stringallLabels不为空时必返Y三级风险标签
riskDescriptionstringallLabels不为空时必返Y风险原因
probabilityfloat置信度Y可选值在0~1之间,值越大,可信度越高 注意:allLabels不为空时必返
riskDetailjson_object风险详情Y格式与上层riskDetail结构相同 注意:allLabels不为空时必返
riskLevelstring风险等级Y可能返回值:
REVIEW:可疑
REJECT:违规
其中,businessLabels的内容如下:
参数名称类型参数说明是否必返规范
businessLabel1stringbusinessLabels不为空必返Y一级业务标签
businessLabel2stringbusinessLabels不为空必返Y二级业务标签
businessLabel3stringbusinessLabels不为空必返Y三级业务标签
businessDescriptionstringbusinessLabels不为空必返Y标签描述
probabilityfloatbusinessLabels不为空必返
可选值在0~1之间,值越大,可信度越高
Y置信度
businessDetailJson_objectbusinessLabels不为空必返Y业务详情
其中,tokenProfileLabels、tokenRiskLabels的内容如下:
参数名称类型参数说明是否必返规范
label1string一级标签
label2string二级标签
label3string三级标签
descriptionstring标签描述
timestampInt打标签时间戳13位Unix时间戳,单位:毫秒
其中,kbDetail字段内容如下:
参数名称类型参数说明是否必返规范
qlabelstring问题标签Y可选值:
UNKNOWN: 没有匹配
CANNOT_ASK:问题本身不可提问/不可输入
EXACTNESS:问题答案必须正确。包括立场正确
POSITIVE:问题答案需要包含正向引导
answerstring建议答案Y当qlabel为“EXACTNESS”或者“POSITIVE”时,会给出数美建议的符合要求的答案。

当lang字段取值zh,或取值auto被识别为中文时,一级标签的内容如下:

一级标签一级标识类型备注
涉政politics监管标签type值为TEXTRISK
暴恐violence监管标签type值为TEXTRISK
色情porn监管标签type值为TEXTRISK
违禁ban监管标签type值为TEXTRISK
辱骂abuse监管标签type值为TEXTRISK
广告法ad_law监管标签type值为TEXTRISK
广告ad监管标签type值为TEXTRISK
黑名单blacklist监管标签type值为TEXTRISK
无意义meaningless监管标签type值为TEXTRISK
隐私privacy监管标签type值为TEXTRISK
网络诈骗fraud监管标签type值为FRUAD
未成年人minor监管标签type值为TEXTMINOR

当为非中文时,一级标签的内容如下:

一级标签一级标识类型备注
涉政Politics监管标签type值为TEXTRISK
暴恐Violence监管标签type值为TEXTRISK
色情Erotic监管标签type值为TEXTRISK
违禁Prohibit监管标签type值为TEXTRISK
辱骂Abuse监管标签type值为TEXTRISK
广告Ads监管标签type值为TEXTRISK
黑名单Blacklist监管标签type值为TEXTRISK

示例#

请求示例#

{
"accessKey":"*************",
"appId":"default",
"eventId":"text",
"type":"TEXTRISK",
"data":
{
"text":"加个好友吧 qq12345",
"tokenId":"4567898765jhgfdsa",
"ip":"118.89.214.89",
"deviceId":"*************",
"nickname":"***********",
"extra":
{
"topic":"12345",
"atId":"username1",
"room":"ceshi123",
"receiveTokenId":"username2"
}
}
}

返回示例#

{
"allLabels":[
{
"probability":1,
"riskDescription":"涉政:涉政:涉政",
"riskDetail":{
},
"riskLabel1":"politics",
"riskLabel2":"shezheng",
"riskLabel3":"shezheng",
"riskLevel":"REVIEW"
},
{
"probability":0.95559550232975,
"riskDescription":"广告:加好友:加好友",
"riskDetail":{
},
"riskLabel1":"ad",
"riskLabel2":"jiahaoyou",
"riskLabel3":"jiahaoyou",
"riskLevel":"REJECT"
},
{
"probability":1,
"riskDescription":"广告:联系方式:联系方式",
"riskDetail":{
},
"riskLabel1":"ad",
"riskLabel2":"lianxifangshi",
"riskLabel3":"lianxifangshi",
"riskLevel":"REJECT"
}
],
"auxInfo":{
"contactResult":[
{
"contactString":"qq12345",
"contactType":2
}
],
"filteredText":"加个好友吧 qq12345"
},
"businessLabels":[
],
"code":1100,
"message":"成功",
"finalResult":1,
"resultType":0,
"requestId":"bb917ec5fa11fd02d226fb384968feb1",
"riskDescription":"广告:联系方式:联系方式",
"riskDetail":{
},
"riskLabel1":"ad",
"riskLabel2":"lianxifangshi",
"riskLabel3":"lianxifangshi",
"riskLevel":"REJECT"
}

在线咨询