WARNING

💡 模块名:GameHelper.SensitiveServ

描述

本模块集成在线检测词语或者图片是否涉及违规。对于微信渠道，模块会同时使用内部词库和微信官方安全接口进行检测。对于非微信渠道，会使用内部词库和三方接口进行检测。

接入说明

1. 需要告诉对接同学，游戏需要使用敏感词图检测功能，这样 SDK 代码才会包含该模块

2. 确保代码不会在不必要的场景进行检测调用(例如避免在每次输入字符时检测，而是在输入完成后才检测)

3. 在对应的检测点位，调用 SDK 方法

使用流程

敏感词检测

调用GameHelper.SensitiveServ.checkWord

敏感图检测

调用GameHelper.SensitiveServ.checkImage

接口索引

方法

参数	类型	默认值	是否必填	说明
opt	wordParam	object	是	检查传参

wordParam

参数	类型	默认值	是否必填	说明
text	string	/	是	待检测文本，长度小于 1 万
success	() => void	/	是	检测为 非 敏感词时的回调
fail	() => void	/	否	检测为敏感词时的回调
error	(err: any) => void	/	否	检测失败时的回调(自测时记得看下 SDK 报错信息)

返回值

无

描述

异步方法。

仅在游戏获取完整的待检测字符串(长度必须<1 万)后调用。然后传入 3 个回调函数，根据敏感状态处理逻辑。

一般来说检测错误回调(error)当做敏感逻辑(fail)处理。内测时如果发现检测错误，一定要查看 SDK 打印的错误日志

示例

GameHelper.SensitiveServ.checkWord({
  text: "你好，毛草",
  success() {
    console.log("正常");
  },
  fail() {
    console.log("存在敏感");
  },
  error(err) {
    console.log("检测错误", err);
  },
});

方法

参数	类型	默认值	是否必填	说明
opt	imgParam	object	是	检查传参

imgParam

参数	类型	默认值	是否必填	说明
img	string	/	是	待检测图片的 url 或 base64
success	() => void	/	是	检测为 非 敏感词时的回调
fail	() => void	/	否	检测为敏感词时的回调
error	(err: any) => void	/	否	检测失败时的回调(自测时记得看下 SDK 报错信息)

返回值

无

描述

异步方法。检查图片涉敏情况，支持 base64 与 url 链接两种形式。暂不支持微信官方的敏感图，仅使用内部检测方式。

仅在游戏获取待检测图片的 url 地址或者 base64 后调用。然后传入 3 个回调函数，根据敏感状态处理逻辑。

一般来说检测错误回调(error)当做敏感逻辑(fail)处理。内测时如果发现检测错误，一定要查看 SDK 打印的错误日志

示例

GameHelper.SensitiveServ.checkImage({
  img: "XXXXXXXXXXXXXX",
  success() {
    console.log("正常");
  },
  fail() {
    console.log("存在敏感");
  },
  error(err) {
    console.log("检测错误", err);
  },
});