Skip to content

GuardrailRegex

Source code in docs_src/capo_bedrock/types/guardrail_regex.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class GuardrailRegex(TypedDict, closed=True):
    name: "str"
    """<p>The name of the regular expression for the guardrail.</p>"""
    description: NotRequired["str"]
    """<p>The description of the regular expression for the guardrail.</p>"""
    pattern: "str"
    """<p>The pattern of the regular expression configured for the guardrail.</p>"""
    action: "capo_bedrock.types.guardrail_sensitive_information_action.GuardrailSensitiveInformationAction"
    """<p>The action taken when a match to the regular expression is detected.</p>"""
    input_action: NotRequired[
        "capo_bedrock.types.guardrail_sensitive_information_action.GuardrailSensitiveInformationAction"
    ]
    """<p>The action to take when harmful content is detected in the input. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>"""
    output_action: NotRequired[
        "capo_bedrock.types.guardrail_sensitive_information_action.GuardrailSensitiveInformationAction"
    ]
    """<p>The action to take when harmful content is detected in the output. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>"""
    input_enabled: NotRequired["bool"]
    """<p>Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>"""
    output_enabled: NotRequired["bool"]
    """<p>Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>"""

action instance-attribute 

action: GuardrailSensitiveInformationAction

The action taken when a match to the regular expression is detected.

description instance-attribute 

description: NotRequired[str]

The description of the regular expression for the guardrail.

input_action instance-attribute 

input_action: NotRequired[GuardrailSensitiveInformationAction]

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: NotRequired[bool]

Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

name instance-attribute 

name: str

The name of the regular expression for the guardrail.

output_action instance-attribute 

output_action: NotRequired[GuardrailSensitiveInformationAction]

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: NotRequired[bool]

Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

pattern instance-attribute 

pattern: str

The pattern of the regular expression configured for the guardrail.