텍스트 어뷰징 탐지 API는 텍스트에서 어뷰징(금칙어, 스팸 광고)을 탐지하고 확인하는 API입니다.

사전 준비

Hive 콘솔 > AI 서비스 > 어뷰징 탐지 > 텍스트 어뷰징 탐지 메뉴에 접근할 수 있는지 확인하고, 접근이 안 되면 Hive 콘솔 권한 관리 가이드를 참고해 메뉴 접근 권한을 얻습니다. 텍스트 어뷰징 탐지에서 새 프로젝트를 등록합니다.

텍스트 어뷰징 여부 판단

텍스트를 전송한 후 이 텍스트가 스팸성 광고인지 텍스트에 금칙어가 포함되었는지 등을 판단해 결과를 반환합니다.

Request URL

LIVE URL https://tads.withhive.com/cads2/send-text-data
Sandbox URL https://sandbox-tads.withhive.com/cads2/send-text-data
HTTP Method POST
Content-Type application/json

Request Body

필드명 설명 타입 필수
project_key 프로젝트 키 String Y
text_log 텍스트 정보 Object Y

text_log

필드명 설명 타입 필수
text_array 텍스트와 텍스트 전송 시간이 들어있는 객체들의 배열 Array(Object) Y
text_count text_array에 있는 객체 개수 Integer Y

text_array에 있는 객체

필드명 설명 타입 필수
time_stamp 텍스트 전송 시간(UTC 기준 ISO 형식 시간 문자열, 예시: 2024-01-30T10:35:49.95457+09:00) String Y
text_info JSON 객체Hive 콘솔에서 얻은 암호키를 사용해 AES256 방식으로 암호화한 문자열입니다. 최대 크기는 5KB입니다. 암호화 방법에 대한 자세한 내용은 예제 코드를 참고하세요. String Y

text_info JSON 객체

아래 양식을 따라 JSON 객체를 생성 후, 이를 AES256 방식으로 암호화하여 text_info 문자열을 만듭니다.

필드명 설명 타입 필수
user_id 사용자 고유 ID 번호 String Y
lang_code 언어 코드(ISO 639-1 기반)

  • 한국어: ko
  • 영어: en
  • 일본어: ja
  • 중문 간체: zh-hans
  • 중문 번체: zh-hant
  • 에스파냐: es
  • 러시아: ru
  • 독일어: de
  • 프랑스어: fr
  • 포르투갈어: pt
  • 이태리어: it
  • 태국어: th
  • 인도네시아어: id
  • 터키어: tr
  • 말레이시아어: ms
  • 베트남어: vi
String Y
text 어뷰징 여부를 체크할 텍스트 String Y
text_type 텍스트가 채팅 텍스트인 경우, 3가지 채팅 형태중 하나입니다.

  • “chat_party”: 파티 채팅
  • “chat_guild”: 길드 채팅
  • “chat_whisper”: 귓속말
String N
room_num 텍스트가 채팅 텍스트인 경우, 채팅방 번호입니다. String N
channel_info 텍스트가 채팅 텍스트인 경우, 채팅 채널 정보입니다. String N

Response

필드명 설명 타입
result_code 응답 코드 String
result_text 응답 코드 설명 String
result_array 탐지 결과를 담은 배열 Array(Object)

result_array

필드명 설명 타입
tads_result 탐지 결과 Object
text_result 원문 텍스트와 탐지 결과를 토대로 원문 텍스트에 마스킹을 적용한 결과 Object

tads_result

필드명 설명 타입
forbidden_yn 금칙어 탐지 여부(0: 텍스트에서 금칙어 미발견, 1: 텍스트에서 금칙어 발견) String
spam_yn 광고 탐지 여부(0: 텍스트가 스팸성 광고가 아님, 1: 텍스트가 스팸성 광고임) String
aug_yn 묶음 처리 여부(0: 묶음 처리되지 않음, 1: 묶음 처리됨) String
long_yn 긴 문자열 여부로 5,000자 이상이면 어뷰징 여부를 탐지할 수 없음 (0: 5,000자 이하, 1: 5,000자 초과) String
text_result
필드명 설명 타입
text 어뷰징 여부를 체크하려는 텍스트 String
masking_text text에 마스킹을 적용한 텍스트(Hive 콘솔에서 마스킹 설정을 하지 않았거나 tads_result.forbidden_yn값이 0이면 text와 동일) String

Response Code

코드 텍스트 비고
200 “success” 성공
500 “Incorrect request” 요청에 오류가 있습니다. Request URL과 Reqest Body가 정확한지 확인하세요.
501 “Incorrect Data Count” 전달된 텍스트의 카운트가 일치하지 않습니다. text_count 값과 text_array의 길이가 일치해야 합니다.
502 “Incorrect Secret Key” 올바르지 않은 암호키 값입니다. 프로젝트 관리에서 해당 프로젝트 암호키를 확인하세요.
503 “Unregistered ProjectKey” 올바르지 않은 프로젝트 키 값입니다. 프로젝트 관리에서 해당 프로젝트의 프로젝트 키를 확인하세요.
506 “System Error” 네트워크 오류 등 내부 오류입니다. 일정 시간 후 API를 다시 호출하세요.
507 “The size of message is too large” 텍스트 크기가 너무 큽니다. text_array 최대 크기는 5KB입니다. 메세지 크기를 줄여주세요.

Request Example

Python

Java

Response Example