Skip to content

GuardrailPiiEntity

Source code in docs_src/capo_bedrock/types/guardrail_pii_entity.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class GuardrailPiiEntity(TypedDict, closed=True):
    type: "capo_bedrock.types.guardrail_pii_entity_type.GuardrailPiiEntityType"
    """<p>The type of PII entity. For example, Social Security Number.</p>"""
    action: "capo_bedrock.types.guardrail_sensitive_information_action.GuardrailSensitiveInformationAction"
    """<p>The configured guardrail action when PII entity 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>ANONYMIZE</code> – Mask the content and replace it with identifier tags.</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>ANONYMIZE</code> – Mask the content and replace it with identifier tags.</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 configured guardrail action when PII entity is detected.

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.

  • ANONYMIZE – Mask the content and replace it with identifier tags.

  • 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.

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.

  • ANONYMIZE – Mask the content and replace it with identifier tags.

  • 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.

type instance-attribute 

type: GuardrailPiiEntityType

The type of PII entity. For example, Social Security Number.