com.amazonaws.services.lexruntime.model

Class PostContentResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.lexruntime.model.PostContentResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PostContentResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
PostContentResult()

Method Summary

Modifier and Type	Method and Description
PostContentResult	clone()
boolean	equals(Object obj)
InputStream	getAudioStream() The prompt (or statement) to convey to the user.
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	getInputTranscript() The text used to process the request.
String	getIntentName() Current user intent that Amazon Lex is aware of.
String	getMessage() Message to convey to the user.
String	getSessionAttributes() Map of key/value pairs representing the session-specific context information.
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	setAudioStream(InputStream audioStream) The prompt (or statement) to convey to the user.
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	setInputTranscript(String inputTranscript) The text used to process the request.
void	setIntentName(String intentName) Current user intent that Amazon Lex is aware of.
void	setMessage(String message) Message to convey to the user.
void	setSessionAttributes(String sessionAttributes) Map of key/value pairs representing the session-specific context information.
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; useful for testing and debugging.
PostContentResult	withAudioStream(InputStream audioStream) The prompt (or statement) to convey to the user.
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	withInputTranscript(String inputTranscript) The text used to process the request.
PostContentResult	withIntentName(String intentName) Current user intent that Amazon Lex is aware of.
PostContentResult	withMessage(String message) Message to convey to the user.
PostContentResult	withSessionAttributes(String sessionAttributes) Map of key/value pairs representing the session-specific context information.
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.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PostContentResult

public PostContentResult()

Method Detail

setContentType

public void setContentType(String contentType)

Content type as specified in the Accept HTTP header in the request.

Parameters:

contentType - Content type as specified in the Accept HTTP header in the request.

getContentType

public String getContentType()

Content type as specified in the Accept HTTP header in the request.

Returns:

Content type as specified in the Accept HTTP header in the request.

withContentType

public PostContentResult withContentType(String contentType)

Content type as specified in the Accept HTTP header in the request.

Parameters:

contentType - Content type as specified in the Accept HTTP header in the request.

Returns:

Returns a reference to this object so that method calls can be chained together.

setIntentName

public void setIntentName(String intentName)

Current user intent that Amazon Lex is aware of.

Parameters:

intentName - Current user intent that Amazon Lex is aware of.

getIntentName

public String getIntentName()

Current user intent that Amazon Lex is aware of.

Returns:

Current user intent that Amazon Lex is aware of.

withIntentName

public PostContentResult withIntentName(String intentName)

Current user intent that Amazon Lex is aware of.

Parameters:

intentName - Current user intent that Amazon Lex is aware of.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSlots

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.

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.

Parameters:

slots - Map of zero or more intent slots (name/value pairs) 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.

getSlots

public String getSlots()

Map of zero or more intent slots (name/value pairs) 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.

This field's value will be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.

Returns:

Map of zero or more intent slots (name/value pairs) 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.

withSlots

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.

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.

Parameters:

slots - Map of zero or more intent slots (name/value pairs) 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:

Returns a reference to this object so that method calls can be chained together.

setSessionAttributes

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.

Parameters:

sessionAttributes - Map of key/value pairs representing the session-specific context information.

getSessionAttributes

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"}'.

Returns:

Map of key/value pairs representing the session-specific context information.

withSessionAttributes

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.

Parameters:

sessionAttributes - Map of key/value pairs representing the session-specific context information.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMessage

public void setMessage(String message)

Message to convey to the user. It can come from the bot's configuration or a code hook (Lambda function). If the current intent is not configured with a code hook or if the code hook returned Delegate as the dialogAction.type in its response, then Amazon Lex decides the next course of action and selects an appropriate message from the bot configuration based on the current user interaction context. For example, if Amazon Lex is not able to understand the user input, it uses a clarification prompt message (For more information, see the Error Handling section in the Amazon Lex console). Another example: if the intent requires confirmation before fulfillment, then Amazon Lex uses the confirmation prompt message in the intent configuration. If the code hook returns a message, Amazon Lex passes it as-is in its response to the client.

Parameters:

message - Message to convey to the user. It can come from the bot's configuration or a code hook (Lambda function). If the current intent is not configured with a code hook or if the code hook returned Delegate as the dialogAction.type in its response, then Amazon Lex decides the next course of action and selects an appropriate message from the bot configuration based on the current user interaction context. For example, if Amazon Lex is not able to understand the user input, it uses a clarification prompt message (For more information, see the Error Handling section in the Amazon Lex console). Another example: if the intent requires confirmation before fulfillment, then Amazon Lex uses the confirmation prompt message in the intent configuration. If the code hook returns a message, Amazon Lex passes it as-is in its response to the client.

getMessage

public String getMessage()

Message to convey to the user. It can come from the bot's configuration or a code hook (Lambda function). If the current intent is not configured with a code hook or if the code hook returned Delegate as the dialogAction.type in its response, then Amazon Lex decides the next course of action and selects an appropriate message from the bot configuration based on the current user interaction context. For example, if Amazon Lex is not able to understand the user input, it uses a clarification prompt message (For more information, see the Error Handling section in the Amazon Lex console). Another example: if the intent requires confirmation before fulfillment, then Amazon Lex uses the confirmation prompt message in the intent configuration. If the code hook returns a message, Amazon Lex passes it as-is in its response to the client.

Returns:

