Skip to content

GuardrailTopicConfigDict

Dictionary Type

GuardrailTopicConfigDict

Bases: TypedDict

Dictionary form of GuardrailTopicConfig.

Attributes

definition instance-attribute
definition: Required[str]

A definition of the topic to deny.

examples instance-attribute
examples: Sequence[str] | None

A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.

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 topic to deny.

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.

type instance-attribute
type: Required[str]

Specifies to deny the topic.