Text Profanity Detection

The Text Profanity Detection model will help you detect and replace the profane words in a given conversation or text.

API Request

Returns the predicted emotion for a given sentence

POST https://api.marsview.ai/text/profanity/get_profanity

Query Parameters

Name	Type	Description
jwtToken*	String	Marsview api access token. You can generate it here: https://docs.marsview.ai/speech-analytics-api/authentication
text*	String	The sentence you want to detect emotion
userId*	String	Your Marsview user ID
replaceChar*	String	The string character you want to replace detected profane words with

200: OK Response with detected emotion

{
    "status": true,
    "error": {},
    "data": {
        "censoredText": "This is some random ******** text",
        "customProfaneWords": [
            "bullshit"
        ],
        "predefinedProfaneWords": []
    },
    "userId": "[e-mail]"
}

400: Bad Request When a bad request is sent with missing key

{
    "status": false,
    "error": {
        "message": "Bad Request Missing key",
        "code": "RTSPRO002"
    },
    "data": {},
    "userId": "[e-mail]"
}

401: Unauthorized When the user requested with an invalid jwt token

{
    "status": false,
    "message": "Something went wrong while validating your JWT token."
}

Example Curl Request

Shown below is a code snippet to send a sample request for profanity detection

curl --location --request POST 'https://api.marsview.ai/text/profanity/get_profanity' \
--header 'Content-Type: application/json' \
--data-raw '{
    "jwtToken"   : "Insert JWT token Key",
    "sentence"   : "Insert your text for profanity detection here",
    "replaceChar": "The character you want to replace profane words with"
    "userId"     : "[e-mail]"
}'

Example Response

Shown below is a sample JSON response from the above request.

{
    "status": true,
    "error": {},
    "data": {
        "censoredText": "This is some random ******** text",
        "customProfaneWords": [
            "bullshit"
        ],
        "predefinedProfaneWords": []
    },
    "userId": "[e-mail]"
}

Response Object

Field	Description
censoredText	The sentence / phrase for after censoring the profane words
customProfaneWords	List of custom profane words detected
predefinedProfaneWords	List of predefined profane words