Message to convey to the user. It can come from the bot's configuration or a code hook (Lambda function). If the current intent is not configured with a code hook or if the code hook returned Delegate as the dialogAction.type in its response, then Amazon Lex decides the next course of action and selects an appropriate message from the bot configuration based on the current user interaction context. For example, if Amazon Lex is not able to understand the user input, it uses a clarification prompt message (For more information, see the Error Handling section in the Amazon Lex console). Another example: if the intent requires confirmation before fulfillment, then Amazon Lex uses the confirmation prompt message in the intent configuration. If the code hook returns a message, Amazon Lex passes it as-is in its response to the client.

withMessage

public PostContentResult withMessage(String message)

Message to convey to the user. It can come from the bot's configuration or a code hook (Lambda function). If the current intent is not configured with a code hook or if the code hook returned Delegate as the dialogAction.type in its response, then Amazon Lex decides the next course of action and selects an appropriate message from the bot configuration based on the current user interaction context. For example, if Amazon Lex is not able to understand the user input, it uses a clarification prompt message (For more information, see the Error Handling section in the Amazon Lex console). Another example: if the intent requires confirmation before fulfillment, then Amazon Lex uses the confirmation prompt message in the intent configuration. If the code hook returns a message, Amazon Lex passes it as-is in its response to the client.

Parameters:

message - Message to convey to the user. It can come from the bot's configuration or a code hook (Lambda function). If the current intent is not configured with a code hook or if the code hook returned Delegate as the dialogAction.type in its response, then Amazon Lex decides the next course of action and selects an appropriate message from the bot configuration based on the current user interaction context. For example, if Amazon Lex is not able to understand the user input, it uses a clarification prompt message (For more information, see the Error Handling section in the Amazon Lex console). Another example: if the intent requires confirmation before fulfillment, then Amazon Lex uses the confirmation prompt message in the intent configuration. If the code hook returns a message, Amazon Lex passes it as-is in its response to the client.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDialogState

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.

Parameters:

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.

See Also:

DialogState

getDialogState

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.

Returns:

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.

See Also:

DialogState

withDialogState

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.

Parameters:

dialogState - Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState. The client can optionally use this information to customize the user interface.

• ElicitIntent - Amazon Lex wants to elicit the user's intent. Consider the following examples:

  For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialog state.

• ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response.

  For example, Amazon Lex wants user confirmation before fulfilling an intent. Instead of a simple "yes" or "no" response, a user might respond with additional information. For example, "yes, but make it a thick crust pizza" or "no, I want to order a drink." Amazon Lex can process such additional information (in these examples, update the crust type slot or change the intent from OrderPizza to OrderDrink).

• ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.

  For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately.

• Fulfilled - Conveys that the Lambda function has successfully fulfilled the intent.

• ReadyForFulfillment - Conveys that the client has to fulfill the request.

• Failed - Conveys that the conversation with the user failed.

  This can happen for various reasons, including that the user does not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or if the Lambda function fails to fulfill the intent.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DialogState

setDialogState

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.

Parameters:

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.

See Also:

DialogState

withDialogState

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.

Parameters:

dialogState - Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState. The client can optionally use this information to customize the user interface.

• ElicitIntent - Amazon Lex wants to elicit the user's intent. Consider the following examples:

  For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialog state.

• ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response.

  For example, Amazon Lex wants user confirmation before fulfilling an intent. Instead of a simple "yes" or "no" response, a user might respond with additional information. For example, "yes, but make it a thick crust pizza" or "no, I want to order a drink." Amazon Lex can process such additional information (in these examples, update the crust type slot or change the intent from OrderPizza to OrderDrink).

• ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.

  For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately.

• Fulfilled - Conveys that the Lambda function has successfully fulfilled the intent.

• ReadyForFulfillment - Conveys that the client has to fulfill the request.

• Failed - Conveys that the conversation with the user failed.

  This can happen for various reasons, including that the user does not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or if the Lambda function fails to fulfill the intent.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DialogState

setSlotToElicit

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.

Parameters:

slotToElicit - If the dialogState value is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.

getSlotToElicit

public String getSlotToElicit()

If the dialogState value is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.

Returns:

If the dialogState value is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.

withSlotToElicit

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.

Parameters:

slotToElicit - If the dialogState value is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.

Returns:

Returns a reference to this object so that method calls can be chained together.

setInputTranscript

public void setInputTranscript(String inputTranscript)

The text used to process the request.

If the input was an audio stream, the inputTranscript field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex is correctly processing the audio that you send.

Parameters:

inputTranscript - The text used to process the request.

If the input was an audio stream, the inputTranscript field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex is correctly processing the audio that you send.

getInputTranscript

public String getInputTranscript()

The text used to process the request.

If the input was an audio stream, the inputTranscript field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex is correctly processing the audio that you send.

Returns:

The text used to process the request.

If the input was an audio stream, the inputTranscript field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex is correctly processing the audio that you send.

withInputTranscript

public PostContentResult withInputTranscript(String inputTranscript)

The text used to process the request.

If the input was an audio stream, the inputTranscript field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex is correctly processing the audio that you send.

Parameters:

inputTranscript - The text used to process the request.

If the input was an audio stream, the inputTranscript field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex is correctly processing the audio that you send.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAudioStream

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.

Parameters:

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.

getAudioStream

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.

Returns:

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.

withAudioStream

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.

Parameters:

audioStream - The prompt (or statement) to convey to the user. This is based on the bot configuration and context. For example, if Amazon Lex did not understand the user intent, it sends the clarificationPrompt configured for the bot. If the intent requires confirmation before taking the fulfillment action, it sends the confirmationPrompt. Another example: Suppose that the Lambda function successfully fulfilled the intent, and sent a message to convey to the user. Then Amazon Lex sends that message in the response.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public PostContentResult clone()

Overrides:

clone in class Object