Skip to content

GuardrailTopicConfig

Source code in docs_src/capo_qconnect/types/guardrail_topic_config.py
class GuardrailTopicConfig(TypedDict, closed=True):
    name: "capo_qconnect.types.guardrail_topic_name.GuardrailTopicName"
    """<p>The name of the topic to deny.</p>"""
    definition: (
        "capo_qconnect.types.guardrail_topic_definition.GuardrailTopicDefinition"
    )
    """<p>A definition of the topic to deny.</p>"""
    examples: NotRequired[
        "capo_qconnect.types.guardrail_topic_examples.GuardrailTopicExamples"
    ]
    """<p>A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.</p>"""
    type: "capo_qconnect.types.guardrail_topic_type.GuardrailTopicType"
    """<p>Specifies to deny the topic.</p>"""

definition instance-attribute

A definition of the topic to deny.

examples instance-attribute

examples: NotRequired[GuardrailTopicExamples]

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

name instance-attribute

The name of the topic to deny.

type instance-attribute

Specifies to deny the topic.