Skip to content

GuardrailTopic

Source code in docs_src/capo_bedrock_runtime/types/guardrail_topic.py 
14
15
16
17
18
19
20
21
22
class GuardrailTopic(TypedDict, closed=True):
    name: "str"
    """<p>The name for the guardrail.</p>"""
    type: "capo_bedrock_runtime.types.guardrail_topic_type.GuardrailTopicType"
    """<p>The type behavior that the guardrail should perform when the model detects the topic.</p>"""
    action: "capo_bedrock_runtime.types.guardrail_topic_policy_action.GuardrailTopicPolicyAction"
    """<p>The action the guardrail should take when it intervenes on a topic.</p>"""
    detected: NotRequired["bool"]
    """<p>Indicates whether topic content that breaches the guardrail configuration is detected.</p>"""

action instance-attribute 

action: GuardrailTopicPolicyAction

The action the guardrail should take when it intervenes on a topic.

detected instance-attribute 

detected: NotRequired[bool]

Indicates whether topic content that breaches the guardrail configuration is detected.

name instance-attribute 

name: str

The name for the guardrail.

type instance-attribute 

type: GuardrailTopicType

The type behavior that the guardrail should perform when the model detects the topic.