Skip to content

Bedrock  >  Structures  >  GuardrailWord

GuardrailWord

Structure Class

GuardrailWord dataclass

A word configured for the guardrail.

Attributes

input_action class-attribute instance-attribute 
input_action: GuardrailWordAction | None = field(repr=False, default=None)

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 class-attribute instance-attribute 
input_enabled: bool | None = None

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 class-attribute instance-attribute 
output_action: GuardrailWordAction | None = field(repr=False, default=None)

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 class-attribute instance-attribute 
output_enabled: bool | None = None

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.

text instance-attribute 
text: str

Text of the word configured for the guardrail to block.