Skip to content

CreateSlotTypeRequest

Source code in docs_src/capo_lex_models_v2/types/create_slot_type_request.py
class CreateSlotTypeRequest(TypedDict, closed=True):
    slot_type_name: "capo_lex_models_v2.types.name.Name"
    """<p>The name for the slot. A slot type name must be unique within the intent.</p>"""
    description: NotRequired["capo_lex_models_v2.types.description.Description"]
    """<p>A description of the slot type. Use the description to help identify the slot type in lists.</p>"""
    slot_type_values: NotRequired[
        "capo_lex_models_v2.types.slot_type_values.SlotTypeValues"
    ]
    """<p>A list of <code>SlotTypeValue</code> objects that defines the values that the slot type can take. Each value can have a list of synonyms, additional values that help train the machine learning model about the values that it resolves for a slot.</p>"""
    value_selection_setting: NotRequired[
        "capo_lex_models_v2.types.slot_value_selection_setting.SlotValueSelectionSetting"
    ]
    """<p>Determines the strategy that Amazon Lex uses to select a value from the list of possible values. The field can be set to one of the following values:</p> <ul> <li> <p> <code>ORIGINAL_VALUE</code> - Returns the value entered by the user, if the user value is similar to the slot value.</p> </li> <li> <p> <code>TOP_RESOLUTION</code> - If there is a resolution list for the slot, return the first value in the resolution list. If there is no resolution list, return null.</p> </li> </ul> <p>If you don't specify the <code>valueSelectionSetting</code> parameter, the default is <code>ORIGINAL_VALUE</code>.</p>"""
    parent_slot_type_signature: NotRequired[
        "capo_lex_models_v2.types.slot_type_signature.SlotTypeSignature"
    ]
    """<p>The built-in slot type used as a parent of this slot type. When you define a parent slot type, the new slot type has the configuration of the parent slot type.</p> <p>Only <code>AMAZON.AlphaNumeric</code> is supported.</p>"""
    bot_id: "capo_lex_models_v2.types.id.Id"
    """<p>The identifier of the bot associated with this slot type.</p>"""
    bot_version: "capo_lex_models_v2.types.draft_bot_version.DraftBotVersion"
    """<p>The identifier of the bot version associated with this slot type.</p>"""
    locale_id: "capo_lex_models_v2.types.locale_id.LocaleId"
    """<p>The identifier of the language and locale that the slot type will be used in. The string must match one of the supported locales. All of the bots, intents, and slots used by the slot type must have the same locale. For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.</p>"""
    external_source_setting: NotRequired[
        "capo_lex_models_v2.types.external_source_setting.ExternalSourceSetting"
    ]
    """<p>Sets the type of external information used to create the slot type.</p>"""
    composite_slot_type_setting: NotRequired[
        "capo_lex_models_v2.types.composite_slot_type_setting.CompositeSlotTypeSetting"
    ]
    """<p>Specifications for a composite slot type.</p>"""

bot_id instance-attribute

bot_id: Id

The identifier of the bot associated with this slot type.

bot_version instance-attribute

bot_version: DraftBotVersion

The identifier of the bot version associated with this slot type.

composite_slot_type_setting instance-attribute

composite_slot_type_setting: NotRequired[CompositeSlotTypeSetting]

Specifications for a composite slot type.

description instance-attribute

description: NotRequired[Description]

A description of the slot type. Use the description to help identify the slot type in lists.

external_source_setting instance-attribute

external_source_setting: NotRequired[ExternalSourceSetting]

Sets the type of external information used to create the slot type.

locale_id instance-attribute

locale_id: LocaleId

The identifier of the language and locale that the slot type will be used in. The string must match one of the supported locales. All of the bots, intents, and slots used by the slot type must have the same locale. For more information, see Supported languages.

parent_slot_type_signature instance-attribute

parent_slot_type_signature: NotRequired[SlotTypeSignature]

The built-in slot type used as a parent of this slot type. When you define a parent slot type, the new slot type has the configuration of the parent slot type.

Only AMAZON.AlphaNumeric is supported.

slot_type_name instance-attribute

slot_type_name: Name

The name for the slot. A slot type name must be unique within the intent.

slot_type_values instance-attribute

slot_type_values: NotRequired[SlotTypeValues]

A list of SlotTypeValue objects that defines the values that the slot type can take. Each value can have a list of synonyms, additional values that help train the machine learning model about the values that it resolves for a slot.

value_selection_setting instance-attribute

value_selection_setting: NotRequired[SlotValueSelectionSetting]

Determines the strategy that Amazon Lex uses to select a value from the list of possible values. The field can be set to one of the following values:

  • ORIGINAL_VALUE - Returns the value entered by the user, if the user value is similar to the slot value.

  • TOP_RESOLUTION - If there is a resolution list for the slot, return the first value in the resolution list. If there is no resolution list, return null.

If you don't specify the valueSelectionSetting parameter, the default is ORIGINAL_VALUE.