Skip to main content

Use Validators for Input Validation

Validators that are tagged as input validators can be used to validate the input prompt before it is sent to the model. This can be useful for ensuring that the input prompt meets certain criteria, such as being on-topic, not containing PII, etc.

In order to use an input validator, first make sure that the validator is installed. You can install the validator using the guardrails hub install command. For example, to install the two-words validator, you can run:

gudardrails hub install hub://guardrails/detect_pii

Then, add the input validator to the Guard object using the with_prompt_validation method. For example, to use the detect_pii validator with OpenAI's GPT-3, you can run:

from guardrails import Guard, ValidatorError
from guardrails.hub import DetectPII

guard = Guard()
guard.with_prompt_validation([DetectPII(
pii_entities=["EMAIL_ADDRESS", "PHONE_NUMBER"])
])

try:
guard(
openai.chat.completions.create,
prompt="My email address is not_a_real_email@guardrailsai.com",
)
except ValidatorError as e:
print(e)