• GitHub logo
  • Discord logo
Loading ...
Guardrails AI
Regex Match
2
See on Github
Ensure content matches a provided regular expression. This can be used to validate content such as email addresses, phone numbers, and more.
en
string
Formatting
Structured data

Overview

updated 2 years
Developed by:
Guardrails AI
Date of development:
Feb 15, 2024
Validator type:
Rule-following
Blog:
License:
Apache 2
Input/Output:
Output

Playground

The validator playground is available to authenticated users. Please log in to use it.

log in
Description
Intended Use

This validator ensures that any given output follows a pre-specified regex rule.

Requirements
  • Dependencies:
    • guardrails-ai>=0.4.0
    • rstr
Installation
$ guardrails hub install hub://guardrails/regex_match
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 RegexMatch
from guardrails import Guard

# Use the Guard with the validator
guard = Guard().use(
    RegexMatch, regex="Open.*", on_fail="exception"
)

# Test passing response
guard.validate(
    "OpenAI's GPT3.5 model is the latest in the GPT series. It is a powerful language model."
)

try:
    # Test failing response
    guard.validate(
        "MetaAI's Llama2 is the latest in their open-source LLM series. It is a powerful language model."
    )
except Exception as e:
    print(e)

Output:

Validation failed for field with errors: Result must match Open.*
API Reference

__init__(self, regex, match_type=None, on_fail="noop")

Initializes a new instance of the Validator class.

Parameters

  • regex (str): String representing the regex pattern
  • match_type (Optional[str]): One of search or fullmatch
  • 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.

validate(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:

  1. 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.
  2. 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.

Parameters

  • value (Any): The input value to validate.
  • metadata (dict): A dictionary containing metadata required for validation. No additional metadata keys are needed for this validator.