Slot ¶

class Slot(TypedDict, closed=True):
    name: "capo_lex_model_building_service.types.slot_name.SlotName"
    """<p>The name of the slot.</p>"""
    description: NotRequired[
        "capo_lex_model_building_service.types.description.Description"
    ]
    """<p>A description of the slot.</p>"""
    slot_constraint: (
        "capo_lex_model_building_service.types.slot_constraint.SlotConstraint"
    )
    """<p>Specifies whether the slot is required or optional. </p>"""
    slot_type: NotRequired[
        "capo_lex_model_building_service.types.custom_or_builtin_slot_type_name.CustomOrBuiltinSlotTypeName"
    ]
    """<p>The type of the slot, either a custom slot type that you defined or one of the built-in slot types.</p>"""
    slot_type_version: NotRequired[
        "capo_lex_model_building_service.types.version.Version"
    ]
    """<p>The version of the slot type.</p>"""
    value_elicitation_prompt: NotRequired[
        "capo_lex_model_building_service.types.prompt.Prompt"
    ]
    """<p>The prompt that Amazon Lex uses to elicit the slot value from the user.</p>"""
    priority: NotRequired["capo_lex_model_building_service.types.priority.Priority"]
    """<p> Directs Amazon Lex the order in which to elicit this slot value from the user. For example, if the intent has two slots with priorities 1 and 2, AWS Amazon Lex first elicits a value for the slot with priority 1.</p> <p>If multiple slots share the same priority, the order in which Amazon Lex elicits values is arbitrary.</p>"""
    sample_utterances: NotRequired[
        "capo_lex_model_building_service.types.slot_utterance_list.SlotUtteranceList"
    ]
    """<p> If you know a specific pattern with which users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances. </p>"""
    response_card: NotRequired[
        "capo_lex_model_building_service.types.response_card.ResponseCard"
    ]
    """<p> A set of possible responses for the slot type used by text-based clients. A user chooses an option from the response card, instead of using text to reply. </p>"""
    obfuscation_setting: NotRequired[
        "capo_lex_model_building_service.types.obfuscation_setting.ObfuscationSetting"
    ]
    """<p>Determines whether a slot is obfuscated in conversation logs and stored utterances. When you obfuscate a slot, the value is replaced by the slot name in curly braces ({}). For example, if the slot name is "full_name", obfuscated values are replaced with "{full_name}". For more information, see <a href="https://docs.aws.amazon.com/lex/latest/dg/how-obfuscate.html"> Slot Obfuscation </a>. </p>"""
    default_value_spec: NotRequired[
        "capo_lex_model_building_service.types.slot_default_value_spec.SlotDefaultValueSpec"
    ]
    """<p>A list of default values for the slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.</p>"""