跳转至

检测文本滥用

文本滥用检测API是一个检测和验证文本中滥用(禁止词、垃圾广告)的API。

准备

检查您是否可以访问 Hive 控制台 > AI 服务 > 滥用检测 > 聊天滥用检测 菜单,如果没有,请参考 Hive 控制台权限管理指南以获取菜单访问权限。在 聊天滥用检测 中注册一个新项目。

确定文本是否具有攻击性

发送文本后,它会判断该文本是否为垃圾广告或包含禁止词汇,然后返回结果。

请求 URL

直播 URL https://tads.withhive.com/cads2/send-text-data
沙盒 URL https://sandbox-tads.withhive.com/cads2/send-text-data
HTTP 方法 POST
内容类型 application/json

请求体

字段名称 描述 类型 必需
project_key 项目密钥 字符串
text_log 文本信息 对象

text_log

字段名称 描述 类型 必需
text_array 包含文本及文本发送时间的对象数组 Array(Object) Y
text_count text_array 中对象的数量 Integer Y

文本数组中的对象

字段名称 描述 类型 必需
time_stamp 文本发送的时间(基于UTC的ISO格式时间字符串,例如:2024-01-30T10:35:49.95457+09:00 字符串
text_info 使用从Hive 控制台获得的加密密钥通过AES256加密的字符串,来自JSON对象。最大大小为5KB。有关加密方法的更多详细信息,请参阅示例代码 字符串

text_info JSON 对象

根据下面的格式创建一个 JSON 对象,然后使用 AES256 加密它以形成 text_info 字符串。

字段名称 描述 类型 必需
user_id 用户的唯一ID号码 字符串
lang_code 语言代码(ISO 639-1)
* 韩语: ko
* 英语: en
* 日语: ja
* 简体中文: zh-hans
* 繁体中文: zh-hant
* 西班牙语: es
* 俄语: ru
* 德语: de
* 法语: fr
* 葡萄牙语: pt
* 意大利语: it
* 泰语: th
* 印尼语: id
* 土耳其语: tr
* 马来语: ms
* 越南语: vi
字符串
text 要检查是否滥用的文本 字符串
text_type 如果文本是聊天文本,则属于以下3种聊天格式之一。
* "chat_party": 聚会聊天
* "chat_guild": 公会聊天
* "chat_whisper": 私聊
字符串
room_num 如果文本是聊天文本,这是聊天房间号码。 字符串
channel_info 如果文本是聊天文本,这是聊天频道信息。 字符串

响应

字段名称 描述 类型
result_code 响应代码 字符串
result_text 响应代码的描述 字符串
result_array 包含检测结果的数组 数组(对象)

result_array

字段名称 描述 类型
tads_result 检测结果 对象
text_result 根据原始文本和检测结果对原始文本应用掩码的结果 对象

tads_result

字段名称 描述 类型
forbidden_yn 是否检测到禁用词(0:文本中未找到禁用词,1:文本中找到禁用词) 字符串
spam_yn 文本是否被检测为垃圾邮件(0:未检测为垃圾邮件,1:检测为垃圾邮件) 字符串
aug_yn 文本是否以批处理方式处理(0:未批处理,1:已批处理) 字符串
long_yn 文本是否为长字符串,这意味着如果超过 5,000 个字符,则无法在文本上运行检测算法(0:少于 5,000 个字符,1:超过 5,000 个字符) 字符串
文本结果
字段名称 描述 类型
text 要检查是否滥用的文本 字符串
masking_text 应用掩码的文本(如果在Hive 控制台中没有进行掩码设置,或者如果tads_result.forbidden_yn值为0,则text将是相同的) 字符串

响应代码

代码 文本 备注
200 "成功" 成功
500 "请求不正确" 请求中存在错误。请检查请求 URL 和请求体是否正确。
501 "数据计数不正确" 传递的文本计数不匹配。text_count 的值和 text_array 的长度必须匹配。
502 "密钥不正确" 密钥值不正确。请检查项目管理中的项目密钥。
503 "未注册的项目密钥" 项目密钥值不正确。请检查项目管理中的项目密钥。
506 "系统错误" 这是一个内部错误,例如网络错误。请稍后再次调用 API。
507 "消息大小过大" 文本大小过大。text_array 的最大大小为 5KB。请减少消息的大小。

请求示例

import json
import base64
import requests
from datetime import datetime
from Crypto.Cipher import AES
from Crypto.Util.Padding import pad

def encrypt(text, user_id, lang_code, secret_key, channel_info=None, room_num=None, text_type=None) -> str: ## 加密的代码 
    aes = AES.new(secret_key, AES.MODE_ECB)
    jsonData =  {"text_type": text_type, ## 仅在需要时使用
                "room_num" : room_num, ## 仅在需要时使用
                "user_id": user_id,
                "channel_info" : channel_info, ## 仅在需要时使用
                "lang_code": lang_code,
                "text": text}
    rawJsonStr = json.dumps(jsonData)
    paddedStr = pad(rawJsonStr.encode("utf-8"),AES.block_size)
    encrypted_data = aes.encrypt(paddedStr)
    encrypted_data_b64 = base64.b64encode(encrypted_data).decode("utf-8")
    return encrypted_data_b64

project_key = <PROJECT_KEY>
secret_key = <SECRET_KEY>
now = datetime.now().astimezone().isoformat()
lang_code = "ko"
user_id = "432414"
channel_info = "4342314" ## Use it only when it is required
room_num = "12312" ## Use it only when it is required
text_type = "chat_whisper" ## Use it only when it is required
url = "https://tads.withhive.com/cads2/send-text-data"

payload =  {"project_key": project_key,
                      "text_log": {
                              "text_count": 2, ## 应该与 text_array 的元素数量匹配
                              "text_array": [
                                            {"time_stamp": now,
                                            "text_info": encrypt(text=str("test1"), 
                                                            user_id=user_id,
                                                            channel_info=channel_info, ## 仅在需要时使用
                                                            room_num=room_num, ## 仅在需要时使用
                                                            text_type=text_type, ## 仅在需要时使用
                                                            lang_code=lang_code,
                                                            secret_key=secret_key)},
                                            {"time_stamp": now,
                                            "text_info": encrypt(text=str("test2"), 
                                                            user_id=user_id,
                                                            channel_info=channel_info, ## 仅在需要时使用
                                                            room_num=room_num, ## 仅在需要时使用
                                                            text_type=text_type, ## 仅在需要时使用
                                                            lang_code=lang_code,
                                                            secret_key=secret_key)}]},}

res = requests.post(url, data=json.dumps(payload), headers={"Content-Type": "application/json"})
import java.security.InvalidKeyException;
import java.security.NoSuchAlgorithmException;
import java.util.HashMap;
import java.util.Map;
import javax.crypto.BadPaddingException;
import javax.crypto.Cipher;
import javax.crypto.IllegalBlockSizeException;
import javax.crypto.NoSuchPaddingException;
import javax.crypto.spec.SecretKeySpec;

import java.util.Base64;
import org.jooq.tools.json.JSONObject;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Profile;
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Component;
import org.springframework.web.client.RestTemplate;

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;

import lombok.extern.slf4j.log;

import java.time.ZonedDateTime;
import java.time.format.DateTimeFormatter;

@Slf4j
public class TadsComponent {

@Autowired
RestTemplate restTemplate;

@Autowired
ObjectMapper objectMapper;


public void sendHttp() throws Exception{
    String projectKey =  <PROJECT_KEY>; // 提供项目密钥
    String secretKey =  <SECRET_KEY>;  // 提供项目秘密密钥

    String url = "https://tads.withhive.com/cads2/send-text-data";
    String user_id = "432414";
    String channel_info = "4342314"; // Use it only when it is required
    String room_num = "12312"; // Use it only when it is required
    String text_type = "chat_whisper"; // Use it only when it is required
    String lang_code = "ko";
    String text_1 = "test1";
    String text_2 = "test2";

    DateTimeFormatter formatter = DateTimeFormatter.ISO_OFFSET_DATE_TIME;
    ZonedDateTime now = ZonedDateTime.now();

    Map<String, Object> payload = new HashMap<>();
    payload.put("project_key", projectKey);

    Map<String, Object> textLog = new HashMap<>();
    textLog.put("text_count", 2); // should match the number of elements of text_array

    Map<String, Object> textArray1 = new HashMap<>();
    textArray1.put("time_stamp", now.format(formatter));
    textArray1.put("text_info", encrypt(text_1, user_id, channel_info, room_num, text_type, lang_code, secretKey));


Map<String, Object> textArray2 = new HashMap<>();
   textArray2.put("time_stamp", now.format(formatter));
   textArray2.put("text_info", encrypt(text_2, user_id, channel_info, room_num, text_type, lang_code, secretKey));

    Object[] textArrayObj = {textArray1, textArray2};
    textLog.put("text_array", textArrayObj);
    payload.put("text_log", textLog);
    JsonNode callBodyNode = objectMapper.valueToTree(payload);
    HttpHeaders headers = new HttpHeaders();
    headers.add("Content-Type", "application/json");
    HttpEntity<String> entity = new HttpEntity<>(callBodyNode.toString(), headers);
    ResponseEntity<String> responseEntity =  restTemplate.exchange(url, HttpMethod.POST, entity, String.class);
    int responseStatusCode =  responseEntity.getStatusCodeValue();
    String responseBodyString = responseEntity.getBody();
    JsonNode responseBodyNode = objectMapper.readTree(responseBodyString);
    return;
}

public static String encrypt(String text, String UserId, String channelInfo, String roomNum, String textType, String langCode, String secretKey) {
    try {
        Cipher aes = Cipher.getInstance("AES/ECB/PKCS5Padding");
        SecretKeySpec secretKeySpec = new SecretKeySpec(secretKey.getBytes(), "AES");
        aes.init(Cipher.ENCRYPT_MODE, secretKeySpec);
        Map<String,Object> map = new HashMap<String,Object>();
        map.put("room_num", roomNum); // Use it only when it is required
        map.put("channel_info", channelInfo); // Use it only when it is required
        map.put("lang_code", langCode);
        map.put("text", text);
        map.put("text_type", textType); // Use it only when it is required
        map.put("user_id", UserId);
        String encrypt_str = JSONObject.toJSONString(map);
        byte[] paddedData = padString(encrypt_str).getBytes();
        byte[] encryptedData = aes.doFinal(paddedData);
        return Base64.getEncoder().encodeToString(encryptedData);
    } catch (NoSuchAlgorithmException | NoSuchPaddingException | InvalidKeyException | IllegalBlockSizeException | BadPaddingException e) {
        e.printStackTrace();
        return null;
    }
}
private static String padString(String source) {
    char paddingChar = ' ';
    int size = 16;
    int x = source.length() % size;
    int padLength = size - x;
    StringBuilder paddedString = new StringBuilder(source);
    for (int i = 0; i < padLength; i++) {
        paddedString.append(paddingChar);
    }
    return paddedString.toString();
}} // 加密的代码

响应示例

{
    "result": {
        "result_array": '[
                        {"tads_result":{
                            "forbidden_yn":"0",
                            "spam_yn":"0",
                            "aug_yn":"0",
                            "long_yn":"0"},
                        "text_result":{
                            "text":"test1",
                            "masking_text":"test1"
                        }},
                        {"tads_result":{
                            "forbidden_yn":"0",
                            "spam_yn":"0",
                            "aug_yn":"0",
                            "long_yn":"0"},
                        "text_result":{
                            "text":"test2",
                            "masking_text":"test2"
                        }}
                            ]',
        "result_code": "200",
        "result_text": "success"
    }
}