@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class PostContentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Constructor and Description |
---|
PostContentResult() |
Modifier and Type | Method and Description |
---|---|
PostContentResult |
clone() |
boolean |
equals(Object obj) |
String |
getActiveContexts()
A list of active contexts for the session.
|
String |
getAlternativeIntents()
One to four alternative intents that may be applicable to the user's intent.
|
InputStream |
getAudioStream()
The prompt (or statement) to convey to the user.
|
String |
getBotVersion()
The version of the bot that responded to the conversation.
|
String |
getContentType()
Content type as specified in the
Accept HTTP header in the request. |
String |
getDialogState()
Identifies the current state of the user interaction.
|
String |
getEncodedInputTranscript()
The text used to process the request.
|
String |
getEncodedMessage()
The message to convey to the user.
|
String |
getInputTranscript()
Deprecated.
|
String |
getIntentName()
Current user intent that Amazon Lex is aware of.
|
String |
getMessage()
Deprecated.
|
String |
getMessageFormat()
The format of the response message.
|
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.
|
String |
getSentimentResponse()
The sentiment expressed in an utterance.
|
String |
getSessionAttributes()
Map of key/value pairs representing the session-specific context information.
|
String |
getSessionId()
The unique identifier for the session.
|
String |
getSlots()
Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the user input during the
conversation.
|
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 |
setActiveContexts(String activeContexts)
A list of active contexts for the session.
|
void |
setAlternativeIntents(String alternativeIntents)
One to four alternative intents that may be applicable to the user's intent.
|
void |
setAudioStream(InputStream audioStream)
The prompt (or statement) to convey to the user.
|
void |
setBotVersion(String botVersion)
The version of the bot that responded to the conversation.
|
void |
setContentType(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(String dialogState)
Identifies the current state of the user interaction.
|
void |
setEncodedInputTranscript(String encodedInputTranscript)
The text used to process the request.
|
void |
setEncodedMessage(String encodedMessage)
The message to convey to the user.
|
void |
setInputTranscript(String inputTranscript)
Deprecated.
|
void |
setIntentName(String intentName)
Current user intent that Amazon Lex is aware of.
|
void |
setMessage(String message)
Deprecated.
|
void |
setMessageFormat(MessageFormatType messageFormat)
The format of the response message.
|
void |
setMessageFormat(String messageFormat)
The format of the response message.
|
void |
setNluIntentConfidence(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(String sentimentResponse)
The sentiment expressed in an utterance.
|
void |
setSessionAttributes(String sessionAttributes)
Map of key/value pairs representing the session-specific context information.
|
void |
setSessionId(String sessionId)
The unique identifier for the session.
|
void |
setSlots(String slots)
Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the user input during the
conversation.
|
void |
setSlotToElicit(String slotToElicit)
If the
dialogState value is ElicitSlot , returns the name of the slot for which Amazon
Lex is eliciting a value. |
String |
toString()
Returns a string representation of this object.
|
PostContentResult |
withActiveContexts(String activeContexts)
A list of active contexts for the session.
|
PostContentResult |
withAlternativeIntents(String alternativeIntents)
One to four alternative intents that may be applicable to the user's intent.
|
PostContentResult |
withAudioStream(InputStream audioStream)
The prompt (or statement) to convey to the user.
|
PostContentResult |
withBotVersion(String botVersion)
The version of the bot that responded to the conversation.
|
PostContentResult |
withContentType(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(String dialogState)
Identifies the current state of the user interaction.
|
PostContentResult |
withEncodedInputTranscript(String encodedInputTranscript)
The text used to process the request.
|
PostContentResult |
withEncodedMessage(String encodedMessage)
The message to convey to the user.
|
PostContentResult |
withInputTranscript(String inputTranscript)
Deprecated.
|
PostContentResult |
withIntentName(String intentName)
Current user intent that Amazon Lex is aware of.
|
PostContentResult |
withMessage(String message)
Deprecated.
|
PostContentResult |
withMessageFormat(MessageFormatType messageFormat)
The format of the response message.
|
PostContentResult |
withMessageFormat(String messageFormat)
The format of the response message.
|
PostContentResult |
withNluIntentConfidence(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(String sentimentResponse)
The sentiment expressed in an utterance.
|
PostContentResult |
withSessionAttributes(String sessionAttributes)
Map of key/value pairs representing the session-specific context information.
|
PostContentResult |
withSessionId(String sessionId)
The unique identifier for the session.
|
PostContentResult |
withSlots(String slots)
Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the user input during the
conversation.
|
PostContentResult |
withSlotToElicit(String slotToElicit)
If the
dialogState value is ElicitSlot , returns the name of the slot for which Amazon
Lex is eliciting a value. |
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public void setContentType(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 String getContentType()
Content type as specified in the Accept
HTTP header in the request.
Accept
HTTP header in the request.public PostContentResult withContentType(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 void setIntentName(String intentName)
Current user intent that Amazon Lex is aware of.
intentName
- Current user intent that Amazon Lex is aware of.public String getIntentName()
Current user intent that Amazon Lex is aware of.
public PostContentResult withIntentName(String intentName)
Current user intent that Amazon Lex is aware of.
intentName
- Current user intent that Amazon Lex is aware of.public void setNluIntentConfidence(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 Amazon Lex.
This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
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 Amazon Lex.
public 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 Amazon Lex.
This field's value will be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
The score is a relative score, not an absolute score. The score may change based on improvements to Amazon Lex.
public PostContentResult withNluIntentConfidence(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 Amazon Lex.
This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
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 Amazon Lex.
public void setAlternativeIntents(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.
This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
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 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.
This field's value will be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
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(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.
This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
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 void setSlots(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
.
This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
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 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
.
This field's value will be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
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(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
.
This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
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 void setSessionAttributes(String sessionAttributes)
Map of key/value pairs representing the session-specific context information.
This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
sessionAttributes
- Map of key/value pairs representing the session-specific context information.public String getSessionAttributes()
Map of key/value pairs representing the session-specific context information.
This field's value will be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
public PostContentResult withSessionAttributes(String sessionAttributes)
Map of key/value pairs representing the session-specific context information.
This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
sessionAttributes
- Map of key/value pairs representing the session-specific context information.public void setSentimentResponse(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 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.
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(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.
@Deprecated public void setMessage(String message)
You can only use this field in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and it-IT
locales. In all other locales, the message
field is null. You should use the
encodedMessage
field instead.
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.
message
- You can only use this field in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and
it-IT locales. In all other locales, the message
field is null. You should use the
encodedMessage
field instead.
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.
@Deprecated public String getMessage()
You can only use this field in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and it-IT
locales. In all other locales, the message
field is null. You should use the
encodedMessage
field instead.
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.
message
field is null. You should use the
encodedMessage
field instead.
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.
@Deprecated public PostContentResult withMessage(String message)
You can only use this field in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and it-IT
locales. In all other locales, the message
field is null. You should use the
encodedMessage
field instead.
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.
message
- You can only use this field in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and
it-IT locales. In all other locales, the message
field is null. You should use the
encodedMessage
field instead.
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 setEncodedMessage(String encodedMessage)
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.
The encodedMessage
field is base-64 encoded. You must decode the field before you can use the value.
encodedMessage
- 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.
The encodedMessage
field is base-64 encoded. You must decode the field before you can use the
value.
public String getEncodedMessage()
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.
The encodedMessage
field is base-64 encoded. You must decode the field before you can use the value.
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.
The encodedMessage
field is base-64 encoded. You must decode the field before you can use
the value.
public PostContentResult withEncodedMessage(String encodedMessage)
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.
The encodedMessage
field is base-64 encoded. You must decode the field before you can use the value.
encodedMessage
- 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.
The encodedMessage
field is base-64 encoded. You must decode the field before you can use the
value.
public void setMessageFormat(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.
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 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.
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(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.
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.
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.
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 setDialogState(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.
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 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.
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(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.
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.
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.
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 setSlotToElicit(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 String getSlotToElicit()
If the dialogState
value is ElicitSlot
, returns the name of the slot for which Amazon
Lex is eliciting a value.
dialogState
value is ElicitSlot
, returns the name of the slot for which
Amazon Lex is eliciting a value.public PostContentResult withSlotToElicit(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.@Deprecated public void setInputTranscript(String inputTranscript)
The text used to process the request.
You can use this field only in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and it-IT
locales. In all other locales, the inputTranscript
field is null. You should use the
encodedInputTranscript
field instead.
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.
You can use this field only in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and
it-IT locales. In all other locales, the inputTranscript
field is null. You should use the
encodedInputTranscript
field instead.
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.
@Deprecated public String getInputTranscript()
The text used to process the request.
You can use this field only in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and it-IT
locales. In all other locales, the inputTranscript
field is null. You should use the
encodedInputTranscript
field instead.
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.
You can use this field only in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and
it-IT locales. In all other locales, the inputTranscript
field is null. You should use the
encodedInputTranscript
field instead.
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.
@Deprecated public PostContentResult withInputTranscript(String inputTranscript)
The text used to process the request.
You can use this field only in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and it-IT
locales. In all other locales, the inputTranscript
field is null. You should use the
encodedInputTranscript
field instead.
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.
You can use this field only in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and
it-IT locales. In all other locales, the inputTranscript
field is null. You should use the
encodedInputTranscript
field instead.
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 setEncodedInputTranscript(String encodedInputTranscript)
The text used to process the request.
If the input was an audio stream, the encodedInputTranscript
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 encodedInputTranscript
field is base-64 encoded. You must decode the field before you can use
the value.
encodedInputTranscript
- The text used to process the request.
If the input was an audio stream, the encodedInputTranscript
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 encodedInputTranscript
field is base-64 encoded. You must decode the field before you can
use the value.
public String getEncodedInputTranscript()
The text used to process the request.
If the input was an audio stream, the encodedInputTranscript
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 encodedInputTranscript
field is base-64 encoded. You must decode the field before you can use
the value.
If the input was an audio stream, the encodedInputTranscript
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 encodedInputTranscript
field is base-64 encoded. You must decode the field before you
can use the value.
public PostContentResult withEncodedInputTranscript(String encodedInputTranscript)
The text used to process the request.
If the input was an audio stream, the encodedInputTranscript
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 encodedInputTranscript
field is base-64 encoded. You must decode the field before you can use
the value.
encodedInputTranscript
- The text used to process the request.
If the input was an audio stream, the encodedInputTranscript
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 encodedInputTranscript
field is base-64 encoded. You must decode the field before you can
use the value.
public void setAudioStream(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 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.
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(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 void setBotVersion(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.
botVersion
- The version of the bot that responded to the conversation. You can use this information to help determine
if one version of a bot is performing better than another version.public 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.
public PostContentResult withBotVersion(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.
botVersion
- The version of the bot that responded to the conversation. You can use this information to help determine
if one version of a bot is performing better than another version.public void setSessionId(String sessionId)
The unique identifier for the session.
sessionId
- The unique identifier for the session.public String getSessionId()
The unique identifier for the session.
public PostContentResult withSessionId(String sessionId)
The unique identifier for the session.
sessionId
- The unique identifier for the session.public void setActiveContexts(String activeContexts)
A list of active contexts for the session. A context can be set when an intent is fulfilled or by calling the
PostContent
, PostText
, or PutSession
operation.
You can use a context to control the intents that can follow up an intent, or to modify the operation of your application.
This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
activeContexts
- A list of active contexts for the session. A context can be set when an intent is fulfilled or by calling
the PostContent
, PostText
, or PutSession
operation.
You can use a context to control the intents that can follow up an intent, or to modify the operation of your application.
public String getActiveContexts()
A list of active contexts for the session. A context can be set when an intent is fulfilled or by calling the
PostContent
, PostText
, or PutSession
operation.
You can use a context to control the intents that can follow up an intent, or to modify the operation of your application.
This field's value will be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
PostContent
, PostText
, or PutSession
operation.
You can use a context to control the intents that can follow up an intent, or to modify the operation of your application.
public PostContentResult withActiveContexts(String activeContexts)
A list of active contexts for the session. A context can be set when an intent is fulfilled or by calling the
PostContent
, PostText
, or PutSession
operation.
You can use a context to control the intents that can follow up an intent, or to modify the operation of your application.
This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
activeContexts
- A list of active contexts for the session. A context can be set when an intent is fulfilled or by calling
the PostContent
, PostText
, or PutSession
operation.
You can use a context to control the intents that can follow up an intent, or to modify the operation of your application.
public String toString()
toString
in class Object
Object.toString()
public PostContentResult clone()