apshabd.io

Profanitätserkennungs -API

Basis -URL: https://abshabd.apshabd.workers.dev

Überblick

Die Profanity Detection -API ist so konzipiert, dass sie profane Sprache in Textnachrichten erkennen und kennzeichnet. Es verarbeitet die Eingabenachricht, prüft nach Obszönität und gibt das Ergebnis zusammen mit dem erkannten Offensivtext zurück.

Endpunkt

Basis -URL

 verprügeln
  
/gaali

HTTP -Methode

  
POST 

Anfrage

Header

• Content-Type: application/json

Körper

Der Anfragegremium muss ein JSON -Objekt mit der folgenden Struktur sein:

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

• message (Zeichenfolge): Die zu analysierende Textnachricht. Muss nicht länger als 500 Zeichen sein.

Beispielanforderung

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

Antwort

Die Antwort ist ein JSON -Objekt mit der folgenden Struktur:

Obszönität erkannt

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

• isProfanity (boolean): Gibt an, ob die Nachricht Obszönität enthält.
• score (Nummer): Die Ähnlichkeitsbewertung des erkannten profanen Inhalts.
• für (Zeichenfolge) flaggedFor (Zeichenfolge): Der Text, der als profan gekennzeichnet wurde.

Keine Obszönität entdeckt

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

• isProfanity (boolean): Gibt an, ob die Nachricht Obszönität enthält.
• score (Zahl): Der höchste beobachtete Ähnlichkeitswert.

Fehlerantworten

• Inhaltstyp nicht JSON :

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

  Statuscode: 406

• Nachrichtenargument fehlen :

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

  Statuscode: 400

• Nachricht zu lang :

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

  Statuscode: 413

• Interner Serverfehler :

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

  Statuscode: 500

Nutzungsbeispiel

Locken

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

JavaScript (API abrufen)

 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 (Anfragen)

 Python
  
import requests url = 'https://abshabd.apshabd.workers.dev/gaali'
Headers = {
"Inhaltstyp" : "Anwendung/JSON" ,
}
Data = {
'Nachricht' : 'Tu ##### Hai' '
}

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

Umgebungsvariablen

Stellen Sie sicher, dass Sie die folgenden Umgebungsvariablen festlegen, damit die API korrekt funktioniert:

• VECTOR_URL : URL der Vektordatenbank.
• VECTOR_TOKEN : Token zur Authentifizierung von Anforderungen an die Vektordatenbank.

Einrichtung und Bereitstellung

1. Klonen Sie das Repository.
2. Installieren Sie Abhängigkeiten mit npm install .
3. Bereitstellen in Ihrer serverlosen Umgebung (z. B. Cloudflare -Mitarbeiter).
4. Setzen Sie die erforderlichen Umgebungsvariablen ( VECTOR_URL und VECTOR_TOKEN ).
5. Greifen Sie auf die API am /gaali -Endpunkt zu.