Skip to content

GuardrailWordConfigDict

Dictionary Type

GuardrailWordConfigDict

Bases: TypedDict

Dictionary form of GuardrailWordConfig.

Attributes

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 intput. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

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.

text instance-attribute
text: Required[str]

Text of the word configured for the guardrail to block.