Overview

Description

Intended Use

The validator ensures that a generated LLM output contains exactly two words.

Requirements

Dependencies:
- guardrails-ai>=0.4.0

Installation

$ guardrails hub install hub://guardrails/two_words

Usage Examples

Validating string output via Python

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

# Setup Guard
guard = Guard().use(TwoWords, on_fail="exception")

response = guard.validate("May December")  # Validator passes

try:
    response = guard.validate("El Camino: A Breaking Bad Movie")  # Validator fails
except Exception as e:
    print(e)

Output:

Validation failed for field with errors: Value must be exactly two words

API Reference

__init__(self, on_fail="noop")

Initializes a new instance of the Validator class.

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

Validates the given value using the rules defined in this validator, relying on the metadata provided to customize the validation process. This method is automatically invoked by guard.parse(...), ensuring the validation logic is applied to the input data.

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.