数美智能文本识别产品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用于区分应用,可选值如下:
default:默认应用
额外应用值需数美单独分配提供
eventIdstring事件标识Y可选值如下:
额外事件值需数美单独分配提供
typestring检测的风险类型Y可选值:
DEFAULT:默认值(包含:
涉政、暴恐、违禁、色情、辱骂、广告、灌水、无意义、隐私、广告法、黑名单)
FRUAD:网络诈骗
UNPOACH:高价值用户防挖

以上type可以下划线组合,如:DEFAULT_FRUAD
businessTypestring检测的业务类型N可选值:
MINOR:未成年人
datajson_object请求的数据内容Y最长1MB, 详见data参数

其中,data的内容如下:

请求参数名类型参数说明是否必传规范
textstring需要检测的文本(200字内效果最佳)Y文本字数上限2000字,
若传递nickname字段,则会同时校验文本+昵称内容。
注意:有超过2000字以上文本内容建议联系数美协商
tokenIdstring用户账号标识, 建议使用贵司用户UID(可加密)自行生成 , 标识用户唯一身份用作灌水和广告等行为维度风控。
如无用户uid的场景建议使用唯一的数据标识传值
Y由数字、字母、下划线、短杠组成的长度小于等于64位的字符串
langstring文本内容语言类型Y可选值如下,(默认值为zh,传入auto自动识别失败时为en):
zh:中文
en:英文
ar:阿拉伯语
hi:印地语
es:西班牙语
fr:法语
ru:俄语
pt:葡萄牙语
id:印尼语
de:德语
ja:日语
tr:土耳其语
vi:越南语
it:意大利语
th:泰语
tl:菲律宾语
ko:韩语
ms:马来语
auto:自动识别
默认值zh,国内集群客户可传zh
nicknamestring用户昵称N校验昵称内容风险
ipstringip地址N发送该文本的的用户公网ipv4地址
deviceIdstring数美设备标识N数美设备指纹生成的设备唯一标识
extrajson_object辅助参数N用于辅助文本检测的相关信息,详见extra参数

data 中 extra数组每个元素的内容如下:

请求参数名类型参数说明是否必传规范
receiveTokenIdstring消息接收者的tokenId
eventId值为message时必传
N由数字、字母、下划线、短杠组成的长度小于等于64位的字符串
topicstring可为话题编号、书评区编号、论坛帖子编号
eventId值为article必传
N
atIdstringeventId值为groupChat必传用户在公开场景可以相互@,该参数用于传入被@用户的tokenIdN由数字、字母、下划线、短杠组成的长度小于等于64位的字符串
roomstring直播间/游戏房间编号
eventId值为groupChat时必传
N
levelint用户等级N可选值:
0:最低级用户,典型如新注册、完全不活跃或等级为0的用户等;
1:较低级用户,典型如低活跃或低等级用户等;
2:中等级用户,典型如具备一定活跃或等级中等的用户等;
3:较高级用户,典型如高活跃或高等级用户等;
4:最高级用户,典型如付费用户、VIP用户等
rolestring用户角色N用于区分直播/游戏行业不同角色的用户,可选值(默认为普通用户):
ADMIN:房管/管理员
HOST:主播
SYSTEM:系统
USER:普通用户
sexint性别N用于用户性别,可选值:
0:男性
1:女性
2:性别不明
isTokenSeparateint应用体系,取值为1时不同应用下的账号体系各自独立,账号相关的策略特征在不同应用下单独统计和生效N区分不同应用下的账号,可取值(默认值为0):
0:不区分
1:区分
passThroughJson透传字段非必传字段该字段内容会随着返回值一起返回

返回结果#

返回结果#

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

参数名称类型参数说明是否必返规范
codeint返回码Y1100:成功
1901:QPS超限
1902:参数不合法
1903:服务失败
9100:余额不足
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参数
auxlnfojson_object辅助信息Y详见auxlnfo参数
allLabelsjson_array辅助信息Y命中的所有风险标签以及详情信息。详见allLabels参数
businessLabelsjson_array辅助信息Y命中的所有业务标签以及详细信息。详见businessLabels参数
tokenProfileLabelsjson_array辅助信息N属性账号类标签。详见账号标签参数
tokenRiskLabelsjson_array辅助信息N风险账号类标签。详见账号标签参数

其中auxInfo字段如下:

参数名称类型参数说明是否必返规范
filteredTextstring辅助信息N敏感词被替换为*后的文本(该参数仅在命中敏感词时存在)
语境模型,联系方式相关风险不返回该字段
passThroughjson_object透传字段该字段内容与请求参数data中extra的passThrough的值相同。
contactResultjson_array辅助信息N联系方式识别结果,包含识别出的微信、微博、QQ、手机号的字符串类型和内容。 详见contactResult参数

auxInfo中,contactResult数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
contactTypeint辅助信息N联系方式类型,可选值区间【0-3】,详情如下:
0: 手机号
1: QQ号
2: 微信号
3: 微博号
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时间戳,单位:毫秒

一级标签的内容如下:

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

示例#

请求示例#

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

返回示例#

{
"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":"成功",
"requestId":"bb917ec5fa11fd02d226fb384968feb1",
"riskDescription":"广告:联系方式:联系方式",
"riskDetail":{
},
"riskLabel1":"ad",
"riskLabel2":"lianxifangshi",
"riskLabel3":"lianxifangshi",
"riskLevel":"REJECT"
}

购买咨询