Overview

Description

Intended Use

This validator ensures that there’s no profanity in any generated text. This validator uses the alt-profanity-check package to check if a string contains profane language.

This validator catches profanity in the English language only.

Requirements

Dependencies:
- guardrails-ai>=0.4.0
- alt-profanity-check

Installation

$ guardrails hub install hub://guardrails/profanity_free

Usage Examples

Validating string output via Python

In this example, we apply the validator to a string output generated by an LLM.

# Import Guard and Validator
from guardrails.hub import ProfanityFree
from guardrails import Guard

# Use the Guard with the validator
guard = Guard().use(
    ProfanityFree, on_fail="exception"
)

guard.validate(
    """
    Director Denis Villeneuve's Dune is a visually stunning and epic adaptation of the classic science fiction novel.
    It is reminiscent of the original Star Wars trilogy, with its grand scale and epic storytelling.
    """
) # Test passing response

try:
    guard.validate(
        """
        He is such a dickhead and a fucking idiot.
        """
    ) # Test failing response
except Exception as e:
    print(e)

Output:

Validation failed for field with errors: 
    He is such a dickhead and a fucking idiot.
contains profanity. Please return profanity-free output.

API Reference

__init__(self, on_fail="noop")

Parameters

on_fail (str, Callable): The policy to enact when a validator fails. If str, must be one of reask, fix, filter, refrain, noop, exception or fix_reask. Otherwise, must be a function that is called when the validator fails.

__call__(self, value, metadata={}) -> ValidationResult

Note:

This method should not be called directly by the user. Instead, invoke guard.parse(...) where this method will be called internally for each associated Validator.
When invoking guard.parse(...), ensure to pass the appropriate metadata dictionary that includes keys and values required by this validator. If guard is associated with multiple validators, combine all necessary metadata into a single dictionary.