software.amazon.awssdk.services.lexruntime.model

Interface IntentSummary.Builder

All Superinterfaces:

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

Enclosing class:

IntentSummary

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

Method Summary

Modifier and Type	Method and Description
IntentSummary.Builder	checkpointLabel(String checkpointLabel) A user-defined label that identifies a particular intent.
IntentSummary.Builder	confirmationStatus(ConfirmationStatus confirmationStatus) The status of the intent after the user responds to the confirmation prompt.
IntentSummary.Builder	confirmationStatus(String confirmationStatus) The status of the intent after the user responds to the confirmation prompt.
IntentSummary.Builder	dialogActionType(DialogActionType dialogActionType) The next action that the bot should take in its interaction with the user.
IntentSummary.Builder	dialogActionType(String dialogActionType) The next action that the bot should take in its interaction with the user.
IntentSummary.Builder	fulfillmentState(FulfillmentState fulfillmentState) The fulfillment state of the intent.
IntentSummary.Builder	fulfillmentState(String fulfillmentState) The fulfillment state of the intent.
IntentSummary.Builder	intentName(String intentName) The name of the intent.
IntentSummary.Builder	slots(Map<String,String> slots) Map of the slots that have been gathered and their values.
IntentSummary.Builder	slotToElicit(String slotToElicit) The next slot to elicit from the user.

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

intentName

IntentSummary.Builder intentName(String intentName)

The name of the intent.

Parameters:

intentName - The name of the intent.

Returns:

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

checkpointLabel

IntentSummary.Builder checkpointLabel(String checkpointLabel)

A user-defined label that identifies a particular intent. You can use this label to return to a previous intent.

Use the checkpointLabelFilter parameter of the GetSessionRequest operation to filter the intents returned by the operation to those with only the specified label.

Parameters:

checkpointLabel - A user-defined label that identifies a particular intent. You can use this label to return to a previous intent.

Use the checkpointLabelFilter parameter of the GetSessionRequest operation to filter the intents returned by the operation to those with only the specified label.

Returns:

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

slots

IntentSummary.Builder slots(Map<String,String> slots)

Map of the slots that have been gathered and their values.

Parameters:

slots - Map of the slots that have been gathered and their values.

Returns:

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

confirmationStatus

IntentSummary.Builder confirmationStatus(String confirmationStatus)

The status of the intent after the user responds to the confirmation prompt. If the user confirms the intent, Amazon Lex sets this field to Confirmed. If the user denies the intent, Amazon Lex sets this value to Denied. The possible values are:

• Confirmed - The user has responded "Yes" to the confirmation prompt, confirming that the intent is complete and that it is ready to be fulfilled.

• Denied - The user has responded "No" to the confirmation prompt.

• None - The user has never been prompted for confirmation; or, the user was prompted but did not confirm or deny the prompt.

Parameters:

confirmationStatus - The status of the intent after the user responds to the confirmation prompt. If the user confirms the intent, Amazon Lex sets this field to Confirmed. If the user denies the intent, Amazon Lex sets this value to Denied. The possible values are:

• Confirmed - The user has responded "Yes" to the confirmation prompt, confirming that the intent is complete and that it is ready to be fulfilled.

• Denied - The user has responded "No" to the confirmation prompt.

• None - The user has never been prompted for confirmation; or, the user was prompted but did not confirm or deny the prompt.

Returns:

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

See Also:

ConfirmationStatus, ConfirmationStatus

confirmationStatus

IntentSummary.Builder confirmationStatus(ConfirmationStatus confirmationStatus)

The status of the intent after the user responds to the confirmation prompt. If the user confirms the intent, Amazon Lex sets this field to Confirmed. If the user denies the intent, Amazon Lex sets this value to Denied. The possible values are:

• Confirmed - The user has responded "Yes" to the confirmation prompt, confirming that the intent is complete and that it is ready to be fulfilled.

• Denied - The user has responded "No" to the confirmation prompt.

• None - The user has never been prompted for confirmation; or, the user was prompted but did not confirm or deny the prompt.

Parameters:

confirmationStatus - The status of the intent after the user responds to the confirmation prompt. If the user confirms the intent, Amazon Lex sets this field to Confirmed. If the user denies the intent, Amazon Lex sets this value to Denied. The possible values are:

• Confirmed - The user has responded "Yes" to the confirmation prompt, confirming that the intent is complete and that it is ready to be fulfilled.

• Denied - The user has responded "No" to the confirmation prompt.

• None - The user has never been prompted for confirmation; or, the user was prompted but did not confirm or deny the prompt.

Returns:

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

See Also:

ConfirmationStatus, ConfirmationStatus

dialogActionType

IntentSummary.Builder dialogActionType(String dialogActionType)

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

• 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?"

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

• ElicitIntent - The next action is to determine the intent that the user wants to fulfill.

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

Parameters:

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

• 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?"

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

• ElicitIntent - The next action is to determine the intent that the user wants to fulfill.

• 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

dialogActionType

IntentSummary.Builder dialogActionType(DialogActionType dialogActionType)

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

• 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?"

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

• ElicitIntent - The next action is to determine the intent that the user wants to fulfill.

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

Parameters:

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

• 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?"

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

• ElicitIntent - The next action is to determine the intent that the user wants to fulfill.

• 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

fulfillmentState

IntentSummary.Builder fulfillmentState(String fulfillmentState)

The fulfillment state of the intent. The possible values are:

• Failed - The Lambda function associated with the intent failed to fulfill the intent.

• Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.

• ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.

Parameters:

fulfillmentState - The fulfillment state of the intent. The possible values are:

• Failed - The Lambda function associated with the intent failed to fulfill the intent.

• Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.

• ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.

Returns:

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

See Also:

FulfillmentState, FulfillmentState

fulfillmentState

IntentSummary.Builder fulfillmentState(FulfillmentState fulfillmentState)

The fulfillment state of the intent. The possible values are:

• Failed - The Lambda function associated with the intent failed to fulfill the intent.

• Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.

• ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.

Parameters:

fulfillmentState - The fulfillment state of the intent. The possible values are:

• Failed - The Lambda function associated with the intent failed to fulfill the intent.

• Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.

• ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.

Returns:

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

See Also:

FulfillmentState, FulfillmentState

slotToElicit

IntentSummary.Builder slotToElicit(String slotToElicit)

The next slot to elicit from the user. If there is not slot to elicit, the field is blank.

Parameters:

slotToElicit - The next slot to elicit from the user. If there is not slot to elicit, the field is blank.

Returns:

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