Interface Slot.Builder

    • Method Detail

      • name

        Slot.Builder name​(String name)

        The name of the slot.

        Parameters:
        name - The name of the slot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • description

        Slot.Builder description​(String description)

        A description of the slot.

        Parameters:
        description - A description of the slot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • slotConstraint

        Slot.Builder slotConstraint​(String slotConstraint)

        Specifies whether the slot is required or optional.

        Parameters:
        slotConstraint - Specifies whether the slot is required or optional.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SlotConstraint, SlotConstraint
      • slotConstraint

        Slot.Builder slotConstraint​(SlotConstraint slotConstraint)

        Specifies whether the slot is required or optional.

        Parameters:
        slotConstraint - Specifies whether the slot is required or optional.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SlotConstraint, SlotConstraint
      • slotType

        Slot.Builder slotType​(String slotType)

        The type of the slot, either a custom slot type that you defined or one of the built-in slot types.

        Parameters:
        slotType - The type of the slot, either a custom slot type that you defined or one of the built-in slot types.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • slotTypeVersion

        Slot.Builder slotTypeVersion​(String slotTypeVersion)

        The version of the slot type.

        Parameters:
        slotTypeVersion - The version of the slot type.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • valueElicitationPrompt

        Slot.Builder valueElicitationPrompt​(Prompt valueElicitationPrompt)

        The prompt that Amazon Lex uses to elicit the slot value from the user.

        Parameters:
        valueElicitationPrompt - The prompt that Amazon Lex uses to elicit the slot value from the user.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • priority

        Slot.Builder priority​(Integer priority)

        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.

        If multiple slots share the same priority, the order in which Amazon Lex elicits values is arbitrary.

        Parameters:
        priority - 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.

        If multiple slots share the same priority, the order in which Amazon Lex elicits values is arbitrary.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • sampleUtterances

        Slot.Builder sampleUtterances​(Collection<String> sampleUtterances)

        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.

        Parameters:
        sampleUtterances - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • sampleUtterances

        Slot.Builder sampleUtterances​(String... sampleUtterances)

        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.

        Parameters:
        sampleUtterances - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • responseCard

        Slot.Builder responseCard​(String responseCard)

        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.

        Parameters:
        responseCard - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • obfuscationSetting

        Slot.Builder obfuscationSetting​(String obfuscationSetting)

        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 Slot Obfuscation .

        Parameters:
        obfuscationSetting - 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 Slot Obfuscation .
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ObfuscationSetting, ObfuscationSetting
      • obfuscationSetting

        Slot.Builder obfuscationSetting​(ObfuscationSetting obfuscationSetting)

        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 Slot Obfuscation .

        Parameters:
        obfuscationSetting - 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 Slot Obfuscation .
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ObfuscationSetting, ObfuscationSetting
      • defaultValueSpec

        Slot.Builder defaultValueSpec​(SlotDefaultValueSpec defaultValueSpec)

        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.

        Parameters:
        defaultValueSpec - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.