apshabd.io

욕설 감지 API

기본 URL : https://abshabd.apshabd.workers.dev

개요

욕설 감지 API는 문자 메시지에서 비판적인 언어를 감지하고 플래그하도록 설계되었습니다. 입력 메시지를 처리하고 욕설을 확인하고 감지 된 공격 텍스트와 함께 결과를 반환합니다.

엔드 포인트

기본 URL

 세게 때리다
  
/gaali

HTTP 방법

  
POST 

요구

헤더

• Content-Type: application/json

몸

요청 본문은 다음 구조의 JSON 객체 여야합니다.

 JSON
  
{ "message" : "Your message here" }

• message (문자열) : 분석 할 문자 메시지. 500 자 미만이어야합니다.

예제 요청

 JSON
  
{ "message" : "tu ##### hai" } 

응답

응답은 다음 구조의 JSON 객체입니다.

욕설이 감지되었습니다

 JSON
  
{ "isProfanity" : true , "score" : 0.95 , "flaggedFor" : "#####" }

• isProfanity (부울) : 메시지에 욕설이 포함되어 있는지를 나타냅니다.
• score (번호) : 감지 된 비판 컨텐츠의 유사성 점수.
• flaggedFor (string) : 텍스트가 비판적으로 표시되었습니다.

욕설이 감지되지 않았습니다

 JSON
  
{ "isProfanity" : false , "score" : 0.45 }

• isProfanity (부울) : 메시지에 욕설이 포함되어 있는지를 나타냅니다.
• score (번호) : 가장 높은 유사성 점수가 관찰되었습니다.

오류 응답

• json이 아닌 콘텐츠 유형 :

   JSON
    
  { "error" : "JSON Body Expected." }

  상태 코드 : 406

• 메시지 인수 누락 :

   JSON
    
  { "error" : "Message Argument is Required." }

  상태 코드 : 400

• 너무 긴 메시지 :

   JSON
    
  { "error" : "Message can only be at most 500 characters." }

  상태 코드 : 413

• 내부 서버 오류 :

   JSON
    
  { "error" : "Something Went Wrong" }

  상태 코드 : 500

사용 예제

컬

 쉿
  
curl -X POST https://abshabd.apshabd.workers.dev/gaali  -H "Content-Type: application/json"  -d '{"message": "tu ##### hai"}'

JavaScript (Fetch API)

 자바 스크립트
  
fetch ( 'https://abshabd.apshabd.workers.dev/gaali' , { method : 'POST' , headers : { 'Content-Type' : 'application/json' }, body : JSON . stringify ({ message : "tu ##### hai" }) }) . then ( response => response. json ()) . then ( data => console . log (data)) . catch ( error => console . error ( 'Error:' , error));

파이썬 (요청)

 파이썬
  
import requests url = 'https://abshabd.apshabd.workers.dev/gaali'
헤더 = {
'Content-Type' : 'Application/JSON' ,
}
데이터 = {
'메시지' : 'tu ##### hai'
}

response = requests.post(url, headers=headers, json=data) print (response.json()) 

환경 변수

API가 올바르게 작동하도록 다음 환경 변수를 설정하십시오.

• VECTOR_URL : 벡터 데이터베이스의 URL.
• VECTOR_TOKEN : 벡터 데이터베이스에 대한 요청을 인증하기위한 토큰.

설정 및 배포

1. 저장소를 복제하십시오.
2. npm install 사용하여 종속성을 설치하십시오.
3. 서버리스 환경 (예 : CloudFlare Workers)에 배포하십시오.
4. 필요한 환경 변수 ( VECTOR_URL 및 VECTOR_TOKEN )를 설정하십시오.
5. /gaali 엔드 포인트에서 API에 액세스하십시오.