Skip to content

SlotSummary

Source code in docs_src/capo_lex_models_v2/types/slot_summary.py
class SlotSummary(TypedDict, closed=True):
    slot_id: NotRequired["capo_lex_models_v2.types.id.Id"]
    """<p>The unique identifier of the slot.</p>"""
    slot_name: NotRequired["capo_lex_models_v2.types.name.Name"]
    """<p>The name given to the slot.</p>"""
    description: NotRequired["capo_lex_models_v2.types.description.Description"]
    """<p>The description of the slot.</p>"""
    slot_constraint: NotRequired[
        "capo_lex_models_v2.types.slot_constraint.SlotConstraint"
    ]
    """<p>Whether the slot is required or optional. An intent is complete when all required slots are filled.</p>"""
    slot_type_id: NotRequired[
        "capo_lex_models_v2.types.built_in_or_custom_slot_type_id.BuiltInOrCustomSlotTypeId"
    ]
    """<p>The unique identifier for the slot type that defines the values for the slot.</p>"""
    value_elicitation_prompt_specification: NotRequired[
        "capo_lex_models_v2.types.prompt_specification.PromptSpecification"
    ]
    """<p>Prompts that are sent to the user to elicit a value for the slot.</p>"""
    last_updated_date_time: NotRequired["capo_lex_models_v2.types.timestamp.Timestamp"]
    """<p>The timestamp of the last date and time that the slot was updated.</p>"""

description instance-attribute

description: NotRequired[Description]

The description of the slot.

last_updated_date_time instance-attribute

last_updated_date_time: NotRequired[Timestamp]

The timestamp of the last date and time that the slot was updated.

slot_constraint instance-attribute

slot_constraint: NotRequired[SlotConstraint]

Whether the slot is required or optional. An intent is complete when all required slots are filled.

slot_id instance-attribute

slot_id: NotRequired[Id]

The unique identifier of the slot.

slot_name instance-attribute

slot_name: NotRequired[Name]

The name given to the slot.

slot_type_id instance-attribute

slot_type_id: NotRequired[BuiltInOrCustomSlotTypeId]

The unique identifier for the slot type that defines the values for the slot.

value_elicitation_prompt_specification instance-attribute

value_elicitation_prompt_specification: NotRequired[PromptSpecification]

Prompts that are sent to the user to elicit a value for the slot.