public class PostTextResult
extends java.lang.Object
implements java.io.Serializable
Constructor and Description |
---|
PostTextResult() |
Modifier and Type | Method and Description |
---|---|
PostTextResult |
addsessionAttributesEntry(java.lang.String key,
java.lang.String value)
A map of key-value pairs representing the session-specific context
information.
|
PostTextResult |
addslotsEntry(java.lang.String key,
java.lang.String value)
The intent slots that Amazon Lex detected from the user input in the
conversation.
|
PostTextResult |
clearsessionAttributesEntries()
Removes all the entries added into sessionAttributes.
|
PostTextResult |
clearslotsEntries()
Removes all the entries added into slots.
|
boolean |
equals(java.lang.Object obj) |
java.util.List<PredictedIntent> |
getAlternativeIntents()
One to four alternative intents that may be applicable to the user's
intent.
|
java.lang.String |
getBotVersion()
The version of the bot that responded to the conversation.
|
java.lang.String |
getDialogState()
Identifies the current state of the user interaction.
|
java.lang.String |
getIntentName()
The current user intent that Amazon Lex is aware of.
|
java.lang.String |
getMessage()
The message to convey to the user.
|
java.lang.String |
getMessageFormat()
The format of the response message.
|
IntentConfidence |
getNluIntentConfidence()
Provides a score that indicates how confident Amazon Lex is that the
returned intent is the one that matches the user's intent.
|
ResponseCard |
getResponseCard()
Represents the options that the user has to respond to the current
prompt.
|
SentimentResponse |
getSentimentResponse()
The sentiment expressed in and utterance.
|
java.util.Map<java.lang.String,java.lang.String> |
getSessionAttributes()
A map of key-value pairs representing the session-specific context
information.
|
java.lang.String |
getSessionId()
A unique identifier for the session.
|
java.util.Map<java.lang.String,java.lang.String> |
getSlots()
The intent slots that Amazon Lex detected from the user input in the
conversation.
|
java.lang.String |
getSlotToElicit()
If the
dialogState value is ElicitSlot , returns
the name of the slot for which Amazon Lex is eliciting a value. |
int |
hashCode() |
void |
setAlternativeIntents(java.util.Collection<PredictedIntent> alternativeIntents)
One to four alternative intents that may be applicable to the user's
intent.
|
void |
setBotVersion(java.lang.String botVersion)
The version of the bot that responded to the conversation.
|
void |
setDialogState(DialogState dialogState)
Identifies the current state of the user interaction.
|
void |
setDialogState(java.lang.String dialogState)
Identifies the current state of the user interaction.
|
void |
setIntentName(java.lang.String intentName)
The current user intent that Amazon Lex is aware of.
|
void |
setMessage(java.lang.String message)
The message to convey to the user.
|
void |
setMessageFormat(MessageFormatType messageFormat)
The format of the response message.
|
void |
setMessageFormat(java.lang.String messageFormat)
The format of the response message.
|
void |
setNluIntentConfidence(IntentConfidence nluIntentConfidence)
Provides a score that indicates how confident Amazon Lex is that the
returned intent is the one that matches the user's intent.
|
void |
setResponseCard(ResponseCard responseCard)
Represents the options that the user has to respond to the current
prompt.
|
void |
setSentimentResponse(SentimentResponse sentimentResponse)
The sentiment expressed in and utterance.
|
void |
setSessionAttributes(java.util.Map<java.lang.String,java.lang.String> sessionAttributes)
A map of key-value pairs representing the session-specific context
information.
|
void |
setSessionId(java.lang.String sessionId)
A unique identifier for the session.
|
void |
setSlots(java.util.Map<java.lang.String,java.lang.String> slots)
The intent slots that Amazon Lex detected from the user input in the
conversation.
|
void |
setSlotToElicit(java.lang.String slotToElicit)
If the
dialogState value is ElicitSlot , returns
the name of the slot for which Amazon Lex is eliciting a value. |
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
PostTextResult |
withAlternativeIntents(java.util.Collection<PredictedIntent> alternativeIntents)
One to four alternative intents that may be applicable to the user's
intent.
|
PostTextResult |
withAlternativeIntents(PredictedIntent... alternativeIntents)
One to four alternative intents that may be applicable to the user's
intent.
|
PostTextResult |
withBotVersion(java.lang.String botVersion)
The version of the bot that responded to the conversation.
|
PostTextResult |
withDialogState(DialogState dialogState)
Identifies the current state of the user interaction.
|
PostTextResult |
withDialogState(java.lang.String dialogState)
Identifies the current state of the user interaction.
|
PostTextResult |
withIntentName(java.lang.String intentName)
The current user intent that Amazon Lex is aware of.
|
PostTextResult |
withMessage(java.lang.String message)
The message to convey to the user.
|
PostTextResult |
withMessageFormat(MessageFormatType messageFormat)
The format of the response message.
|
PostTextResult |
withMessageFormat(java.lang.String messageFormat)
The format of the response message.
|
PostTextResult |
withNluIntentConfidence(IntentConfidence nluIntentConfidence)
Provides a score that indicates how confident Amazon Lex is that the
returned intent is the one that matches the user's intent.
|
PostTextResult |
withResponseCard(ResponseCard responseCard)
Represents the options that the user has to respond to the current
prompt.
|
PostTextResult |
withSentimentResponse(SentimentResponse sentimentResponse)
The sentiment expressed in and utterance.
|
PostTextResult |
withSessionAttributes(java.util.Map<java.lang.String,java.lang.String> sessionAttributes)
A map of key-value pairs representing the session-specific context
information.
|
PostTextResult |
withSessionId(java.lang.String sessionId)
A unique identifier for the session.
|
PostTextResult |
withSlots(java.util.Map<java.lang.String,java.lang.String> slots)
The intent slots that Amazon Lex detected from the user input in the
conversation.
|
PostTextResult |
withSlotToElicit(java.lang.String slotToElicit)
If the
dialogState value is ElicitSlot , returns
the name of the slot for which Amazon Lex is eliciting a value. |
public java.lang.String getIntentName()
The current user intent that Amazon Lex is aware of.
The current user intent that Amazon Lex is aware of.
public void setIntentName(java.lang.String intentName)
The current user intent that Amazon Lex is aware of.
intentName
- The current user intent that Amazon Lex is aware of.
public PostTextResult withIntentName(java.lang.String intentName)
The current user intent that Amazon Lex is aware of.
Returns a reference to this object so that method calls can be chained together.
intentName
- The current user intent that Amazon Lex is aware of.
public IntentConfidence getNluIntentConfidence()
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 the Amazon Lex natural language understanding (NLU) model.
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 the Amazon Lex natural language understanding (NLU) model.
public void setNluIntentConfidence(IntentConfidence 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 the Amazon Lex natural language understanding (NLU) model.
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 the Amazon Lex natural language understanding (NLU) model.
public PostTextResult withNluIntentConfidence(IntentConfidence 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 the Amazon Lex natural language understanding (NLU) model.
Returns a reference to this object so that method calls can be chained together.
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 the Amazon Lex natural language understanding (NLU) model.
public java.util.List<PredictedIntent> getAlternativeIntents()
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.
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 void setAlternativeIntents(java.util.Collection<PredictedIntent> alternativeIntents)
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.
alternativeIntents
- 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 PostTextResult withAlternativeIntents(PredictedIntent... alternativeIntents)
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.
Returns a reference to this object so that method calls can be chained together.
alternativeIntents
- 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 PostTextResult withAlternativeIntents(java.util.Collection<PredictedIntent> alternativeIntents)
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.
Returns a reference to this object so that method calls can be chained together.
alternativeIntents
- 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.Map<java.lang.String,java.lang.String> getSlots()
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
.
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.Map<java.lang.String,java.lang.String> slots)
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
.
slots
- 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 PostTextResult withSlots(java.util.Map<java.lang.String,java.lang.String> slots)
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
.
Returns a reference to this object so that method calls can be chained together.
slots
- 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 PostTextResult addslotsEntry(java.lang.String key, java.lang.String value)
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
.
The method adds a new key-value pair into slots parameter, and returns a reference to this object so that method calls can be chained together.
key
- The key of the entry to be added into slots.value
- The corresponding value of the entry to be added into slots.public PostTextResult clearslotsEntries()
Returns a reference to this object so that method calls can be chained together.
public java.util.Map<java.lang.String,java.lang.String> getSessionAttributes()
A map of key-value pairs representing the session-specific context information.
A map of key-value pairs representing the session-specific context information.
public void setSessionAttributes(java.util.Map<java.lang.String,java.lang.String> sessionAttributes)
A map of key-value pairs representing the session-specific context information.
sessionAttributes
- A map of key-value pairs representing the session-specific context information.
public PostTextResult withSessionAttributes(java.util.Map<java.lang.String,java.lang.String> sessionAttributes)
A map of key-value pairs representing the session-specific context information.
Returns a reference to this object so that method calls can be chained together.
sessionAttributes
- A map of key-value pairs representing the session-specific context information.
public PostTextResult addsessionAttributesEntry(java.lang.String key, java.lang.String value)
A map of key-value pairs representing the session-specific context information.
The method adds a new key-value pair into sessionAttributes parameter, and returns a reference to this object so that method calls can be chained together.
key
- The key of the entry to be added into sessionAttributes.value
- The corresponding value of the entry to be added into
sessionAttributes.public PostTextResult clearsessionAttributesEntries()
Returns a reference to this object so that method calls can be chained together.
public java.lang.String getMessage()
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.
Constraints:
Length: 1 - 1024
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 void setMessage(java.lang.String 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.
Constraints:
Length: 1 - 1024
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.
public PostTextResult withMessage(java.lang.String 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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 1024
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.
public SentimentResponse getSentimentResponse()
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 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)
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.
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 PostTextResult withSentimentResponse(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.
Returns a reference to this object so that method calls can be chained together.
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 java.lang.String getMessageFormat()
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.
Constraints:
Allowed Values: PlainText, CustomPayload, SSML, Composite
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.
MessageFormatType
public void setMessageFormat(java.lang.String messageFormat)
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.
Constraints:
Allowed Values: PlainText, CustomPayload, SSML, Composite
messageFormat
- 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.
MessageFormatType
public PostTextResult withMessageFormat(java.lang.String messageFormat)
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: PlainText, CustomPayload, SSML, Composite
messageFormat
- 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.
MessageFormatType
public void setMessageFormat(MessageFormatType messageFormat)
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.
Constraints:
Allowed Values: PlainText, CustomPayload, SSML, Composite
messageFormat
- 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.
MessageFormatType
public PostTextResult withMessageFormat(MessageFormatType messageFormat)
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: PlainText, CustomPayload, SSML, Composite
messageFormat
- 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.
MessageFormatType
public java.lang.String getDialogState()
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.
Constraints:
Allowed Values: ElicitIntent, ConfirmIntent, ElicitSlot,
Fulfilled, ReadyForFulfillment, Failed
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
public void setDialogState(java.lang.String dialogState)
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.
Constraints:
Allowed Values: ElicitIntent, ConfirmIntent, ElicitSlot,
Fulfilled, ReadyForFulfillment, Failed
dialogState
-
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
public PostTextResult withDialogState(java.lang.String dialogState)
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: ElicitIntent, ConfirmIntent, ElicitSlot,
Fulfilled, ReadyForFulfillment, Failed
dialogState
-
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
public void setDialogState(DialogState dialogState)
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.
Constraints:
Allowed Values: ElicitIntent, ConfirmIntent, ElicitSlot,
Fulfilled, ReadyForFulfillment, Failed
dialogState
-
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
public PostTextResult withDialogState(DialogState dialogState)
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: ElicitIntent, ConfirmIntent, ElicitSlot,
Fulfilled, ReadyForFulfillment, Failed
dialogState
-
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
public java.lang.String getSlotToElicit()
If the dialogState
value is ElicitSlot
, returns
the name of the slot for which Amazon Lex is eliciting a value.
If the dialogState
value is ElicitSlot
,
returns the name of the slot for which Amazon Lex is eliciting a
value.
public void setSlotToElicit(java.lang.String slotToElicit)
If the dialogState
value is ElicitSlot
, returns
the name of the slot for which Amazon Lex is eliciting a value.
slotToElicit
-
If the dialogState
value is
ElicitSlot
, returns the name of the slot for
which Amazon Lex is eliciting a value.
public PostTextResult withSlotToElicit(java.lang.String slotToElicit)
If the dialogState
value is ElicitSlot
, returns
the name of the slot for which Amazon Lex is eliciting a value.
Returns a reference to this object so that method calls can be chained together.
slotToElicit
-
If the dialogState
value is
ElicitSlot
, returns the name of the slot for
which Amazon Lex is eliciting a value.
public ResponseCard getResponseCard()
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).
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)
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).
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 PostTextResult withResponseCard(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).
Returns a reference to this object so that method calls can be chained together.
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 java.lang.String getSessionId()
A unique identifier for the session.
A unique identifier for the session.
public void setSessionId(java.lang.String sessionId)
A unique identifier for the session.
sessionId
- A unique identifier for the session.
public PostTextResult withSessionId(java.lang.String sessionId)
A unique identifier for the session.
Returns a reference to this object so that method calls can be chained together.
sessionId
- A unique identifier for the session.
public java.lang.String getBotVersion()
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.
If you have enabled the new natural language understanding (NLU) model, you can use this to determine if the improvement is due to changes to the bot or changes to the NLU.
For more information about enabling the new NLU, see the enableModelImprovements parameter of the PutBot
operation.
Constraints:
Length: 1 - 64
Pattern: [0-9]+|\$LATEST
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.
If you have enabled the new natural language understanding (NLU) model, you can use this to determine if the improvement is due to changes to the bot or changes to the NLU.
For more information about enabling the new NLU, see the enableModelImprovements parameter of the PutBot
operation.
public void setBotVersion(java.lang.String 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.
If you have enabled the new natural language understanding (NLU) model, you can use this to determine if the improvement is due to changes to the bot or changes to the NLU.
For more information about enabling the new NLU, see the enableModelImprovements parameter of the PutBot
operation.
Constraints:
Length: 1 - 64
Pattern: [0-9]+|\$LATEST
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.
If you have enabled the new natural language understanding (NLU) model, you can use this to determine if the improvement is due to changes to the bot or changes to the NLU.
For more information about enabling the new NLU, see the enableModelImprovements parameter of the
PutBot
operation.
public PostTextResult withBotVersion(java.lang.String 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.
If you have enabled the new natural language understanding (NLU) model, you can use this to determine if the improvement is due to changes to the bot or changes to the NLU.
For more information about enabling the new NLU, see the enableModelImprovements parameter of the PutBot
operation.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 64
Pattern: [0-9]+|\$LATEST
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.
If you have enabled the new natural language understanding (NLU) model, you can use this to determine if the improvement is due to changes to the bot or changes to the NLU.
For more information about enabling the new NLU, see the enableModelImprovements parameter of the
PutBot
operation.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.