Class CreateSlotTypeRequest

    • Method Detail

      • slotTypeName

        public final String slotTypeName()

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

        Returns:
        The name for the slot. A slot type name must be unique within the intent.
      • description

        public final String description()

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

        Returns:
        A description of the slot type. Use the description to help identify the slot type in lists.
      • hasSlotTypeValues

        public final boolean hasSlotTypeValues()
        For responses, this returns true if the service returned a value for the SlotTypeValues property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • slotTypeValues

        public final List<SlotTypeValue> 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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSlotTypeValues() method.

        Returns:
        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.
      • valueSelectionSetting

        public final SlotValueSelectionSetting valueSelectionSetting()

        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 .

        Returns:
        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.

      • parentSlotTypeSignature

        public final String parentSlotTypeSignature()

        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.

        Returns:
        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.

      • botId

        public final String botId()

        The identifier of the bot associated with this slot type.

        Returns:
        The identifier of the bot associated with this slot type.
      • botVersion

        public final String botVersion()

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

        Returns:
        The identifier of the bot version associated with this slot type.
      • localeId

        public final String 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.

        Returns:
        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.
      • externalSourceSetting

        public final ExternalSourceSetting externalSourceSetting()

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

        Returns:
        Sets the type of external information used to create the slot type.
      • compositeSlotTypeSetting

        public final CompositeSlotTypeSetting compositeSlotTypeSetting()

        Specifications for a composite slot type.

        Returns:
        Specifications for a composite slot type.
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object