apshabd.io

Prepanity Detection API

ベースURL：https：//abshabd.apshabd.workers.dev

概要

Profanity Detection APIは、テキストメッセージで冒prof的な言語を検出してフラグを立てるように設計されています。入力メッセージを処理し、冒とくをチェックし、検出された攻撃テキストとともに結果を返します。

終点

ベース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 （Boolean）：メッセージに冒とくが含まれているかどうかを示します。
• score （数）：検出された冒とくコンテンツの類似性スコア。
• flaggedFor （string）：forpeaneとしてフラグが付けられたテキスト。

冒とくは検出されませんでした

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

• isProfanity （Boolean）：メッセージに冒とくが含まれているかどうかを示します。
• 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

使用例

カール

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

JavaScript（FetchAPI）

 JavaScript
  
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));

Python（リクエスト）

 Python
  
import requests url = 'https://abshabd.apshabd.workers.dev/gaali'
ヘッダー= {
「コンテンツタイプ」 ： 「アプリケーション/json」 、
}
data = {
「メッセージ」 ： 'Tu ##### hai'
}

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

環境変数

APIが正しく機能するように、次の環境変数を必ず設定してください。

• VECTOR_URL ：VectorデータベースのURL。
• VECTOR_TOKEN ：Vectorデータベースへのリクエストを認証するためのトークン。

セットアップと展開

1. リポジトリをクローンします。
2. npm installを使用して依存関係をインストールします。
3. サーバーレス環境（CloudFlareワーカーなど）に展開します。
4. 必要な環境変数（ VECTOR_URLおよびVECTOR_TOKEN ）を設定します。
5. /gaaliエンドポイントでAPIにアクセスします。