Profanity

Check any text for profanity.

Params

text · string · required

The text to validate.

censor_replacement · string · default: "*"

The character to replace profanity with.

Header

x-api-key · string · required

Your JigsawStack API key

Response

success · boolean

Indicates whether the call was successful.

_usage · object

Usage information for the API call.

Show _usage

input_tokens · number

Number of input tokens processed.

output_tokens · number

Number of output tokens generated.

inference_time_tokens · number

Number of tokens processed during inference time.

total_tokens · number

Total number of tokens used (input + output).

message · string

The message returned by the API.

clean_text · string

The text with profanity replaced by the censor_replacement character.

profanities · array

An array of profanities found in the text.

Show Profanity Object

profanity · string | null

The profane word that was detected.

startIndex · number

The starting position of the profanity in the original text.

endIndex · number

The ending position of the profanity in the original text.

profanities_found · boolean

Returns True if profanity is found in the sentence

Javascript

import { JigsawStack } from "jigsawstack";

const jigsaw = JigsawStack({ apiKey: "your-api-key" });

const response = await jigsaw.validate.profanity({
  "text": "This is a sample text that might contain inappropriate language."
})

Response

{
  "success": true,
  "profanities_found": false,
  "profanities": [],
  "clean_text": "This is a sample text that might contain inappropriate language.",
  "_usage": {
        "input_tokens": 20,
        "output_tokens": 35,
        "inference_time_tokens": 114,
        "total_tokens": 169
  }
}