请求接口#编码#UTF-8字符集编码请求方法#POST建议超时时间#1s请求#请求地址#集群请求地址支持产品列表北京http://api-text-bj.fengkongcloud.com/text/v4中文文本上海http://api-text-sh.fengkongcloud.com/text/v4中文文本美国(弗吉尼亚)http://api-text-fjny.fengkongcloud.com/text/v4中文文本、国际化文本新加坡http://api-text-xjp.fengkongcloud.com/text/v4中文文本、国际化文本请求参数#参数名称类型参数说明是否必传规范accessKeystring接口认证密钥是由数美提供appIdstring应用标识是用于区分应用,需要联系数美服务开通,请使用数美单独提供的传值为准eventIdstring事件标识是需要联系数美服务开通,请使用数美单独提供的传值为准typestring检测的风险类型是可选值: POLITY:涉政检测 VIOLENT:暴恐检测 BAN:违禁检测 EROTIC:色情检测 DIRTY:辱骂检测 ADVERT:广告检测 PRIVACY:隐私检测 ADLAW:广告法检测 MEANINGLESS:无意义检测 TEXTRISK:常规风险检测(包含:涉政、暴恐、违禁、色情、辱骂、广告、隐私、广告法、无意义) FRUAD:网络诈骗检测 UNPOACH:高价值用户防挖检测 TEXTMINOR:未成年人内容检测 以上type可以下划线组合,如:TEXTRISK_FRUAD type间组合取并集,如:TEXTRISK_POLITY按照常规风险检测处理datajson_object请求的数据内容是最长1MBtextstring需要检测的文本是单次请求字符数上限1万字,超过1万字符时会报错。若传递nickname字段,则会同时校验文本+昵称内容。relateTextstring需要检测的关联文本否文本字数上限128字,超过128字只截取前128字进行识别。传入此字段会结合text一起检测。tokenIdstring用户账号标识,建议使用贵司用户UID(可加密)自行生成,标识用户唯一身份用作灌水和广告等行为维度风控。如无用户uid的场景建议使用唯一的数据标识传值是由数字、字母、下划线、短杠组成的长度小于等于64位的字符串langstring待检测的文本内容语种否可选值和对应语种如下: zh:中文 en:英文 ar:阿拉伯语 hi:印地语 es:西班牙语 fr:法语 ru:俄语 pt:葡萄牙语 id:印尼语 de:德语 ja:日语 tr:土耳其语 vi:越南语 it:意大利语 th:泰语 tl:菲律宾语 ko:韩语 ms:马来语 auto:自动识别语种类型 默认值zh,国内集群客户可不传或zh;海外文本内容如果不能区分语种建议取值auto,系统会自动检测语种类型nicknamestring用户昵称否校验昵称内容风险,长度限制150字符,超出部分会被截断ipstringip地址否发送该文本的用户公网ipv4或ipv6地址deviceIdstring数美设备标识否数美设备指纹生成的设备唯一标识extrajson_object辅助参数否用于辅助文本检测的相关信息receiveTokenIdstring私聊场景下消息接收者的tokenId否由数字、字母、下划线、短杠组成的长度小于等于64位的字符串,eventId值为message时必传topicstring可为话题编号、书评区编号、论坛帖子编号否传入的是帖子等数据(eventId值为article)时,开启上下文识别功能,建议传入,否则不能关联上下文atIdstring群聊场景下被@用户的tokenId否由数字、字母、下划线、短杠组成的长度小于等于64位的字符串,eventId值为groupChat时必传roomstring直播间/游戏房间编号否传入的是直播间、聊天室等数据(eventId值为groupChat)时,开启上下文识别功能,建议传入,否则不能关联上下文sexint性别否可选值: 0:男性 1:女性 2:性别不明passThroughjson透传字段否该字段内容会随着返回值一起返回dataIdstring数据标识否数据标识kbTypestring知识库类型否知识库最大支持510个字符长度的输入,超出后本次请求文本内容无法匹配知识库。如需开通使用请联系数美商务 可选值: PKB:启用涉政知识库功能translationTargetLangstring翻译目标语种否将输入的文本翻译成目标语种。如需开通使用请联系数美商务 可选值: zh:中文 en:英文响应#返回参数#以下参数,除code、message、requestId以外,其他必返参数均为在code返回1100时为必返。参数名称类型参数说明是否必返规范codeint返回码是1100:成功 1901:QPS超限 1902:参数不合法 1903:服务失败 1905:字数超限 9101:无权限操作messagestring返回码描述是和code对应:成功、QPS超限、参数不合法、服务失败、字数超限、无权限操作requestIdstring请求标识是本次请求数据的唯一标识,用于问题排查和效果优化,强烈建议保存riskLevelstring处置建议是可能返回值: PASS:正常,建议直接放行 REVIEW:可疑,建议人工审核 REJECT:违规,建议直接拦截riskLabel1string一级风险标签是一级风险标签,当riskLevel为PASS时返回normalriskLabel2string二级风险标签是二级风险标签,当riskLevel为PASS时为空riskLabel3string三级风险标签是三级风险标签,当riskLevel为PASS时为空riskDescriptionstring风险原因是当riskLevel为PASS时为正常riskDetailjson_object映射后风险详情是matchedListsjson_array辅助信息否命中的客户自定义名单列表。namestring辅助信息否命中的名单名称wordsjson_array辅助信息否命中的敏感词数组。wordstring辅助信息否命中的敏感词positionint_array辅助信息否敏感词所在位置riskSegmentsjson_array辅助信息,高风险内容片段检测文本包含涉政、暴恐、违禁、广告法等风险内容的时候存在否segmentstring辅助信息否高风险内容片段positionint_array辅助信息否高风险内容片段所在位置tokenLabelsjson_object辅助信息是账号风险画像标签信息见下面详情内容。UGC_account_riskjson_object辅助信息否UGC内容相关风险。sexy_risk_tokenidfloat辅助信息否色情账号风险分取值区间[0-1]auxInfojson_object辅助信息是filteredTextstring辅助信息否风险片段被替换为*后的文本passThroughjson_object透传字段否该字段内容与请求参数data中extra的passThrough的值相同contactResultjson_array辅助信息否联系方式识别结果,包含识别出的微信、QQ、手机号的字符串类型和内容。contactTypeint辅助信息否联系方式类型,可选值区间[0-3],详情如下: 0:手机号 1:QQ号 2:微信号contactStringstring辅助信息否联系方式串contextTextstring辅助信息否上下文生效时返回unauthorizedTypestring辅助信息否未授权的typeallLabelsjson_array辅助信息是命中的所有风险标签以及详情信息。riskLabel1stringallLabels不为空时必返是一级风险标签riskLabel2stringallLabels不为空时必返是二级风险标签riskLabel3stringallLabels不为空时必返是三级风险标签riskDescriptionstringallLabels不为空时必返是风险原因probabilityfloat置信度是可选值在0~1之间,值越大,可信度越高。注意:allLabels不为空时必返riskDetailjson_object映射后风险详情是matchedListsjson_array辅助信息否命中的客户自定义名单列表。namestring辅助信息否命中的名单名称wordsjson_array辅助信息否命中的敏感词数组。wordstring辅助信息否命中的敏感词positionint_array辅助信息否敏感词所在位置riskSegmentsjson_array辅助信息,高风险内容片段检测文本包含涉政、暴恐、违禁、广告法等风险内容的时候存在否segmentstring辅助信息否高风险内容片段positionint_array辅助信息否高风险内容片段所在位置riskLevelstring风险等级是可能返回值: REVIEW:可疑 REJECT:违规businessLabelsjson_array辅助信息是命中的所有业务标签以及详细信息。businessLabel1stringbusinessLabels不为空必返是一级业务标签businessLabel2stringbusinessLabels不为空必返是二级业务标签businessLabel3stringbusinessLabels不为空必返是三级业务标签businessDescriptionstringbusinessLabels不为空必返是标签描述probabilityfloatbusinessLabels不为空必返 可选值在0~1之间,值越大,可信度越高是置信度businessDetailjson_objectbusinessLabels不为空必返是业务详情tokenProfileLabelsjson_array辅助信息否属性账号类标签。label1string一级标签否label2string二级标签否label3string三级标签否descriptionstring标签描述否timestampInt打标签时间戳否13位Unix时间戳,单位:毫秒tokenRiskLabelsjson_array辅助信息否风险账号类标签。langResultjson_object语种信息否detectedLangstring语种识别结果否当在国际化文本产品下传入lang的值为auto时返回该字段。值为标准语言代码表,例如:zh、en、ar等translatedTextstring文本翻译结果否当传入translationTargetLang时返回的字段。值为翻译后的文本。kbDetailjson_object知识库详情否qlabelstring问题标签是可选值: UNKNOWN:没有匹配 CANNOT_ASK:问题本身不可提问/不可输入 EXACTNESS:问题答案必须正确。包括立场正确 POSITIVE:问题答案需要包含正向引导 PENDING:流式查询代答答案answerstring建议答案是当qlabel为"EXACTNESS"或者"POSITIVE"时,会给出数美建议的符合要求的答案。isEndbool答案是否完整返回是答案是否完整返回hasAnswerint是否有答案是1 有代答;0 没有代答;2 需流式查询代答,默认为0finalResultint是否最终结果是值为1,贵司可直接拿返回结果进行处置、分发等下游场景的使用;值为0,说明该结果为数美风控的过程结果,还需要经过数美人审再次check后回传贵司resultTypeint当前结果是机审还是人审环节结果是0:机审,1:人审disposaljson_object处置和映射结果否数美可按照贵司的标签体系和标识进行返回;未配置自定义标签体系则不返回该字段riskLevelstring处置建议是若贵司有自己的处置规则,数美可按照贵司的处置逻辑配置并返回对应的处置建议;若规则标签未映射上,则返回默认处置建议riskLabel1string映射后一级风险标签是一级风险标签,当数美标签未映射上自定义标签,且disposal下的riskLevel为PASS时,riskLabel1值为normalriskLabel2string映射后二级风险标签是二级风险标签,当数美标签未映射上自定义标签,且disposal下的riskLevel为PASS时,riskLabel2值为空riskLabel3string映射后三级风险标签是三级风险标签,当数美标签未映射上自定义标签,且disposal下的riskLevel为PASS时,riskLabel3值为空riskDescriptionstring映射后风险原因是当riskLevel为PASS时为正常riskDetailjson_object映射后风险详情是matchedListsjson_array辅助信息否命中的客户自定义名单列表。namestring辅助信息否命中的名单名称wordsjson_array辅助信息否命中的敏感词数组。wordstring辅助信息否命中的敏感词positionint_array辅助信息否敏感词所在位置riskSegmentsjson_array辅助信息,高风险内容片段检测文本包含涉政、暴恐、违禁、广告法等风险内容的时候存在否segmentstring辅助信息否高风险内容片段positionint_array辅助信息否高风险内容片段所在位置当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" } }}Copy返回示例#{ "allLabels": [ { "probability": 1, "riskDescription": "涉政:涉政:涉政", "riskDetail": {}, "riskLabel1": "politics", "riskLabel2": "shezheng", "riskLabel3": "shezheng", "riskLevel": "REVIEW" }, { "probability": 0.95559550232975, "riskDescription": "广告:加好友:加好友", "riskDetail": { "matchedLists": [ { "name": "社区敏感词名单", "words": [ { "position": [ 6, 7 ], "word": "qq" } ] } ] }, "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": "加个好友吧 **12345" }, "businessLabels": [], "code": 1100, "message": "成功", "finalResult": 1, "resultType": 0, "requestId": "bb917ec5fa11fd02d226fb384968feb1", "riskDescription": "广告:联系方式:联系方式", "riskDetail": {}, "riskLabel1": "ad", "riskLabel2": "lianxifangshi", "riskLabel3": "lianxifangshi", "riskLevel": "REJECT"}Copy