apshabd.io

API de detecção de palavrões

URL base: https://abshabd.apshabd.workers.dev

Visão geral

A API de detecção de palavrões foi projetada para detectar e sinalizar linguagem profana nas mensagens de texto. Ele processa a mensagem de entrada, verifica a palavrões e retorna o resultado junto com o texto ofensivo detectado, se houver.

Endpoint

URL base

 Bash
  
/gaali

Método HTTP

  
POST 

Solicitar

Cabeçalhos

• Content-Type: application/json

Corpo

O corpo de solicitação deve ser um objeto JSON com a seguinte estrutura:

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

• message (string): a mensagem de texto a ser analisada. Não deve ter mais de 500 caracteres.

Solicitação de exemplo

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

Resposta

A resposta será um objeto JSON com a seguinte estrutura:

Profanidade detectada

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

• isProfanity (booleano): indica se a mensagem contém palavrões.
• score (número): a pontuação de similaridade do conteúdo profano detectado.
• flaggedFor (string): o texto que foi sinalizado como profano.

Nenhuma palavrões detectados

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

• isProfanity (booleano): indica se a mensagem contém palavrões.
• score (Número): A maior pontuação de similaridade observada.

Respostas de erro

• Tipo de conteúdo não JSON :

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

  Código de status: 406

• Argumento de mensagem faltando :

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

  Código de status: 400

• Mensagem muito longa :

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

  Código de status: 413

• Erro do Servidor Interno :

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

  Código de status: 500

Exemplo de uso

Curl

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

JavaScript (API Fetch)

 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 (solicitações)

 Python
  
import requests url = 'https://abshabd.apshabd.workers.dev/gaali'
cabeçalhos = {
'Content-Type' : 'Application/JSON' ,
}
dados = {
'mensagem' : 'tu ##### hai'
}

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

Variáveis ​​de ambiente

Certifique -se de definir as seguintes variáveis ​​de ambiente para a API funcionar corretamente:

• VECTOR_URL : URL do banco de dados vetorial.
• VECTOR_TOKEN : token para autenticação de solicitações ao banco de dados vetorial.

Configuração e implantação

1. Clone o repositório.
2. Instale dependências usando npm install .
3. Implante no seu ambiente sem servidor (por exemplo, Cloudflare Workers).
4. Defina as variáveis ​​de ambiente necessárias ( VECTOR_URL e VECTOR_TOKEN ).
5. Acesse a API no terminal /gaali .