Textrics API Stack

Profanity Analysis API Implementation

This API works on a sentence and tells us the profanity of the sentence in the form of Offensive or Non-offensive. Given a short sentence, it returns a label representing the identified profanity, along with a numeric confidence score.

Endpoint

https://api.textrics.ai/offensive_analysis_api.php

We support POST method to communicate with API.

Parameters

1. user_text - This parameter is required
This is the text (sentence) which you wish to send to application to analyse.

2. api_key - This parameter is required
This is used to identify the user and the active subscription plan.

3. api_token - This parameter is required
This is used to authenticate the above user account.

API Script

<?php
if ($_SERVER["REQUEST_METHOD"] == "POST") {
    $text = trim($_POST['user_text']);			// input variable containing text //
    if($text!='' && is_numeric($text)!=1){
	$apiUrl = 'https://api.textrics.ai/offensive_analysis_api.php';		// API URL //
    $args['user_text'] = $text;
	$args['api_key'] = 'A32NBK55K3'; 		// user specific key to validate the account //
	$args['api_token'] = 'P4lwpqT0YZYSVefSh44ADkvlJ8pesZDI';   // respective token to validate user credentials //

    $options=[
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_POSTFIELDS => $args,
      CURLOPT_CUSTOMREQUEST => "POST",
      CURLOPT_HTTPHEADER => ['Content-Type: multipart/form-data']
      ];
    $ch = curl_init($apiUrl);
    curl_setopt_array($ch, $options);
    $response1 = curl_exec($ch);
    echo $err = curl_error($ch); 
    curl_close($ch);	
    $response =  json_decode($response1,true);		// API output is stored in $response variable //
	}
	else
	{
        $message= 'Error: Input Text is incorrect.';
	}
}

?>

Sample of retrieving the output

<?php
if(!empty($response))
{
	echo "Input Text - ".$text;
	echo "<pre style='text-align:left;'>"; 
	print_r($response);		// Printing the $response output on page //
	echo "</pre>"; 
}
if(!empty($message))
{
	echo $message;
}
?>

Response Format

The response is structured in JSON as follows:

Array
 (
  	[response] => 1
  	[data] => Array
  	 (
  	   [0] => Array
  	     (
  		   [Module] => Abusive or non Abusive
  		   [Prediction] => Abusive
  		   [Confidence] => 55.7626304626
  		 )
  	 )
    [message] => success
 )

API Response Codes