public class PostContentResult
extends java.lang.Object
implements java.io.Serializable
Constructor and Description |
---|
PostContentResult() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getAlternativeIntents()
One to four alternative intents that may be applicable to the user's
intent.
|
java.io.InputStream |
getAudioStream()
The prompt (or statement) to convey to the user.
|
java.lang.String |
getBotVersion()
The version of the bot that responded to the conversation.
|
java.lang.String |
getContentType()
Content type as specified in the
Accept HTTP header in the
request. |
java.lang.String |
getDialogState()
Identifies the current state of the user interaction.
|
java.lang.String |
getInputTranscript()
The text used to process the request.
|
java.lang.String |
getIntentName()
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.
|
java.lang.String |
getNluIntentConfidence()
Provides a score that indicates how confident Amazon Lex is that the
returned intent is the one that matches the user's intent.
|
java.lang.String |
getSentimentResponse()
The sentiment expressed in an utterance.
|
java.lang.String |
getSessionAttributes()
Map of key/value pairs representing the session-specific context
information.
|
java.lang.String |
getSessionId()
The unique identifier for the session.
|
java.lang.String |
getSlots()
Map of zero or more intent slots (name/value pairs) Amazon Lex detected
from the user input during 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.lang.String alternativeIntents)
One to four alternative intents that may be applicable to the user's
intent.
|
void |
setAudioStream(java.io.InputStream audioStream)
The prompt (or statement) to convey to the user.
|
void |
setBotVersion(java.lang.String botVersion)
The version of the bot that responded to the conversation.
|
void |
setContentType(java.lang.String contentType)
Content type as specified in the
Accept HTTP header in the
request. |
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 |
setInputTranscript(java.lang.String inputTranscript)
The text used to process the request.
|
void |
setIntentName(java.lang.String intentName)
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(java.lang.String 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 |
setSentimentResponse(java.lang.String sentimentResponse)
The sentiment expressed in an utterance.
|
void |
setSessionAttributes(java.lang.String sessionAttributes)
Map of key/value pairs representing the session-specific context
information.
|
void |
setSessionId(java.lang.String sessionId)
The unique identifier for the session.
|
void |
setSlots(java.lang.String slots)
Map of zero or more intent slots (name/value pairs) Amazon Lex detected
from the user input during 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.
|
PostContentResult |
withAlternativeIntents(java.lang.String alternativeIntents)
One to four alternative intents that may be applicable to the user's
intent.
|
PostContentResult |
withAudioStream(java.io.InputStream audioStream)
The prompt (or statement) to convey to the user.
|
PostContentResult |
withBotVersion(java.lang.String botVersion)
The version of the bot that responded to the conversation.
|
PostContentResult |
withContentType(java.lang.String contentType)
Content type as specified in the
Accept HTTP header in the
request. |
PostContentResult |
withDialogState(DialogState dialogState)
Identifies the current state of the user interaction.
|
PostContentResult |
withDialogState(java.lang.String dialogState)
Identifies the current state of the user interaction.
|
PostContentResult |
withInputTranscript(java.lang.String inputTranscript)
The text used to process the request.
|
PostContentResult |
withIntentName(java.lang.String intentName)
Current user intent that Amazon Lex is aware of.
|
PostContentResult |
withMessage(java.lang.String message)
The message to convey to the user.
|
PostContentResult |
withMessageFormat(MessageFormatType messageFormat)
The format of the response message.
|
PostContentResult |
withMessageFormat(java.lang.String messageFormat)
The format of the response message.
|
PostContentResult |
withNluIntentConfidence(java.lang.String nluIntentConfidence)
Provides a score that indicates how confident Amazon Lex is that the
returned intent is the one that matches the user's intent.
|
PostContentResult |
withSentimentResponse(java.lang.String sentimentResponse)
The sentiment expressed in an utterance.
|
PostContentResult |
withSessionAttributes(java.lang.String sessionAttributes)
Map of key/value pairs representing the session-specific context
information.
|
PostContentResult |
withSessionId(java.lang.String sessionId)
The unique identifier for the session.
|
PostContentResult |
withSlots(java.lang.String slots)
Map of zero or more intent slots (name/value pairs) Amazon Lex detected
from the user input during the conversation.
|
PostContentResult |
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 getContentType()
Content type as specified in the Accept
HTTP header in the
request.
Content type as specified in the Accept
HTTP header
in the request.
public void setContentType(java.lang.String contentType)
Content type as specified in the Accept
HTTP header in the
request.
contentType
-
Content type as specified in the Accept
HTTP
header in the request.
public PostContentResult withContentType(java.lang.String contentType)
Content type as specified in the Accept
HTTP header in the
request.
Returns a reference to this object so that method calls can be chained together.
contentType
-
Content type as specified in the Accept
HTTP
header in the request.
public java.lang.String getIntentName()
Current user intent that Amazon Lex is aware of.
Current user intent that Amazon Lex is aware of.
public void setIntentName(java.lang.String intentName)
Current user intent that Amazon Lex is aware of.
intentName
- Current user intent that Amazon Lex is aware of.
public PostContentResult withIntentName(java.lang.String intentName)
Current user intent that Amazon Lex is aware of.
Returns a reference to this object so that method calls can be chained together.
intentName
- Current user intent that Amazon Lex is aware of.
public java.lang.String 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.
The score is a relative score, not an absolute score. The score may change based on improvements to the Amazon Lex NLU.
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.
The score is a relative score, not an absolute score. The score may change based on improvements to the Amazon Lex NLU.
public void setNluIntentConfidence(java.lang.String 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.
The score is a relative score, not an absolute score. The score may change based on improvements to the Amazon Lex NLU.
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.
The score is a relative score, not an absolute score. The score may change based on improvements to the Amazon Lex NLU.
public PostContentResult withNluIntentConfidence(java.lang.String 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.
The score is a relative score, not an absolute score. The score may change based on improvements to the Amazon Lex NLU.
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.
The score is a relative score, not an absolute score. The score may change based on improvements to the Amazon Lex NLU.
public java.lang.String 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.lang.String 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 PostContentResult withAlternativeIntents(java.lang.String 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.lang.String getSlots()
Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the user input during the conversation. The field is base-64 encoded.
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
.
Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the user input during the conversation. The field is base-64 encoded.
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.lang.String slots)
Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the user input during the conversation. The field is base-64 encoded.
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
- Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the user input during the conversation. The field is base-64 encoded.
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 PostContentResult withSlots(java.lang.String slots)
Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the user input during the conversation. The field is base-64 encoded.
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
- Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the user input during the conversation. The field is base-64 encoded.
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.lang.String getSessionAttributes()
Map of key/value pairs representing the session-specific context information.
Map of key/value pairs representing the session-specific context information.
public void setSessionAttributes(java.lang.String sessionAttributes)
Map of key/value pairs representing the session-specific context information.
sessionAttributes
- Map of key/value pairs representing the session-specific context information.
public PostContentResult withSessionAttributes(java.lang.String sessionAttributes)
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
- Map of key/value pairs representing the session-specific context information.
public java.lang.String getSentimentResponse()
The sentiment expressed in an 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 an 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(java.lang.String sentimentResponse)
The sentiment expressed in an 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 an utterance.
When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.
public PostContentResult withSentimentResponse(java.lang.String sentimentResponse)
The sentiment expressed in an 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 an 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 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
in 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
in 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
in 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
in 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 PostContentResult 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
in 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
in 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 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 for the
client.
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 for
the client.
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 for the
client.
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
for the client.
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 PostContentResult 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 for the
client.
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
for the client.
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 for the
client.
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
for the client.
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 PostContentResult 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 for the
client.
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
for the client.
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 the user's intent.
Consider the following examples:
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 dialog state.
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" response, a user might respond with additional information. For example, "yes, but make it a 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 or change the intent from OrderPizza to OrderDrink).
ElicitSlot
- Amazon Lex is expecting the value of a slot 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 has
successfully fulfilled the intent.
ReadyForFulfillment
- Conveys that the client has to fulfill
the request.
Failed
- Conveys that the conversation with the user failed.
This can happen for various reasons, including that the user does 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 if the Lambda function fails 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 the user's
intent. Consider the following examples:
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 dialog state.
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" response, a user might respond with additional information. For example, "yes, but make it a 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 or change the intent from OrderPizza to OrderDrink).
ElicitSlot
- Amazon Lex is expecting the value of a
slot 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 has
successfully fulfilled the intent.
ReadyForFulfillment
- Conveys that the client has to
fulfill the request.
Failed
- Conveys that the conversation with the user
failed.
This can happen for various reasons, including that the user does 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 if the Lambda function fails 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 the user's intent.
Consider the following examples:
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 dialog state.
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" response, a user might respond with additional information. For example, "yes, but make it a 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 or change the intent from OrderPizza to OrderDrink).
ElicitSlot
- Amazon Lex is expecting the value of a slot 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 has
successfully fulfilled the intent.
ReadyForFulfillment
- Conveys that the client has to fulfill
the request.
Failed
- Conveys that the conversation with the user failed.
This can happen for various reasons, including that the user does 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 if the Lambda function fails 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 the
user's intent. Consider the following examples:
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 dialog state.
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" response, a user might respond with additional information. For example, "yes, but make it a 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 or change the intent from OrderPizza to OrderDrink).
ElicitSlot
- Amazon Lex is expecting the value of
a slot 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 has
successfully fulfilled the intent.
ReadyForFulfillment
- Conveys that the client has
to fulfill the request.
Failed
- Conveys that the conversation with the
user failed.
This can happen for various reasons, including that the user does 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 if the Lambda function fails to fulfill the intent.
DialogState
public PostContentResult 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 the user's intent.
Consider the following examples:
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 dialog state.
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" response, a user might respond with additional information. For example, "yes, but make it a 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 or change the intent from OrderPizza to OrderDrink).
ElicitSlot
- Amazon Lex is expecting the value of a slot 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 has
successfully fulfilled the intent.
ReadyForFulfillment
- Conveys that the client has to fulfill
the request.
Failed
- Conveys that the conversation with the user failed.
This can happen for various reasons, including that the user does 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 if the Lambda function fails 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 the
user's intent. Consider the following examples:
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 dialog state.
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" response, a user might respond with additional information. For example, "yes, but make it a 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 or change the intent from OrderPizza to OrderDrink).
ElicitSlot
- Amazon Lex is expecting the value of
a slot 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 has
successfully fulfilled the intent.
ReadyForFulfillment
- Conveys that the client has
to fulfill the request.
Failed
- Conveys that the conversation with the
user failed.
This can happen for various reasons, including that the user does 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 if the Lambda function fails 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 the user's intent.
Consider the following examples:
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 dialog state.
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" response, a user might respond with additional information. For example, "yes, but make it a 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 or change the intent from OrderPizza to OrderDrink).
ElicitSlot
- Amazon Lex is expecting the value of a slot 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 has
successfully fulfilled the intent.
ReadyForFulfillment
- Conveys that the client has to fulfill
the request.
Failed
- Conveys that the conversation with the user failed.
This can happen for various reasons, including that the user does 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 if the Lambda function fails 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 the
user's intent. Consider the following examples:
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 dialog state.
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" response, a user might respond with additional information. For example, "yes, but make it a 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 or change the intent from OrderPizza to OrderDrink).
ElicitSlot
- Amazon Lex is expecting the value of
a slot 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 has
successfully fulfilled the intent.
ReadyForFulfillment
- Conveys that the client has
to fulfill the request.
Failed
- Conveys that the conversation with the
user failed.
This can happen for various reasons, including that the user does 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 if the Lambda function fails to fulfill the intent.
DialogState
public PostContentResult 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 the user's intent.
Consider the following examples:
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 dialog state.
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" response, a user might respond with additional information. For example, "yes, but make it a 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 or change the intent from OrderPizza to OrderDrink).
ElicitSlot
- Amazon Lex is expecting the value of a slot 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 has
successfully fulfilled the intent.
ReadyForFulfillment
- Conveys that the client has to fulfill
the request.
Failed
- Conveys that the conversation with the user failed.
This can happen for various reasons, including that the user does 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 if the Lambda function fails 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 the
user's intent. Consider the following examples:
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 dialog state.
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" response, a user might respond with additional information. For example, "yes, but make it a 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 or change the intent from OrderPizza to OrderDrink).
ElicitSlot
- Amazon Lex is expecting the value of
a slot 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 has
successfully fulfilled the intent.
ReadyForFulfillment
- Conveys that the client has
to fulfill the request.
Failed
- Conveys that the conversation with the
user failed.
This can happen for various reasons, including that the user does 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 if the Lambda function fails 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 PostContentResult 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 java.lang.String getInputTranscript()
The text used to process the request.
If the input was an audio stream, the inputTranscript
field
contains the text extracted from the audio stream. This is the text that
is actually processed to recognize intents and slot values. You can use
this information to determine if Amazon Lex is correctly processing the
audio that you send.
The text used to process the request.
If the input was an audio stream, the
inputTranscript
field contains the text extracted
from the audio stream. This is the text that is actually
processed to recognize intents and slot values. You can use this
information to determine if Amazon Lex is correctly processing
the audio that you send.
public void setInputTranscript(java.lang.String inputTranscript)
The text used to process the request.
If the input was an audio stream, the inputTranscript
field
contains the text extracted from the audio stream. This is the text that
is actually processed to recognize intents and slot values. You can use
this information to determine if Amazon Lex is correctly processing the
audio that you send.
inputTranscript
- The text used to process the request.
If the input was an audio stream, the
inputTranscript
field contains the text extracted
from the audio stream. This is the text that is actually
processed to recognize intents and slot values. You can use
this information to determine if Amazon Lex is correctly
processing the audio that you send.
public PostContentResult withInputTranscript(java.lang.String inputTranscript)
The text used to process the request.
If the input was an audio stream, the inputTranscript
field
contains the text extracted from the audio stream. This is the text that
is actually processed to recognize intents and slot values. You can use
this information to determine if Amazon Lex is correctly processing the
audio that you send.
Returns a reference to this object so that method calls can be chained together.
inputTranscript
- The text used to process the request.
If the input was an audio stream, the
inputTranscript
field contains the text extracted
from the audio stream. This is the text that is actually
processed to recognize intents and slot values. You can use
this information to determine if Amazon Lex is correctly
processing the audio that you send.
public java.io.InputStream getAudioStream()
The prompt (or statement) to convey to the user. This is based on the bot
configuration and context. For example, if Amazon Lex did not understand
the user intent, it sends the clarificationPrompt
configured
for the bot. If the intent requires confirmation before taking the
fulfillment action, it sends the confirmationPrompt
. Another
example: Suppose that the Lambda function successfully fulfilled the
intent, and sent a message to convey to the user. Then Amazon Lex sends
that message in the response.
The prompt (or statement) to convey to the user. This is based on
the bot configuration and context. For example, if Amazon Lex did
not understand the user intent, it sends the
clarificationPrompt
configured for the bot. If the
intent requires confirmation before taking the fulfillment
action, it sends the confirmationPrompt
. Another
example: Suppose that the Lambda function successfully fulfilled
the intent, and sent a message to convey to the user. Then Amazon
Lex sends that message in the response.
public void setAudioStream(java.io.InputStream audioStream)
The prompt (or statement) to convey to the user. This is based on the bot
configuration and context. For example, if Amazon Lex did not understand
the user intent, it sends the clarificationPrompt
configured
for the bot. If the intent requires confirmation before taking the
fulfillment action, it sends the confirmationPrompt
. Another
example: Suppose that the Lambda function successfully fulfilled the
intent, and sent a message to convey to the user. Then Amazon Lex sends
that message in the response.
audioStream
-
The prompt (or statement) to convey to the user. This is based
on the bot configuration and context. For example, if Amazon
Lex did not understand the user intent, it sends the
clarificationPrompt
configured for the bot. If
the intent requires confirmation before taking the fulfillment
action, it sends the confirmationPrompt
. Another
example: Suppose that the Lambda function successfully
fulfilled the intent, and sent a message to convey to the
user. Then Amazon Lex sends that message in the response.
public PostContentResult withAudioStream(java.io.InputStream audioStream)
The prompt (or statement) to convey to the user. This is based on the bot
configuration and context. For example, if Amazon Lex did not understand
the user intent, it sends the clarificationPrompt
configured
for the bot. If the intent requires confirmation before taking the
fulfillment action, it sends the confirmationPrompt
. Another
example: Suppose that the Lambda function successfully fulfilled the
intent, and sent a message to convey to the user. Then Amazon Lex sends
that message in the response.
Returns a reference to this object so that method calls can be chained together.
audioStream
-
The prompt (or statement) to convey to the user. This is based
on the bot configuration and context. For example, if Amazon
Lex did not understand the user intent, it sends the
clarificationPrompt
configured for the bot. If
the intent requires confirmation before taking the fulfillment
action, it sends the confirmationPrompt
. Another
example: Suppose that the Lambda function successfully
fulfilled the intent, and sent a message to convey to the
user. Then Amazon Lex sends that message in the response.
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 PostContentResult 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 getSessionId()
The unique identifier for the session.
The unique identifier for the session.
public void setSessionId(java.lang.String sessionId)
The unique identifier for the session.
sessionId
- The unique identifier for the session.
public PostContentResult withSessionId(java.lang.String sessionId)
The unique identifier for the session.
Returns a reference to this object so that method calls can be chained together.
sessionId
- The unique identifier for the session.
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.