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)

 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 (запросы)

 питон
  
import requests url = 'https://abshabd.apshabd.workers.dev/gaali'
заголовки = {
'Content-Type' : 'Application/json' ,
}
data = {
'Message' : 'tu ##### hai'
}

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

Переменные среды

Обязательно установите следующие переменные среды для правильного функционирования:

• VECTOR_URL : URL -адрес векторной базы данных.
• VECTOR_TOKEN : токен для аутентификации запросов в векторную базу данных.

Настройка и развертывание

1. Клонировать репозиторий.
2. Установите зависимости, используя npm install .
3. Развертывание в вашей без серверной среде (например, работники CloudFlare).
4. Установите требуемые переменные среды ( VECTOR_URL и VECTOR_TOKEN ).
5. Доступ к API в конечной точке /gaali .