Skip to content

GuardrailRegexConfigDict

Dictionary Type

GuardrailRegexConfigDict

Bases: TypedDict

Dictionary form of GuardrailRegexConfig.

Attributes

action instance-attribute
action: Required[str]

The guardrail action to configure when matching regular expression is detected.

description instance-attribute
description: str | None

The description of the regular expression to configure for the guardrail.

input_action instance-attribute
input_action: str | None

Specifies the action to take when harmful content is detected in the input. Supported values include:

  • BLOCK -- Block the content and replace it with blocked messaging.

  • NONE -- Take no action but return detection information in the trace response.

input_enabled instance-attribute
input_enabled: bool | None

Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

name instance-attribute
name: Required[str]

The name of the regular expression to configure for the guardrail.

output_action instance-attribute
output_action: str | None

Specifies the action to take when harmful content is detected in the output. Supported values include:

  • BLOCK -- Block the content and replace it with blocked messaging.

  • NONE -- Take no action but return detection information in the trace response.

output_enabled instance-attribute
output_enabled: bool | None

Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

pattern instance-attribute
pattern: Required[str]

The regular expression pattern to configure for the guardrail.