检测文本滥用
文本濫用檢測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 | 專案金鑰 | 字串 | Y |
text_log | 文字資訊 | 物件 | Y |
text_log¶
欄位名稱 | 描述 | 類型 | 必需 |
---|---|---|---|
text_array | 包含文本及文本發送時間的物件陣列 | 陣列(物件) | 是 |
text_count | text_array 中物件的數量 | 整數 | 是 |
文本陣列中的物件¶
字段名稱 | 描述 | 類型 | 必需 |
---|---|---|---|
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 号码 | 字符串 | Y |
lang_code | 语言代码 (ISO 639-1) * 韩语: ko * 英语: en * 日语: ja * 简体中文: zh-hans * 繁体中文: zh-hant * 西班牙语: es * 俄语: ru * 德语: de * 法语: fr * 葡萄牙语: pt * 意大利语: it * 泰语: th * 印度尼西亚语: id * 土耳其语: tr * 马来语: ms * 越南语: vi | 字符串 | Y |
text | 要检查的文本是否存在滥用 | 字符串 | Y |
text_type | 如果文本是聊天文本,则属于以下 3 种聊天格式之一。 * "chat_party": 聚会聊天 * "chat_guild": 公会聊天 * "chat_whisper": 私聊 | 字符串 | N |
room_num | 如果文本是聊天文本,则这是聊天房间号码。 | 字符串 | N |
channel_info | 如果文本是聊天文本,则这是聊天频道信息。 | 字符串 | N |
回應¶
欄位名稱 | 描述 | 類型 |
---|---|---|
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 | "未註冊的 ProjectKey" | 專案密鑰值不正確。請檢查專案管理中的專案密鑰。 |
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" ## 只有在需要時使用
room_num = "12312" ## 只有在需要時使用
text_type = "chat_whisper" ## 只有在需要時使用
url = "https://tads.withhive.com/cads2/send-text-data"
payload = {"project_key": project_key,
"text_log": {
"text_count": 2, ## should match the number of elements of text_array
"text_array": [
{"time_stamp": now,
"text_info": encrypt(text=str("test1"),
user_id=user_id,
channel_info=channel_info, ## Use it only when it is required
room_num=room_num, ## Use it only when it is required
text_type=text_type, ## Use it only when it is required
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, ## Use it only when it is required
room_num=room_num, ## Use it only when it is required
text_type=text_type, ## Use it only when it is required
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"
}
}