Package software.amazon.awssdk.services.lexruntimev2.model

Interface DialogAction.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DialogAction.Builder,DialogAction>, SdkBuilder<DialogAction.Builder,DialogAction>, SdkPojo

Enclosing class:

DialogAction

public static interface DialogAction.Builder
extends SdkPojo, CopyableBuilder<DialogAction.Builder,DialogAction>

Method Summary

Modifier and Type	Method	Description
DialogAction.Builder	slotElicitationStyle(String slotElicitationStyle)	Configures the slot to use spell-by-letter or spell-by-word style.
DialogAction.Builder	slotElicitationStyle(StyleType slotElicitationStyle)	Configures the slot to use spell-by-letter or spell-by-word style.
DialogAction.Builder	slotToElicit(String slotToElicit)	The name of the slot that should be elicited from the user.
default DialogAction.Builder	subSlotToElicit(Consumer<ElicitSubSlot.Builder> subSlotToElicit)	The name of the constituent sub slot of the composite slot specified in slotToElicit that should be elicited from the user.
DialogAction.Builder	subSlotToElicit(ElicitSubSlot subSlotToElicit)	The name of the constituent sub slot of the composite slot specified in slotToElicit that should be elicited from the user.
DialogAction.Builder	type(String type)	The next action that the bot should take in its interaction with the user.
DialogAction.Builder	type(DialogActionType type)	The next action that the bot should take in its interaction with the user.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

type

DialogAction.Builder type(String type)

The next action that the bot should take in its interaction with the user. The following values are possible:

• Close – Indicates that there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.

• ConfirmIntent – The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"

• Delegate – The next action is determined by Amazon Lex V2.

• ElicitIntent – The next action is to elicit an intent from the user.

• ElicitSlot – The next action is to elicit a slot value from the user.

Parameters:

type - The next action that the bot should take in its interaction with the user. The following values are possible:

• Close – Indicates that there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.

• ConfirmIntent – The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"

• Delegate – The next action is determined by Amazon Lex V2.

• ElicitIntent – The next action is to elicit an intent from the user.

• ElicitSlot – The next action is to elicit a slot value from the user.

Returns:

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

See Also:

DialogActionType, DialogActionType

type

DialogAction.Builder type(DialogActionType type)

The next action that the bot should take in its interaction with the user. The following values are possible:

• Close – Indicates that there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.

• ConfirmIntent – The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"

• Delegate – The next action is determined by Amazon Lex V2.

• ElicitIntent – The next action is to elicit an intent from the user.

• ElicitSlot – The next action is to elicit a slot value from the user.

Parameters:

type - The next action that the bot should take in its interaction with the user. The following values are possible:

• Close – Indicates that there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.

• ConfirmIntent – The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"

• Delegate – The next action is determined by Amazon Lex V2.

• ElicitIntent – The next action is to elicit an intent from the user.

• ElicitSlot – The next action is to elicit a slot value from the user.

Returns:

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

See Also:

DialogActionType, DialogActionType

slotToElicit

DialogAction.Builder slotToElicit(String slotToElicit)

The name of the slot that should be elicited from the user.

Parameters:

slotToElicit - The name of the slot that should be elicited from the user.

Returns:

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

slotElicitationStyle

DialogAction.Builder slotElicitationStyle(String slotElicitationStyle)

Configures the slot to use spell-by-letter or spell-by-word style. When you use a style on a slot, users can spell out their input to make it clear to your bot.

• Spell by letter - "b" "o" "b"

• Spell by word - "b as in boy" "o as in oscar" "b as in boy"

For more information, see Using spelling to enter slot values .

Parameters:

slotElicitationStyle - Configures the slot to use spell-by-letter or spell-by-word style. When you use a style on a slot, users can spell out their input to make it clear to your bot.

• Spell by letter - "b" "o" "b"

• Spell by word - "b as in boy" "o as in oscar" "b as in boy"

For more information, see Using spelling to enter slot values .

Returns:

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

See Also:

StyleType, StyleType

slotElicitationStyle

DialogAction.Builder slotElicitationStyle(StyleType slotElicitationStyle)

Configures the slot to use spell-by-letter or spell-by-word style. When you use a style on a slot, users can spell out their input to make it clear to your bot.

• Spell by letter - "b" "o" "b"

• Spell by word - "b as in boy" "o as in oscar" "b as in boy"

For more information, see Using spelling to enter slot values .

Parameters:

slotElicitationStyle - Configures the slot to use spell-by-letter or spell-by-word style. When you use a style on a slot, users can spell out their input to make it clear to your bot.

• Spell by letter - "b" "o" "b"

• Spell by word - "b as in boy" "o as in oscar" "b as in boy"

For more information, see Using spelling to enter slot values .

Returns:

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

See Also:

StyleType, StyleType

subSlotToElicit

DialogAction.Builder subSlotToElicit(ElicitSubSlot subSlotToElicit)

The name of the constituent sub slot of the composite slot specified in slotToElicit that should be elicited from the user.

Parameters:

subSlotToElicit - The name of the constituent sub slot of the composite slot specified in slotToElicit that should be elicited from the user.

Returns:

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

subSlotToElicit

default DialogAction.Builder subSlotToElicit(Consumer<ElicitSubSlot.Builder> subSlotToElicit)

The name of the constituent sub slot of the composite slot specified in slotToElicit that should be elicited from the user.

This is a convenience method that creates an instance of the ElicitSubSlot.Builder avoiding the need to create one manually via ElicitSubSlot.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to subSlotToElicit(ElicitSubSlot).

Parameters:

subSlotToElicit - a consumer that will call methods on ElicitSubSlot.Builder

Returns:

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

See Also:

subSlotToElicit(ElicitSubSlot)