新增接口

微信小程序SDK敏感词检测&AI检测.md

+### 3.9 SDK 敏感词检测及 AI 检测<a name="sec3.9"></a>
+### 3.9 SDK 敏感词检测及 AI 检测<a name="sec3.9"></a>
+
+---
+
+##### 接口说明
+
+> **\***接口返回 Promise 对象
+
+##### 调用方式
+
+```javascript
+zwsdk.checkMsgWithAI(config:Object)
+```
+
+##### 请求参数
+
+> | 参数         | 必选 | 类型   | 默认值 | 说明                                    |
+> | :----------- | :--- | :----- | :----- | :-------------------------------------- |
+> | context      | true | String | -      | 待检测内容                              |
+> | context_type | true | String | chat   | 'chat':聊天 ;'nick':昵称 ;'post':帖子 ; |
+> | zw_app_id    | true | String | -      | 应用 appId,由发行方提供                 |
+> | cp_role_id   | true | String | -      | 角色 ID                                 |
+> | action_time  | true | String | -      | 发送时间                                |
+> | room_id      | false | String | -      | 聊天室 ID                               |
+> | room_name    | false | String | -      | 聊天室名                                |
+> | server_id    | false | String | -      | 区服 ID                                 |
+> | channel_id   | false | String | -      | 渠道 ID                                 |
+> | user_id      | false | String | -      | 用户 ID                                 |
+> | ip           | false | String | -      | 玩家 ip                                 |
+
+```
+  请注意：room_id需要传聊天室id，我们需要根据不同的聊天类型设置不同的检测规则，让消息的拦截更智能和精准。
+   所需的聊天类型：
+       ● 世界：1
+       ● 行会：2
+       ● 系统：3
+       ● 地图：4
+       ● 组队：5
+       ● 跨服：8
+       ● 个人：100    
+   
+   数据传输内容
+      ● 聊天审核：在玩家发送聊天时， 调用审核接口，其中context为聊天内容   context_type设置为 chat
+      ● 昵称审核：在玩家设置昵称或更改昵称时，调用审核接口,  其中context为待审核文本(昵称名), context_type设置为 nick,  昵称审核时若无角色ID(cp_role_id), 则不传cp_role_id字段或传空字符串, 注意不要传0
+      ● 行会公告审核：在玩家设置行会公告时，调用审核接口，其中context为待审核文本(公告内容)， context_type设置为post
+      ● 行会昵称审核：在玩家设置行会昵称时，调用审核接口，其中context为待审核文本(行会昵称名), context_type设置为nick
+      ● 区服审核：当调用审核服务时,  接口传输增加一个字段，字段名为server_id 内容为区服，类型为字符串
+  返回结果处理
+
+```
+
+##### 返回参数
+
+> | 参数        | 类型   | 说明     |
+> | :---------- | :----- | :------- |
+> | status_code | String | 返回状态 |
+> | msg         | String | 返回信息 |
+
+##### 返回数据样例
+
+> status_code 为 1 且 data.suggest 为 'pass' 则表示检测通过
+
+```javascript
+{
+    "status_code": 1,
+    "msg": "操作成功",
+    "data": {
+        "suggest": "pass",
+        "label": "normal"
+    },
+    "extra": {}
+}
+```
+
+##### sdk 调用示例
+
+```javascript
+zwsdk
+  .checkMsgWithAI({
+    context: '中华人民共和国万岁!',
+    context_type: 'chat',
+    zw_app_id: '1234',
+    cp_role_id: 'cproleid1234',
+    action_time: '2023-12-25 18:22:54',
+    room_id: '123',
+    room_name: '聊天室名称',
+    server_id: '1234',
+    channel_id: '123',
+    user_id: '1234',
+    ip: '0.0.0.0'
+  })
+  .then((res) => {
+    // .......
+    // res.status  返回状态
+    // res.msg  返回信息
+  })
+```