public class PutSessionResult
extends java.lang.Object
implements java.io.Serializable
Constructor and Description |
---|
PutSessionResult() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.io.InputStream |
getAudioStream()
The audio version of the message to convey to the user.
|
java.lang.String |
getContentType()
Content type as specified in the
Accept HTTP header in the
request. |
java.lang.String |
getDialogState()
|
java.lang.String |
getIntentName()
The name of the current intent.
|
java.lang.String |
getMessage()
The next message that should be presented to the user.
|
java.lang.String |
getMessageFormat()
The format of the response message.
|
java.lang.String |
getSessionAttributes()
Map of key/value pairs representing session-specific context information.
|
java.lang.String |
getSessionId()
A unique identifier for the session.
|
java.lang.String |
getSlots()
Map of zero or more intent slots Amazon Lex detected from the user input
during the conversation.
|
java.lang.String |
getSlotToElicit()
If the
dialogState is ElicitSlot , returns the
name of the slot for which Amazon Lex is eliciting a value. |
int |
hashCode() |
void |
setAudioStream(java.io.InputStream audioStream)
The audio version of the message to convey to the user.
|
void |
setContentType(java.lang.String contentType)
Content type as specified in the
Accept HTTP header in the
request. |
void |
setDialogState(DialogState dialogState)
|
void |
setDialogState(java.lang.String dialogState)
|
void |
setIntentName(java.lang.String intentName)
The name of the current intent.
|
void |
setMessage(java.lang.String message)
The next message that should be presented 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 |
setSessionAttributes(java.lang.String sessionAttributes)
Map of key/value pairs representing session-specific context information.
|
void |
setSessionId(java.lang.String sessionId)
A unique identifier for the session.
|
void |
setSlots(java.lang.String slots)
Map of zero or more intent slots Amazon Lex detected from the user input
during the conversation.
|
void |
setSlotToElicit(java.lang.String slotToElicit)
If the
dialogState 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.
|
PutSessionResult |
withAudioStream(java.io.InputStream audioStream)
The audio version of the message to convey to the user.
|
PutSessionResult |
withContentType(java.lang.String contentType)
Content type as specified in the
Accept HTTP header in the
request. |
PutSessionResult |
withDialogState(DialogState dialogState)
|
PutSessionResult |
withDialogState(java.lang.String dialogState)
|
PutSessionResult |
withIntentName(java.lang.String intentName)
The name of the current intent.
|
PutSessionResult |
withMessage(java.lang.String message)
The next message that should be presented to the user.
|
PutSessionResult |
withMessageFormat(MessageFormatType messageFormat)
The format of the response message.
|
PutSessionResult |
withMessageFormat(java.lang.String messageFormat)
The format of the response message.
|
PutSessionResult |
withSessionAttributes(java.lang.String sessionAttributes)
Map of key/value pairs representing session-specific context information.
|
PutSessionResult |
withSessionId(java.lang.String sessionId)
A unique identifier for the session.
|
PutSessionResult |
withSlots(java.lang.String slots)
Map of zero or more intent slots Amazon Lex detected from the user input
during the conversation.
|
PutSessionResult |
withSlotToElicit(java.lang.String slotToElicit)
If the
dialogState 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 PutSessionResult 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()
The name of the current intent.
The name of the current intent.
public void setIntentName(java.lang.String intentName)
The name of the current intent.
intentName
- The name of the current intent.
public PutSessionResult withIntentName(java.lang.String intentName)
The name of the current intent.
Returns a reference to this object so that method calls can be chained together.
intentName
- The name of the current intent.
public java.lang.String getSlots()
Map of zero or more intent slots Amazon Lex detected from the user input during the conversation.
Amazon Lex creates a resolution list containing likely values for a slot.
The value that it returns is determined by the
valueSelectionStrategy
selected when the slot type was
created or updated. If valueSelectionStrategy
is set to
ORIGINAL_VALUE
, the value provided by the user is returned,
if the user value is similar to the slot values. If
valueSelectionStrategy
is set to TOP_RESOLUTION
Amazon Lex returns the first value in the resolution list or, if there is
no resolution list, null. If you don't specify a
valueSelectionStrategy
the default is
ORIGINAL_VALUE
.
Map of zero or more intent slots Amazon Lex detected from the user input during the conversation.
Amazon Lex creates a resolution list containing likely values for
a slot. The value that it returns is determined by the
valueSelectionStrategy
selected when the slot type
was created or updated. If valueSelectionStrategy
is
set to ORIGINAL_VALUE
, the value provided by the
user is returned, if the user value is similar to the slot
values. If valueSelectionStrategy
is set to
TOP_RESOLUTION
Amazon Lex returns the first value in
the resolution list or, if there is no resolution list, null. If
you don't specify a valueSelectionStrategy
the
default is ORIGINAL_VALUE
.
public void setSlots(java.lang.String slots)
Map of zero or more intent slots Amazon Lex detected from the user input during the conversation.
Amazon Lex creates a resolution list containing likely values for a slot.
The value that it returns is determined by the
valueSelectionStrategy
selected when the slot type was
created or updated. If valueSelectionStrategy
is set to
ORIGINAL_VALUE
, the value provided by the user is returned,
if the user value is similar to the slot values. If
valueSelectionStrategy
is set to TOP_RESOLUTION
Amazon Lex returns the first value in the resolution list or, if there is
no resolution list, null. If you don't specify a
valueSelectionStrategy
the default is
ORIGINAL_VALUE
.
slots
- Map of zero or more intent slots Amazon Lex detected from the user input during the conversation.
Amazon Lex creates a resolution list containing likely values
for a slot. The value that it returns is determined by the
valueSelectionStrategy
selected when the slot
type was created or updated. If
valueSelectionStrategy
is set to
ORIGINAL_VALUE
, the value provided by the user is
returned, if the user value is similar to the slot values. If
valueSelectionStrategy
is set to
TOP_RESOLUTION
Amazon Lex returns the first value
in the resolution list or, if there is no resolution list,
null. If you don't specify a
valueSelectionStrategy
the default is
ORIGINAL_VALUE
.
public PutSessionResult withSlots(java.lang.String slots)
Map of zero or more intent slots Amazon Lex detected from the user input during the conversation.
Amazon Lex creates a resolution list containing likely values for a slot.
The value that it returns is determined by the
valueSelectionStrategy
selected when the slot type was
created or updated. If valueSelectionStrategy
is set to
ORIGINAL_VALUE
, the value provided by the user is returned,
if the user value is similar to the slot values. If
valueSelectionStrategy
is set to TOP_RESOLUTION
Amazon Lex returns the first value in the resolution list or, if there is
no resolution list, null. If you don't specify a
valueSelectionStrategy
the default is
ORIGINAL_VALUE
.
Returns a reference to this object so that method calls can be chained together.
slots
- Map of zero or more intent slots Amazon Lex detected from the user input during the conversation.
Amazon Lex creates a resolution list containing likely values
for a slot. The value that it returns is determined by the
valueSelectionStrategy
selected when the slot
type was created or updated. If
valueSelectionStrategy
is set to
ORIGINAL_VALUE
, the value provided by the user is
returned, if the user value is similar to the slot values. If
valueSelectionStrategy
is set to
TOP_RESOLUTION
Amazon Lex returns the first value
in the resolution list or, if there is no resolution list,
null. If you don't specify a
valueSelectionStrategy
the default is
ORIGINAL_VALUE
.
public java.lang.String getSessionAttributes()
Map of key/value pairs representing session-specific context information.
Map of key/value pairs representing session-specific context information.
public void setSessionAttributes(java.lang.String sessionAttributes)
Map of key/value pairs representing session-specific context information.
sessionAttributes
- Map of key/value pairs representing session-specific context information.
public PutSessionResult withSessionAttributes(java.lang.String sessionAttributes)
Map of key/value pairs representing 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 session-specific context information.
public java.lang.String getMessage()
The next message that should be presented to the user.
Constraints:
Length: 1 - 1024
The next message that should be presented to the user.
public void setMessage(java.lang.String message)
The next message that should be presented to the user.
Constraints:
Length: 1 - 1024
message
- The next message that should be presented to the user.
public PutSessionResult withMessage(java.lang.String message)
The next message that should be presented to the user.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 1024
message
- The next message that should be presented to the user.
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 PutSessionResult 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 PutSessionResult 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()
ConfirmIntent
- Amazon Lex is expecting a "yes" or "no"
response to confirm the intent before fulfilling an intent.
ElicitIntent
- Amazon Lex wants to elicit the user's intent.
ElicitSlot
- Amazon Lex is expecting the value of a slot for
the current intent.
Failed
- Conveys that the conversation with the user has
failed. This can happen for various reasons, including the user does not
provide an appropriate response to prompts from the service, or if the
Lambda function fails to fulfill the intent.
Fulfilled
- Conveys that the Lambda function has sucessfully
fulfilled the intent.
ReadyForFulfillment
- Conveys that the client has to fulfill
the intent.
Constraints:
Allowed Values: ElicitIntent, ConfirmIntent, ElicitSlot,
Fulfilled, ReadyForFulfillment, Failed
ConfirmIntent
- Amazon Lex is expecting a "yes" or
"no" response to confirm the intent before fulfilling an intent.
ElicitIntent
- Amazon Lex wants to elicit the user's
intent.
ElicitSlot
- Amazon Lex is expecting the value of a
slot for the current intent.
Failed
- Conveys that the conversation with the user
has failed. This can happen for various reasons, including the
user does not provide an appropriate response to prompts from the
service, or if the Lambda function fails to fulfill the intent.
Fulfilled
- Conveys that the Lambda function has
sucessfully fulfilled the intent.
ReadyForFulfillment
- Conveys that the client has to
fulfill the intent.
DialogState
public void setDialogState(java.lang.String dialogState)
ConfirmIntent
- Amazon Lex is expecting a "yes" or "no"
response to confirm the intent before fulfilling an intent.
ElicitIntent
- Amazon Lex wants to elicit the user's intent.
ElicitSlot
- Amazon Lex is expecting the value of a slot for
the current intent.
Failed
- Conveys that the conversation with the user has
failed. This can happen for various reasons, including the user does not
provide an appropriate response to prompts from the service, or if the
Lambda function fails to fulfill the intent.
Fulfilled
- Conveys that the Lambda function has sucessfully
fulfilled the intent.
ReadyForFulfillment
- Conveys that the client has to fulfill
the intent.
Constraints:
Allowed Values: ElicitIntent, ConfirmIntent, ElicitSlot,
Fulfilled, ReadyForFulfillment, Failed
dialogState
-
ConfirmIntent
- Amazon Lex is expecting a "yes"
or "no" response to confirm the intent before fulfilling an
intent.
ElicitIntent
- Amazon Lex wants to elicit the
user's intent.
ElicitSlot
- Amazon Lex is expecting the value of
a slot for the current intent.
Failed
- Conveys that the conversation with the
user has failed. This can happen for various reasons,
including the user does not provide an appropriate response to
prompts from the service, or if the Lambda function fails to
fulfill the intent.
Fulfilled
- Conveys that the Lambda function has
sucessfully fulfilled the intent.
ReadyForFulfillment
- Conveys that the client has
to fulfill the intent.
DialogState
public PutSessionResult withDialogState(java.lang.String dialogState)
ConfirmIntent
- Amazon Lex is expecting a "yes" or "no"
response to confirm the intent before fulfilling an intent.
ElicitIntent
- Amazon Lex wants to elicit the user's intent.
ElicitSlot
- Amazon Lex is expecting the value of a slot for
the current intent.
Failed
- Conveys that the conversation with the user has
failed. This can happen for various reasons, including the user does not
provide an appropriate response to prompts from the service, or if the
Lambda function fails to fulfill the intent.
Fulfilled
- Conveys that the Lambda function has sucessfully
fulfilled the intent.
ReadyForFulfillment
- Conveys that the client has 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
-
ConfirmIntent
- Amazon Lex is expecting a "yes"
or "no" response to confirm the intent before fulfilling an
intent.
ElicitIntent
- Amazon Lex wants to elicit the
user's intent.
ElicitSlot
- Amazon Lex is expecting the value of
a slot for the current intent.
Failed
- Conveys that the conversation with the
user has failed. This can happen for various reasons,
including the user does not provide an appropriate response to
prompts from the service, or if the Lambda function fails to
fulfill the intent.
Fulfilled
- Conveys that the Lambda function has
sucessfully fulfilled the intent.
ReadyForFulfillment
- Conveys that the client has
to fulfill the intent.
DialogState
public void setDialogState(DialogState dialogState)
ConfirmIntent
- Amazon Lex is expecting a "yes" or "no"
response to confirm the intent before fulfilling an intent.
ElicitIntent
- Amazon Lex wants to elicit the user's intent.
ElicitSlot
- Amazon Lex is expecting the value of a slot for
the current intent.
Failed
- Conveys that the conversation with the user has
failed. This can happen for various reasons, including the user does not
provide an appropriate response to prompts from the service, or if the
Lambda function fails to fulfill the intent.
Fulfilled
- Conveys that the Lambda function has sucessfully
fulfilled the intent.
ReadyForFulfillment
- Conveys that the client has to fulfill
the intent.
Constraints:
Allowed Values: ElicitIntent, ConfirmIntent, ElicitSlot,
Fulfilled, ReadyForFulfillment, Failed
dialogState
-
ConfirmIntent
- Amazon Lex is expecting a "yes"
or "no" response to confirm the intent before fulfilling an
intent.
ElicitIntent
- Amazon Lex wants to elicit the
user's intent.
ElicitSlot
- Amazon Lex is expecting the value of
a slot for the current intent.
Failed
- Conveys that the conversation with the
user has failed. This can happen for various reasons,
including the user does not provide an appropriate response to
prompts from the service, or if the Lambda function fails to
fulfill the intent.
Fulfilled
- Conveys that the Lambda function has
sucessfully fulfilled the intent.
ReadyForFulfillment
- Conveys that the client has
to fulfill the intent.
DialogState
public PutSessionResult withDialogState(DialogState dialogState)
ConfirmIntent
- Amazon Lex is expecting a "yes" or "no"
response to confirm the intent before fulfilling an intent.
ElicitIntent
- Amazon Lex wants to elicit the user's intent.
ElicitSlot
- Amazon Lex is expecting the value of a slot for
the current intent.
Failed
- Conveys that the conversation with the user has
failed. This can happen for various reasons, including the user does not
provide an appropriate response to prompts from the service, or if the
Lambda function fails to fulfill the intent.
Fulfilled
- Conveys that the Lambda function has sucessfully
fulfilled the intent.
ReadyForFulfillment
- Conveys that the client has 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
-
ConfirmIntent
- Amazon Lex is expecting a "yes"
or "no" response to confirm the intent before fulfilling an
intent.
ElicitIntent
- Amazon Lex wants to elicit the
user's intent.
ElicitSlot
- Amazon Lex is expecting the value of
a slot for the current intent.
Failed
- Conveys that the conversation with the
user has failed. This can happen for various reasons,
including the user does not provide an appropriate response to
prompts from the service, or if the Lambda function fails to
fulfill the intent.
Fulfilled
- Conveys that the Lambda function has
sucessfully fulfilled the intent.
ReadyForFulfillment
- Conveys that the client has
to fulfill the intent.
DialogState
public java.lang.String getSlotToElicit()
If the dialogState
is ElicitSlot
, returns the
name of the slot for which Amazon Lex is eliciting a value.
If the dialogState
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
is ElicitSlot
, returns the
name of the slot for which Amazon Lex is eliciting a value.
slotToElicit
-
If the dialogState
is ElicitSlot
,
returns the name of the slot for which Amazon Lex is eliciting
a value.
public PutSessionResult withSlotToElicit(java.lang.String slotToElicit)
If the dialogState
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
is ElicitSlot
,
returns the name of the slot for which Amazon Lex is eliciting
a value.
public java.io.InputStream getAudioStream()
The audio version of the message to convey to the user.
The audio version of the message to convey to the user.
public void setAudioStream(java.io.InputStream audioStream)
The audio version of the message to convey to the user.
audioStream
- The audio version of the message to convey to the user.
public PutSessionResult withAudioStream(java.io.InputStream audioStream)
The audio version of the message to convey to the user.
Returns a reference to this object so that method calls can be chained together.
audioStream
- The audio version of the message to convey to the user.
public java.lang.String getSessionId()
A unique identifier for the session.
A unique identifier for the session.
public void setSessionId(java.lang.String sessionId)
A unique identifier for the session.
sessionId
- A unique identifier for the session.
public PutSessionResult withSessionId(java.lang.String sessionId)
A unique identifier for the session.
Returns a reference to this object so that method calls can be chained together.
sessionId
- A unique identifier for the session.
public java.lang.String 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.