/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.lexruntime.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PostTextResult extends com.amazonaws.AmazonWebServiceResult
* The current user intent that Amazon Lex is aware of.
*
* Provides a score that indicates how confident Amazon Lex is that the returned intent is the one that matches the
* user's intent. The score is between 0.0 and 1.0. For more information, see Confidence Scores.
*
* The score is a relative score, not an absolute score. The score may change based on improvements to Amazon Lex.
*
* One to four alternative intents that may be applicable to the user's intent.
*
* Each alternative includes a score that indicates how confident Amazon Lex is that the intent matches the user's
* intent. The intents are sorted by the confidence score.
*
* The intent slots that Amazon Lex detected from the user input in the conversation.
*
* Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined
* by the
* A map of key-value pairs representing the session-specific context information.
*
* The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.
*
* If the intent is not configured with a Lambda function, or if the Lambda function returned
* When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex
* returns one message from each group in the response. The message field is an escaped JSON string containing the
* messages. For more information about the structure of the JSON string returned, see msg-prompts-formats.
*
* If the Lambda function returns a message, Amazon Lex passes it to the client in its response.
*
* The sentiment expressed in and utterance.
*
* When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains
* the result of the analysis.
*
* The format of the response message. One of the following values:
*
*
*
*
*
* Identifies the current state of the user interaction. Amazon Lex returns one of the following values as
*
*
* For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent
* from this utterance, it will return this dialogState.
*
*
* For example, Amazon Lex wants user confirmation before fulfilling an intent.
*
* Instead of a simple "yes" or "no," a user might respond with additional information. For example,
* "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such additional
* information (in these examples, update the crust type slot value, or change intent from OrderPizza to
* OrderDrink).
*
*
* For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A
* user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the
* response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately.
*
*
*
*
* This can happen for various reasons including that the user did not provide an appropriate response to prompts
* from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or the
* Lambda function failed to fulfill the intent.
*
* If the
* Represents the options that the user has to respond to the current prompt. Response Card can come from the bot
* configuration (in the Amazon Lex console, choose the settings button next to a slot) or from a code hook (Lambda
* function).
*
* A unique identifier for the session.
*
* The version of the bot that responded to the conversation. You can use this information to help determine if one
* version of a bot is performing better than another version.
*
* A list of active contexts for the session. A context can be set when an intent is fulfilled or by calling the
*
* You can use a context to control the intents that can follow up an intent, or to modify the operation of your
* application.
*
* The current user intent that Amazon Lex is aware of.
*
* The current user intent that Amazon Lex is aware of.
*
* The current user intent that Amazon Lex is aware of.
*
* Provides a score that indicates how confident Amazon Lex is that the returned intent is the one that matches the
* user's intent. The score is between 0.0 and 1.0. For more information, see Confidence Scores.
*
* The score is a relative score, not an absolute score. The score may change based on improvements to Amazon Lex.
* valueSelectionStrategy
selected when the slot type was created or updated. If
* valueSelectionStrategy
is set to ORIGINAL_VALUE
, the value provided by the user is
* returned, if the user value is similar to the slot values. If valueSelectionStrategy
is set to
* TOP_RESOLUTION
Amazon Lex returns the first value in the resolution list or, if there is no
* resolution list, null. If you don't specify a valueSelectionStrategy
, the default is
* ORIGINAL_VALUE
.
* Delegate
* as the dialogAction.type
its response, Amazon Lex decides on the next course of action and selects
* an appropriate message from the bot's configuration based on the current interaction context. For example, if
* Amazon Lex isn't able to understand user input, it uses a clarification prompt message.
*
*
*/
private String messageFormat;
/**
* PlainText
- The message contains plain UTF-8 text.
* CustomPayload
- The message is a custom format defined by the Lambda function.
* SSML
- The message contains text formatted for voice output.
* Composite
- The message contains an escaped JSON object containing one or more messages from the
* groups that messages were assigned to when the intent was created.
* dialogState
. The client can optionally use this information to customize the user interface.
*
*
*/
private String dialogState;
/**
* ElicitIntent
- Amazon Lex wants to elicit user intent.
* ConfirmIntent
- Amazon Lex is expecting a "yes" or "no" response.
* ElicitSlot
- Amazon Lex is expecting a slot value for the current intent.
* Fulfilled
- Conveys that the Lambda function configured for the intent has successfully fulfilled
* the intent.
* ReadyForFulfillment
- Conveys that the client has to fulfill the intent.
* Failed
- Conveys that the conversation with the user failed.
* dialogState
value is ElicitSlot
, returns the name of the slot for which Amazon
* Lex is eliciting a value.
* PostContent
, PostText
, or PutSession
operation.
*
* The score is a relative score, not an absolute score. The score may change based on improvements to Amazon * Lex. */ public void setNluIntentConfidence(IntentConfidence nluIntentConfidence) { this.nluIntentConfidence = nluIntentConfidence; } /** *
* Provides a score that indicates how confident Amazon Lex is that the returned intent is the one that matches the * user's intent. The score is between 0.0 and 1.0. For more information, see Confidence Scores. *
** The score is a relative score, not an absolute score. The score may change based on improvements to Amazon Lex. *
* * @return Provides a score that indicates how confident Amazon Lex is that the returned intent is the one that * matches the user's intent. The score is between 0.0 and 1.0. For more information, see Confidence Scores. ** The score is a relative score, not an absolute score. The score may change based on improvements to * Amazon Lex. */ public IntentConfidence getNluIntentConfidence() { return this.nluIntentConfidence; } /** *
* Provides a score that indicates how confident Amazon Lex is that the returned intent is the one that matches the * user's intent. The score is between 0.0 and 1.0. For more information, see Confidence Scores. *
** The score is a relative score, not an absolute score. The score may change based on improvements to Amazon Lex. *
* * @param nluIntentConfidence * Provides a score that indicates how confident Amazon Lex is that the returned intent is the one that * matches the user's intent. The score is between 0.0 and 1.0. For more information, see Confidence Scores. ** The score is a relative score, not an absolute score. The score may change based on improvements to Amazon * Lex. * @return Returns a reference to this object so that method calls can be chained together. */ public PostTextResult withNluIntentConfidence(IntentConfidence nluIntentConfidence) { setNluIntentConfidence(nluIntentConfidence); return this; } /** *
* One to four alternative intents that may be applicable to the user's intent. *
** Each alternative includes a score that indicates how confident Amazon Lex is that the intent matches the user's * intent. The intents are sorted by the confidence score. *
* * @return One to four alternative intents that may be applicable to the user's intent. *
* Each alternative includes a score that indicates how confident Amazon Lex is that the intent matches the
* user's intent. The intents are sorted by the confidence score.
*/
public java.util.List
* One to four alternative intents that may be applicable to the user's intent.
*
* Each alternative includes a score that indicates how confident Amazon Lex is that the intent matches the user's
* intent. The intents are sorted by the confidence score.
*
* Each alternative includes a score that indicates how confident Amazon Lex is that the intent matches the
* user's intent. The intents are sorted by the confidence score.
*/
public void setAlternativeIntents(java.util.Collection
* One to four alternative intents that may be applicable to the user's intent.
*
* Each alternative includes a score that indicates how confident Amazon Lex is that the intent matches the user's
* intent. The intents are sorted by the confidence score.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setAlternativeIntents(java.util.Collection)} or {@link #withAlternativeIntents(java.util.Collection)} if
* you want to override the existing values.
*
* Each alternative includes a score that indicates how confident Amazon Lex is that the intent matches the
* user's intent. The intents are sorted by the confidence score.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PostTextResult withAlternativeIntents(PredictedIntent... alternativeIntents) {
if (this.alternativeIntents == null) {
setAlternativeIntents(new java.util.ArrayList
* One to four alternative intents that may be applicable to the user's intent.
*
* Each alternative includes a score that indicates how confident Amazon Lex is that the intent matches the user's
* intent. The intents are sorted by the confidence score.
*
* Each alternative includes a score that indicates how confident Amazon Lex is that the intent matches the
* user's intent. The intents are sorted by the confidence score.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PostTextResult withAlternativeIntents(java.util.Collection
* The intent slots that Amazon Lex detected from the user input in the conversation.
*
* Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined
* by the valueSelectionStrategy
selected when the slot type was created or updated. If
* valueSelectionStrategy
is set to ORIGINAL_VALUE
, the value provided by the user is
* returned, if the user value is similar to the slot values. If valueSelectionStrategy
is set to
* TOP_RESOLUTION
Amazon Lex returns the first value in the resolution list or, if there is no
* resolution list, null. If you don't specify a valueSelectionStrategy
, the default is
* ORIGINAL_VALUE
.
*
* Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is
* determined by the
* The intent slots that Amazon Lex detected from the user input in the conversation.
*
* Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined
* by the valueSelectionStrategy
selected when the slot type was created or updated.
* If valueSelectionStrategy
is set to ORIGINAL_VALUE
, the value provided by the
* user is returned, if the user value is similar to the slot values. If valueSelectionStrategy
* is set to TOP_RESOLUTION
Amazon Lex returns the first value in the resolution list or, if
* there is no resolution list, null. If you don't specify a valueSelectionStrategy
, the
* default is ORIGINAL_VALUE
.
*/
public java.util.MapvalueSelectionStrategy
selected when the slot type was created or updated. If
* valueSelectionStrategy
is set to ORIGINAL_VALUE
, the value provided by the user is
* returned, if the user value is similar to the slot values. If valueSelectionStrategy
is set to
* TOP_RESOLUTION
Amazon Lex returns the first value in the resolution list or, if there is no
* resolution list, null. If you don't specify a valueSelectionStrategy
, the default is
* ORIGINAL_VALUE
.
*
* Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is
* determined by the
* The intent slots that Amazon Lex detected from the user input in the conversation.
*
* Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined
* by the valueSelectionStrategy
selected when the slot type was created or updated.
* If valueSelectionStrategy
is set to ORIGINAL_VALUE
, the value provided by the
* user is returned, if the user value is similar to the slot values. If valueSelectionStrategy
* is set to TOP_RESOLUTION
Amazon Lex returns the first value in the resolution list or, if
* there is no resolution list, null. If you don't specify a valueSelectionStrategy
, the default
* is ORIGINAL_VALUE
.
*/
public void setSlots(java.util.MapvalueSelectionStrategy
selected when the slot type was created or updated. If
* valueSelectionStrategy
is set to ORIGINAL_VALUE
, the value provided by the user is
* returned, if the user value is similar to the slot values. If valueSelectionStrategy
is set to
* TOP_RESOLUTION
Amazon Lex returns the first value in the resolution list or, if there is no
* resolution list, null. If you don't specify a valueSelectionStrategy
, the default is
* ORIGINAL_VALUE
.
*
* Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is
* determined by the
* A map of key-value pairs representing the session-specific context information.
*
* A map of key-value pairs representing the session-specific context information.
*
* A map of key-value pairs representing the session-specific context information.
*
* The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.
*
* If the intent is not configured with a Lambda function, or if the Lambda function returned
* When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex
* returns one message from each group in the response. The message field is an escaped JSON string containing the
* messages. For more information about the structure of the JSON string returned, see msg-prompts-formats.
*
* If the Lambda function returns a message, Amazon Lex passes it to the client in its response.
* valueSelectionStrategy
selected when the slot type was created or updated.
* If valueSelectionStrategy
is set to ORIGINAL_VALUE
, the value provided by the
* user is returned, if the user value is similar to the slot values. If valueSelectionStrategy
* is set to TOP_RESOLUTION
Amazon Lex returns the first value in the resolution list or, if
* there is no resolution list, null. If you don't specify a valueSelectionStrategy
, the default
* is ORIGINAL_VALUE
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PostTextResult withSlots(java.util.MapDelegate
* as the dialogAction.type
its response, Amazon Lex decides on the next course of action and selects
* an appropriate message from the bot's configuration based on the current interaction context. For example, if
* Amazon Lex isn't able to understand user input, it uses a clarification prompt message.
*
* If the intent is not configured with a Lambda function, or if the Lambda function returned
* Delegate
as the dialogAction.type
its response, Amazon Lex decides on the next
* course of action and selects an appropriate message from the bot's configuration based on the current
* interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a
* clarification prompt message.
*
* When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon * Lex returns one message from each group in the response. The message field is an escaped JSON string * containing the messages. For more information about the structure of the JSON string returned, see * msg-prompts-formats. *
** If the Lambda function returns a message, Amazon Lex passes it to the client in its response. */ public void setMessage(String message) { this.message = message; } /** *
* The message to convey to the user. The message can come from the bot's configuration or from a Lambda function. *
*
* If the intent is not configured with a Lambda function, or if the Lambda function returned Delegate
* as the dialogAction.type
its response, Amazon Lex decides on the next course of action and selects
* an appropriate message from the bot's configuration based on the current interaction context. For example, if
* Amazon Lex isn't able to understand user input, it uses a clarification prompt message.
*
* When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex * returns one message from each group in the response. The message field is an escaped JSON string containing the * messages. For more information about the structure of the JSON string returned, see msg-prompts-formats. *
** If the Lambda function returns a message, Amazon Lex passes it to the client in its response. *
* * @return The message to convey to the user. The message can come from the bot's configuration or from a Lambda * function. *
* If the intent is not configured with a Lambda function, or if the Lambda function returned
* Delegate
as the dialogAction.type
its response, Amazon Lex decides on the next
* course of action and selects an appropriate message from the bot's configuration based on the current
* interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a
* clarification prompt message.
*
* When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon * Lex returns one message from each group in the response. The message field is an escaped JSON string * containing the messages. For more information about the structure of the JSON string returned, see * msg-prompts-formats. *
** If the Lambda function returns a message, Amazon Lex passes it to the client in its response. */ public String getMessage() { return this.message; } /** *
* The message to convey to the user. The message can come from the bot's configuration or from a Lambda function. *
*
* If the intent is not configured with a Lambda function, or if the Lambda function returned Delegate
* as the dialogAction.type
its response, Amazon Lex decides on the next course of action and selects
* an appropriate message from the bot's configuration based on the current interaction context. For example, if
* Amazon Lex isn't able to understand user input, it uses a clarification prompt message.
*
* When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex * returns one message from each group in the response. The message field is an escaped JSON string containing the * messages. For more information about the structure of the JSON string returned, see msg-prompts-formats. *
** If the Lambda function returns a message, Amazon Lex passes it to the client in its response. *
* * @param message * The message to convey to the user. The message can come from the bot's configuration or from a Lambda * function. *
* If the intent is not configured with a Lambda function, or if the Lambda function returned
* Delegate
as the dialogAction.type
its response, Amazon Lex decides on the next
* course of action and selects an appropriate message from the bot's configuration based on the current
* interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a
* clarification prompt message.
*
* When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon * Lex returns one message from each group in the response. The message field is an escaped JSON string * containing the messages. For more information about the structure of the JSON string returned, see * msg-prompts-formats. *
** If the Lambda function returns a message, Amazon Lex passes it to the client in its response. * @return Returns a reference to this object so that method calls can be chained together. */ public PostTextResult withMessage(String message) { setMessage(message); return this; } /** *
* The sentiment expressed in and utterance. *
** When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains * the result of the analysis. *
* * @param sentimentResponse * The sentiment expressed in and utterance. ** When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field * contains the result of the analysis. */ public void setSentimentResponse(SentimentResponse sentimentResponse) { this.sentimentResponse = sentimentResponse; } /** *
* The sentiment expressed in and utterance. *
** When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains * the result of the analysis. *
* * @return The sentiment expressed in and utterance. ** When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field * contains the result of the analysis. */ public SentimentResponse getSentimentResponse() { return this.sentimentResponse; } /** *
* The sentiment expressed in and utterance. *
** When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains * the result of the analysis. *
* * @param sentimentResponse * The sentiment expressed in and utterance. ** When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field * contains the result of the analysis. * @return Returns a reference to this object so that method calls can be chained together. */ public PostTextResult withSentimentResponse(SentimentResponse sentimentResponse) { setSentimentResponse(sentimentResponse); return this; } /** *
* The format of the response message. One of the following values: *
*
* PlainText
- The message contains plain UTF-8 text.
*
* CustomPayload
- The message is a custom format defined by the Lambda function.
*
* SSML
- The message contains text formatted for voice output.
*
* Composite
- The message contains an escaped JSON object containing one or more messages from the
* groups that messages were assigned to when the intent was created.
*
* PlainText
- The message contains plain UTF-8 text.
*
* CustomPayload
- The message is a custom format defined by the Lambda function.
*
* SSML
- The message contains text formatted for voice output.
*
* Composite
- The message contains an escaped JSON object containing one or more messages from
* the groups that messages were assigned to when the intent was created.
*
* The format of the response message. One of the following values: *
*
* PlainText
- The message contains plain UTF-8 text.
*
* CustomPayload
- The message is a custom format defined by the Lambda function.
*
* SSML
- The message contains text formatted for voice output.
*
* Composite
- The message contains an escaped JSON object containing one or more messages from the
* groups that messages were assigned to when the intent was created.
*
* PlainText
- The message contains plain UTF-8 text.
*
* CustomPayload
- The message is a custom format defined by the Lambda function.
*
* SSML
- The message contains text formatted for voice output.
*
* Composite
- The message contains an escaped JSON object containing one or more messages from
* the groups that messages were assigned to when the intent was created.
*
* The format of the response message. One of the following values: *
*
* PlainText
- The message contains plain UTF-8 text.
*
* CustomPayload
- The message is a custom format defined by the Lambda function.
*
* SSML
- The message contains text formatted for voice output.
*
* Composite
- The message contains an escaped JSON object containing one or more messages from the
* groups that messages were assigned to when the intent was created.
*
* PlainText
- The message contains plain UTF-8 text.
*
* CustomPayload
- The message is a custom format defined by the Lambda function.
*
* SSML
- The message contains text formatted for voice output.
*
* Composite
- The message contains an escaped JSON object containing one or more messages from
* the groups that messages were assigned to when the intent was created.
*
* The format of the response message. One of the following values: *
*
* PlainText
- The message contains plain UTF-8 text.
*
* CustomPayload
- The message is a custom format defined by the Lambda function.
*
* SSML
- The message contains text formatted for voice output.
*
* Composite
- The message contains an escaped JSON object containing one or more messages from the
* groups that messages were assigned to when the intent was created.
*
* PlainText
- The message contains plain UTF-8 text.
*
* CustomPayload
- The message is a custom format defined by the Lambda function.
*
* SSML
- The message contains text formatted for voice output.
*
* Composite
- The message contains an escaped JSON object containing one or more messages from
* the groups that messages were assigned to when the intent was created.
*
* The format of the response message. One of the following values: *
*
* PlainText
- The message contains plain UTF-8 text.
*
* CustomPayload
- The message is a custom format defined by the Lambda function.
*
* SSML
- The message contains text formatted for voice output.
*
* Composite
- The message contains an escaped JSON object containing one or more messages from the
* groups that messages were assigned to when the intent was created.
*
* PlainText
- The message contains plain UTF-8 text.
*
* CustomPayload
- The message is a custom format defined by the Lambda function.
*
* SSML
- The message contains text formatted for voice output.
*
* Composite
- The message contains an escaped JSON object containing one or more messages from
* the groups that messages were assigned to when the intent was created.
*
* Identifies the current state of the user interaction. Amazon Lex returns one of the following values as
* dialogState
. The client can optionally use this information to customize the user interface.
*
* ElicitIntent
- Amazon Lex wants to elicit user intent.
*
* For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent * from this utterance, it will return this dialogState. *
*
* ConfirmIntent
- Amazon Lex is expecting a "yes" or "no" response.
*
* For example, Amazon Lex wants user confirmation before fulfilling an intent. *
** Instead of a simple "yes" or "no," a user might respond with additional information. For example, * "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such additional * information (in these examples, update the crust type slot value, or change intent from OrderPizza to * OrderDrink). *
*
* ElicitSlot
- Amazon Lex is expecting a slot value for the current intent.
*
* For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A * user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the * response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately. *
*
* Fulfilled
- Conveys that the Lambda function configured for the intent has successfully fulfilled
* the intent.
*
* ReadyForFulfillment
- Conveys that the client has to fulfill the intent.
*
* Failed
- Conveys that the conversation with the user failed.
*
* This can happen for various reasons including that the user did not provide an appropriate response to prompts * from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or the * Lambda function failed to fulfill the intent. *
*dialogState
. The client can optionally use this information to customize the user interface.
*
*
* ElicitIntent
- Amazon Lex wants to elicit user intent.
*
* For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user * intent from this utterance, it will return this dialogState. *
*
* ConfirmIntent
- Amazon Lex is expecting a "yes" or "no" response.
*
* For example, Amazon Lex wants user confirmation before fulfilling an intent. *
** Instead of a simple "yes" or "no," a user might respond with additional information. For example, * "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such * additional information (in these examples, update the crust type slot value, or change intent from * OrderPizza to OrderDrink). *
*
* ElicitSlot
- Amazon Lex is expecting a slot value for the current intent.
*
* For example, suppose that in the response Amazon Lex sends this message: * "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might * also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can * process such additional information appropriately. *
*
* Fulfilled
- Conveys that the Lambda function configured for the intent has successfully
* fulfilled the intent.
*
* ReadyForFulfillment
- Conveys that the client has to fulfill the intent.
*
* Failed
- Conveys that the conversation with the user failed.
*
* This can happen for various reasons including that the user did not provide an appropriate response to * prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific * information), or the Lambda function failed to fulfill the intent. *
*
* Identifies the current state of the user interaction. Amazon Lex returns one of the following values as
* dialogState
. The client can optionally use this information to customize the user interface.
*
* ElicitIntent
- Amazon Lex wants to elicit user intent.
*
* For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent * from this utterance, it will return this dialogState. *
*
* ConfirmIntent
- Amazon Lex is expecting a "yes" or "no" response.
*
* For example, Amazon Lex wants user confirmation before fulfilling an intent. *
** Instead of a simple "yes" or "no," a user might respond with additional information. For example, * "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such additional * information (in these examples, update the crust type slot value, or change intent from OrderPizza to * OrderDrink). *
*
* ElicitSlot
- Amazon Lex is expecting a slot value for the current intent.
*
* For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A * user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the * response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately. *
*
* Fulfilled
- Conveys that the Lambda function configured for the intent has successfully fulfilled
* the intent.
*
* ReadyForFulfillment
- Conveys that the client has to fulfill the intent.
*
* Failed
- Conveys that the conversation with the user failed.
*
* This can happen for various reasons including that the user did not provide an appropriate response to prompts * from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or the * Lambda function failed to fulfill the intent. *
*dialogState
. The client can optionally use this information to customize the user interface.
*
*
* ElicitIntent
- Amazon Lex wants to elicit user intent.
*
* For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the * user intent from this utterance, it will return this dialogState. *
*
* ConfirmIntent
- Amazon Lex is expecting a "yes" or "no" response.
*
* For example, Amazon Lex wants user confirmation before fulfilling an intent. *
** Instead of a simple "yes" or "no," a user might respond with additional information. For example, * "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such * additional information (in these examples, update the crust type slot value, or change intent from * OrderPizza to OrderDrink). *
*
* ElicitSlot
- Amazon Lex is expecting a slot value for the current intent.
*
* For example, suppose that in the response Amazon Lex sends this message: * "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user * might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex * can process such additional information appropriately. *
*
* Fulfilled
- Conveys that the Lambda function configured for the intent has successfully
* fulfilled the intent.
*
* ReadyForFulfillment
- Conveys that the client has to fulfill the intent.
*
* Failed
- Conveys that the conversation with the user failed.
*
* This can happen for various reasons including that the user did not provide an appropriate response to * prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific * information), or the Lambda function failed to fulfill the intent. *
*
* Identifies the current state of the user interaction. Amazon Lex returns one of the following values as
* dialogState
. The client can optionally use this information to customize the user interface.
*
* ElicitIntent
- Amazon Lex wants to elicit user intent.
*
* For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent * from this utterance, it will return this dialogState. *
*
* ConfirmIntent
- Amazon Lex is expecting a "yes" or "no" response.
*
* For example, Amazon Lex wants user confirmation before fulfilling an intent. *
** Instead of a simple "yes" or "no," a user might respond with additional information. For example, * "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such additional * information (in these examples, update the crust type slot value, or change intent from OrderPizza to * OrderDrink). *
*
* ElicitSlot
- Amazon Lex is expecting a slot value for the current intent.
*
* For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A * user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the * response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately. *
*
* Fulfilled
- Conveys that the Lambda function configured for the intent has successfully fulfilled
* the intent.
*
* ReadyForFulfillment
- Conveys that the client has to fulfill the intent.
*
* Failed
- Conveys that the conversation with the user failed.
*
* This can happen for various reasons including that the user did not provide an appropriate response to prompts * from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or the * Lambda function failed to fulfill the intent. *
*dialogState
. The client can optionally use this information to customize the user interface.
*
*
* ElicitIntent
- Amazon Lex wants to elicit user intent.
*
* For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user * intent from this utterance, it will return this dialogState. *
*
* ConfirmIntent
- Amazon Lex is expecting a "yes" or "no" response.
*
* For example, Amazon Lex wants user confirmation before fulfilling an intent. *
** Instead of a simple "yes" or "no," a user might respond with additional information. For example, * "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such * additional information (in these examples, update the crust type slot value, or change intent from * OrderPizza to OrderDrink). *
*
* ElicitSlot
- Amazon Lex is expecting a slot value for the current intent.
*
* For example, suppose that in the response Amazon Lex sends this message: * "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might * also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can * process such additional information appropriately. *
*
* Fulfilled
- Conveys that the Lambda function configured for the intent has successfully
* fulfilled the intent.
*
* ReadyForFulfillment
- Conveys that the client has to fulfill the intent.
*
* Failed
- Conveys that the conversation with the user failed.
*
* This can happen for various reasons including that the user did not provide an appropriate response to * prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific * information), or the Lambda function failed to fulfill the intent. *
*
* Identifies the current state of the user interaction. Amazon Lex returns one of the following values as
* dialogState
. The client can optionally use this information to customize the user interface.
*
* ElicitIntent
- Amazon Lex wants to elicit user intent.
*
* For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent * from this utterance, it will return this dialogState. *
*
* ConfirmIntent
- Amazon Lex is expecting a "yes" or "no" response.
*
* For example, Amazon Lex wants user confirmation before fulfilling an intent. *
** Instead of a simple "yes" or "no," a user might respond with additional information. For example, * "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such additional * information (in these examples, update the crust type slot value, or change intent from OrderPizza to * OrderDrink). *
*
* ElicitSlot
- Amazon Lex is expecting a slot value for the current intent.
*
* For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A * user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the * response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately. *
*
* Fulfilled
- Conveys that the Lambda function configured for the intent has successfully fulfilled
* the intent.
*
* ReadyForFulfillment
- Conveys that the client has to fulfill the intent.
*
* Failed
- Conveys that the conversation with the user failed.
*
* This can happen for various reasons including that the user did not provide an appropriate response to prompts * from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or the * Lambda function failed to fulfill the intent. *
*dialogState
. The client can optionally use this information to customize the user interface.
*
*
* ElicitIntent
- Amazon Lex wants to elicit user intent.
*
* For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user * intent from this utterance, it will return this dialogState. *
*
* ConfirmIntent
- Amazon Lex is expecting a "yes" or "no" response.
*
* For example, Amazon Lex wants user confirmation before fulfilling an intent. *
** Instead of a simple "yes" or "no," a user might respond with additional information. For example, * "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such * additional information (in these examples, update the crust type slot value, or change intent from * OrderPizza to OrderDrink). *
*
* ElicitSlot
- Amazon Lex is expecting a slot value for the current intent.
*
* For example, suppose that in the response Amazon Lex sends this message: * "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might * also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can * process such additional information appropriately. *
*
* Fulfilled
- Conveys that the Lambda function configured for the intent has successfully
* fulfilled the intent.
*
* ReadyForFulfillment
- Conveys that the client has to fulfill the intent.
*
* Failed
- Conveys that the conversation with the user failed.
*
* This can happen for various reasons including that the user did not provide an appropriate response to * prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific * information), or the Lambda function failed to fulfill the intent. *
*
* Identifies the current state of the user interaction. Amazon Lex returns one of the following values as
* dialogState
. The client can optionally use this information to customize the user interface.
*
* ElicitIntent
- Amazon Lex wants to elicit user intent.
*
* For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent * from this utterance, it will return this dialogState. *
*
* ConfirmIntent
- Amazon Lex is expecting a "yes" or "no" response.
*
* For example, Amazon Lex wants user confirmation before fulfilling an intent. *
** Instead of a simple "yes" or "no," a user might respond with additional information. For example, * "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such additional * information (in these examples, update the crust type slot value, or change intent from OrderPizza to * OrderDrink). *
*
* ElicitSlot
- Amazon Lex is expecting a slot value for the current intent.
*
* For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A * user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the * response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately. *
*
* Fulfilled
- Conveys that the Lambda function configured for the intent has successfully fulfilled
* the intent.
*
* ReadyForFulfillment
- Conveys that the client has to fulfill the intent.
*
* Failed
- Conveys that the conversation with the user failed.
*
* This can happen for various reasons including that the user did not provide an appropriate response to prompts * from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or the * Lambda function failed to fulfill the intent. *
*dialogState
. The client can optionally use this information to customize the user interface.
*
*
* ElicitIntent
- Amazon Lex wants to elicit user intent.
*
* For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user * intent from this utterance, it will return this dialogState. *
*
* ConfirmIntent
- Amazon Lex is expecting a "yes" or "no" response.
*
* For example, Amazon Lex wants user confirmation before fulfilling an intent. *
** Instead of a simple "yes" or "no," a user might respond with additional information. For example, * "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such * additional information (in these examples, update the crust type slot value, or change intent from * OrderPizza to OrderDrink). *
*
* ElicitSlot
- Amazon Lex is expecting a slot value for the current intent.
*
* For example, suppose that in the response Amazon Lex sends this message: * "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might * also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can * process such additional information appropriately. *
*
* Fulfilled
- Conveys that the Lambda function configured for the intent has successfully
* fulfilled the intent.
*
* ReadyForFulfillment
- Conveys that the client has to fulfill the intent.
*
* Failed
- Conveys that the conversation with the user failed.
*
* This can happen for various reasons including that the user did not provide an appropriate response to * prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific * information), or the Lambda function failed to fulfill the intent. *
*
* If the dialogState
value is ElicitSlot
, returns the name of the slot for which Amazon
* Lex is eliciting a value.
*
dialogState
value is ElicitSlot
, returns the name of the slot for which
* Amazon Lex is eliciting a value.
*/
public void setSlotToElicit(String slotToElicit) {
this.slotToElicit = slotToElicit;
}
/**
*
* If the dialogState
value is ElicitSlot
, returns the name of the slot for which Amazon
* Lex is eliciting a value.
*
dialogState
value is ElicitSlot
, returns the name of the slot for which
* Amazon Lex is eliciting a value.
*/
public String getSlotToElicit() {
return this.slotToElicit;
}
/**
*
* If the dialogState
value is ElicitSlot
, returns the name of the slot for which Amazon
* Lex is eliciting a value.
*
dialogState
value is ElicitSlot
, returns the name of the slot for which
* Amazon Lex is eliciting a value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PostTextResult withSlotToElicit(String slotToElicit) {
setSlotToElicit(slotToElicit);
return this;
}
/**
* * Represents the options that the user has to respond to the current prompt. Response Card can come from the bot * configuration (in the Amazon Lex console, choose the settings button next to a slot) or from a code hook (Lambda * function). *
* * @param responseCard * Represents the options that the user has to respond to the current prompt. Response Card can come from the * bot configuration (in the Amazon Lex console, choose the settings button next to a slot) or from a code * hook (Lambda function). */ public void setResponseCard(ResponseCard responseCard) { this.responseCard = responseCard; } /** ** Represents the options that the user has to respond to the current prompt. Response Card can come from the bot * configuration (in the Amazon Lex console, choose the settings button next to a slot) or from a code hook (Lambda * function). *
* * @return Represents the options that the user has to respond to the current prompt. Response Card can come from * the bot configuration (in the Amazon Lex console, choose the settings button next to a slot) or from a * code hook (Lambda function). */ public ResponseCard getResponseCard() { return this.responseCard; } /** ** Represents the options that the user has to respond to the current prompt. Response Card can come from the bot * configuration (in the Amazon Lex console, choose the settings button next to a slot) or from a code hook (Lambda * function). *
* * @param responseCard * Represents the options that the user has to respond to the current prompt. Response Card can come from the * bot configuration (in the Amazon Lex console, choose the settings button next to a slot) or from a code * hook (Lambda function). * @return Returns a reference to this object so that method calls can be chained together. */ public PostTextResult withResponseCard(ResponseCard responseCard) { setResponseCard(responseCard); return this; } /** ** A unique identifier for the session. *
* * @param sessionId * A unique identifier for the session. */ public void setSessionId(String sessionId) { this.sessionId = sessionId; } /** ** A unique identifier for the session. *
* * @return A unique identifier for the session. */ public String getSessionId() { return this.sessionId; } /** ** A unique identifier for the session. *
* * @param sessionId * A unique identifier for the session. * @return Returns a reference to this object so that method calls can be chained together. */ public PostTextResult withSessionId(String sessionId) { setSessionId(sessionId); return this; } /** ** The version of the bot that responded to the conversation. You can use this information to help determine if one * version of a bot is performing better than another version. *
* * @param botVersion * The version of the bot that responded to the conversation. You can use this information to help determine * if one version of a bot is performing better than another version. */ public void setBotVersion(String botVersion) { this.botVersion = botVersion; } /** ** The version of the bot that responded to the conversation. You can use this information to help determine if one * version of a bot is performing better than another version. *
* * @return The version of the bot that responded to the conversation. You can use this information to help determine * if one version of a bot is performing better than another version. */ public String getBotVersion() { return this.botVersion; } /** ** The version of the bot that responded to the conversation. You can use this information to help determine if one * version of a bot is performing better than another version. *
* * @param botVersion * The version of the bot that responded to the conversation. You can use this information to help determine * if one version of a bot is performing better than another version. * @return Returns a reference to this object so that method calls can be chained together. */ public PostTextResult withBotVersion(String botVersion) { setBotVersion(botVersion); return this; } /** *
* A list of active contexts for the session. A context can be set when an intent is fulfilled or by calling the
* PostContent
, PostText
, or PutSession
operation.
*
* You can use a context to control the intents that can follow up an intent, or to modify the operation of your * application. *
* * @return A list of active contexts for the session. A context can be set when an intent is fulfilled or by calling * thePostContent
, PostText
, or PutSession
operation.
*
* You can use a context to control the intents that can follow up an intent, or to modify the operation of
* your application.
*/
public java.util.List
* A list of active contexts for the session. A context can be set when an intent is fulfilled or by calling the
*
* You can use a context to control the intents that can follow up an intent, or to modify the operation of your
* application.
* PostContent
, PostText
, or PutSession
operation.
* PostContent
, PostText
, or PutSession
operation.
* You can use a context to control the intents that can follow up an intent, or to modify the operation of
* your application.
*/
public void setActiveContexts(java.util.Collection
* A list of active contexts for the session. A context can be set when an intent is fulfilled or by calling the
*
* You can use a context to control the intents that can follow up an intent, or to modify the operation of your
* application.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setActiveContexts(java.util.Collection)} or {@link #withActiveContexts(java.util.Collection)} if you want
* to override the existing values.
* PostContent
, PostText
, or PutSession
operation.
* PostContent
, PostText
, or PutSession
operation.
* You can use a context to control the intents that can follow up an intent, or to modify the operation of
* your application.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PostTextResult withActiveContexts(ActiveContext... activeContexts) {
if (this.activeContexts == null) {
setActiveContexts(new java.util.ArrayList
* A list of active contexts for the session. A context can be set when an intent is fulfilled or by calling the
*
* You can use a context to control the intents that can follow up an intent, or to modify the operation of your
* application.
* PostContent
, PostText
, or PutSession
operation.
* PostContent
, PostText
, or PutSession
operation.
* You can use a context to control the intents that can follow up an intent, or to modify the operation of
* your application.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PostTextResult withActiveContexts(java.util.Collection