PostTextRequest (AWS SDK for Android - Amazon Lex 2.6.24 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.lexrts.model.PostTextRequest

All Implemented Interfaces:

Serializable, Cloneable
```
public class PostTextRequest
extends AmazonWebServiceRequest
implements Serializable
```
Sends user input (text-only) to Amazon Lex. Client applications can use this API to send requests to Amazon Lex at runtime. Amazon Lex then interprets the user input using the machine learning model it built for the bot.

In response, Amazon Lex returns the next message to convey to the user an optional responseCard to display. Consider the following example messages:
- For a user input "I would like a pizza", Amazon Lex might return a response with a message eliciting slot data (for example, PizzaSize): "What size pizza would you like?"
- After the user provides all of the pizza order information, Amazon Lex might return a response with a message to obtain user confirmation "Proceed with the pizza order?".
- After the user replies to a confirmation prompt with a "yes", Amazon Lex might return a conclusion statement: "Thank you, your cheese pizza has been ordered.".
Not all Amazon Lex messages require a user response. For example, a conclusion statement does not require a response. Some messages require only a "yes" or "no" user response. In addition to the message, Amazon Lex provides additional context about the message in the response that you might use to enhance client behavior, for example, to display the appropriate client user interface. These are the slotToElicit, dialogState, intentName, and slots fields in the response. Consider the following examples:
- If the message is to elicit slot data, Amazon Lex returns the following context information:
  - dialogState set to ElicitSlot
  - intentName set to the intent name in the current context
  - slotToElicit set to the slot name for which the message is eliciting information
  - slots set to a map of slots, configured for the intent, with currently known values
- If the message is a confirmation prompt, the dialogState is set to ConfirmIntent and SlotToElicit is set to null.
- If the message is a clarification prompt (configured for the intent) that indicates that user intent is not understood, the dialogState is set to ElicitIntent and slotToElicit is set to null.
In addition, Amazon Lex also returns your application-specific sessionAttributes. For more information, see Managing Conversation Context.
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

PostTextRequest()

Constructors
Constructor and Description
`PostTextRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PostTextRequest`	`addsessionAttributesEntry(String key, String value)` By using session attributes, a client application can pass contextual information in the request to Amazon Lex For example,
`PostTextRequest`	`clearsessionAttributesEntries()` Removes all the entries added into sessionAttributes.
`boolean`	`equals(Object obj)`
`String`	`getBotAlias()` The alias of the Amazon Lex bot.
`String`	`getBotName()` The name of the Amazon Lex bot.
`String`	`getInputText()` The text that the user entered (Amazon Lex interprets this text).
`Map<String,String>`	`getSessionAttributes()` By using session attributes, a client application can pass contextual information in the request to Amazon Lex For example,
`String`	`getUserId()` The ID of the client application user.
`int`	`hashCode()`
`void`	`setBotAlias(String botAlias)` The alias of the Amazon Lex bot.
`void`	`setBotName(String botName)` The name of the Amazon Lex bot.
`void`	`setInputText(String inputText)` The text that the user entered (Amazon Lex interprets this text).
`void`	`setSessionAttributes(Map<String,String> sessionAttributes)` By using session attributes, a client application can pass contextual information in the request to Amazon Lex For example,
`void`	`setUserId(String userId)` The ID of the client application user.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`PostTextRequest`	`withBotAlias(String botAlias)` The alias of the Amazon Lex bot.
`PostTextRequest`	`withBotName(String botName)` The name of the Amazon Lex bot.
`PostTextRequest`	`withInputText(String inputText)` The text that the user entered (Amazon Lex interprets this text).
`PostTextRequest`	`withSessionAttributes(Map<String,String> sessionAttributes)` By using session attributes, a client application can pass contextual information in the request to Amazon Lex For example,
`PostTextRequest`	`withUserId(String userId)` The ID of the client application user.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PostTextRequest
```
public PostTextRequest()
```
- Method Detail
  - getBotName
```
public String getBotName()
```
    The name of the Amazon Lex bot.
    
    Returns:
    
    The name of the Amazon Lex bot.
  - setBotName
```
public void setBotName(String botName)
```
    The name of the Amazon Lex bot.
    
    Parameters:
    
    botName -
    The name of the Amazon Lex bot.
  - withBotName
```
public PostTextRequest withBotName(String botName)
```
    The name of the Amazon Lex bot.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    botName -
    The name of the Amazon Lex bot.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getBotAlias
```
public String getBotAlias()
```
    The alias of the Amazon Lex bot.
    
    Returns:
    
    The alias of the Amazon Lex bot.
  - setBotAlias
```
public void setBotAlias(String botAlias)
```
    The alias of the Amazon Lex bot.
    
    Parameters:
    
    botAlias -
    The alias of the Amazon Lex bot.
  - withBotAlias
```
public PostTextRequest withBotAlias(String botAlias)
```
    The alias of the Amazon Lex bot.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    botAlias -
    The alias of the Amazon Lex bot.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getUserId
```
public String getUserId()
```
    The ID of the client application user. The application developer decides the user IDs. At runtime, each request must include the user ID. Typically, each of your application users should have a unique ID. Note the following considerations:
    - If you want a user to start a conversation on one device and continue the conversation on another device, you might choose a user-specific identifier, such as a login or Amazon Cognito user ID (assuming your application is using Amazon Cognito).
    - If you want the same user to be able to have two independent conversations on two different devices, you might choose a device-specific identifier, such as device ID, or some globally unique identifier.
    Constraints:
    Length: 2 - 100
    Pattern: [0-9a-zA-Z._:-]+
    Returns:
    The ID of the client application user. The application developer decides the user IDs. At runtime, each request must include the user ID. Typically, each of your application users should have a unique ID. Note the following considerations:
    
    If you want a user to start a conversation on one device and continue the conversation on another device, you might choose a user-specific identifier, such as a login or Amazon Cognito user ID (assuming your application is using Amazon Cognito).
    
    If you want the same user to be able to have two independent conversations on two different devices, you might choose a device-specific identifier, such as device ID, or some globally unique identifier.
  - setUserId
```
public void setUserId(String userId)
```
    The ID of the client application user. The application developer decides the user IDs. At runtime, each request must include the user ID. Typically, each of your application users should have a unique ID. Note the following considerations:
    - If you want a user to start a conversation on one device and continue the conversation on another device, you might choose a user-specific identifier, such as a login or Amazon Cognito user ID (assuming your application is using Amazon Cognito).
    - If you want the same user to be able to have two independent conversations on two different devices, you might choose a device-specific identifier, such as device ID, or some globally unique identifier.
    Constraints:
    Length: 2 - 100
    Pattern: [0-9a-zA-Z._:-]+
    Parameters:
    userId -
    The ID of the client application user. The application developer decides the user IDs. At runtime, each request must include the user ID. Typically, each of your application users should have a unique ID. Note the following considerations:
    
    If you want a user to start a conversation on one device and continue the conversation on another device, you might choose a user-specific identifier, such as a login or Amazon Cognito user ID (assuming your application is using Amazon Cognito).
    
    If you want the same user to be able to have two independent conversations on two different devices, you might choose a device-specific identifier, such as device ID, or some globally unique identifier.
  - withUserId
```
public PostTextRequest withUserId(String userId)
```
    The ID of the client application user. The application developer decides the user IDs. At runtime, each request must include the user ID. Typically, each of your application users should have a unique ID. Note the following considerations:
    - If you want a user to start a conversation on one device and continue the conversation on another device, you might choose a user-specific identifier, such as a login or Amazon Cognito user ID (assuming your application is using Amazon Cognito).
    - If you want the same user to be able to have two independent conversations on two different devices, you might choose a device-specific identifier, such as device ID, or some globally unique identifier.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 2 - 100
    Pattern: [0-9a-zA-Z._:-]+
    Parameters:
    userId -
    The ID of the client application user. The application developer decides the user IDs. At runtime, each request must include the user ID. Typically, each of your application users should have a unique ID. Note the following considerations:
    
    If you want a user to start a conversation on one device and continue the conversation on another device, you might choose a user-specific identifier, such as a login or Amazon Cognito user ID (assuming your application is using Amazon Cognito).
    
    If you want the same user to be able to have two independent conversations on two different devices, you might choose a device-specific identifier, such as device ID, or some globally unique identifier.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSessionAttributes
```
public Map<String,String> getSessionAttributes()
```
    By using session attributes, a client application can pass contextual information in the request to Amazon Lex For example,
    - In Getting Started Exercise 1, the example bot uses the price session attribute to maintain the price of the flowers ordered (for example, "Price":25). The code hook (the Lambda function) sets this attribute based on the type of flowers ordered. For more information, see Review the Details of Information Flow.
    - In the BookTrip bot exercise, the bot uses the currentReservation session attribute to maintain slot data during the in-progress conversation to book a hotel or book a car. For more information, see Details of Information Flow.
    - You might use the session attributes (key, value pairs) to track the requestID of user requests.
    Amazon Lex simply passes these session attributes to the Lambda functions configured for the intent.
    
    In your Lambda function, you can also use the session attributes for initialization and customization (prompts and response cards). Some examples are:
    - Initialization - In a pizza ordering bot, if you can pass the user location as a session attribute (for example, "Location" : "111 Maple street"), then your Lambda function might use this information to determine the closest pizzeria to place the order (perhaps to set the storeAddress slot value).
    - Personalize prompts - For example, you can configure prompts to refer to the user name. (For example, "Hey [FirstName], what toppings would you like?"). You can pass the user name as a session attribute ("FirstName" : "Joe") so that Amazon Lex can substitute the placeholder to provide a personalize prompt to the user ("Hey Joe, what toppings would you like?").
    Amazon Lex does not persist session attributes.
    
    If you configure a code hook for the intent, Amazon Lex passes the incoming session attributes to the Lambda function. If you want Amazon Lex to return these session attributes back to the client, the Lambda function must return them.
    
    If there is no code hook configured for the intent, Amazon Lex simply returns the session attributes back to the client application.
    Returns:
    By using session attributes, a client application can pass contextual information in the request to Amazon Lex For example,
    
    In Getting Started Exercise 1, the example bot uses the price session attribute to maintain the price of the flowers ordered (for example, "Price":25). The code hook (the Lambda function) sets this attribute based on the type of flowers ordered. For more information, see Review the Details of Information Flow.
    
    In the BookTrip bot exercise, the bot uses the currentReservation session attribute to maintain slot data during the in-progress conversation to book a hotel or book a car. For more information, see Details of Information Flow.
    
    You might use the session attributes (key, value pairs) to track the requestID of user requests.
    
    Amazon Lex simply passes these session attributes to the Lambda functions configured for the intent.
    
    In your Lambda function, you can also use the session attributes for initialization and customization (prompts and response cards). Some examples are:
    
    Initialization - In a pizza ordering bot, if you can pass the user location as a session attribute (for example, "Location" : "111 Maple street"), then your Lambda function might use this information to determine the closest pizzeria to place the order (perhaps to set the storeAddress slot value).
    
    Personalize prompts - For example, you can configure prompts to refer to the user name. (For example, "Hey [FirstName], what toppings would you like?"). You can pass the user name as a session attribute ( "FirstName" : "Joe") so that Amazon Lex can substitute the placeholder to provide a personalize prompt to the user ("Hey Joe, what toppings would you like?").
    
    Amazon Lex does not persist session attributes.
    
    If you configure a code hook for the intent, Amazon Lex passes the incoming session attributes to the Lambda function. If you want Amazon Lex to return these session attributes back to the client, the Lambda function must return them.
    
    If there is no code hook configured for the intent, Amazon Lex simply returns the session attributes back to the client application.
  - setSessionAttributes
```
public void setSessionAttributes(Map<String,String> sessionAttributes)
```
    By using session attributes, a client application can pass contextual information in the request to Amazon Lex For example,
    - In Getting Started Exercise 1, the example bot uses the price session attribute to maintain the price of the flowers ordered (for example, "Price":25). The code hook (the Lambda function) sets this attribute based on the type of flowers ordered. For more information, see Review the Details of Information Flow.
    - In the BookTrip bot exercise, the bot uses the currentReservation session attribute to maintain slot data during the in-progress conversation to book a hotel or book a car. For more information, see Details of Information Flow.
    - You might use the session attributes (key, value pairs) to track the requestID of user requests.
    Amazon Lex simply passes these session attributes to the Lambda functions configured for the intent.
    
    In your Lambda function, you can also use the session attributes for initialization and customization (prompts and response cards). Some examples are:
    - Initialization - In a pizza ordering bot, if you can pass the user location as a session attribute (for example, "Location" : "111 Maple street"), then your Lambda function might use this information to determine the closest pizzeria to place the order (perhaps to set the storeAddress slot value).
    - Personalize prompts - For example, you can configure prompts to refer to the user name. (For example, "Hey [FirstName], what toppings would you like?"). You can pass the user name as a session attribute ("FirstName" : "Joe") so that Amazon Lex can substitute the placeholder to provide a personalize prompt to the user ("Hey Joe, what toppings would you like?").
    Amazon Lex does not persist session attributes.
    
    If you configure a code hook for the intent, Amazon Lex passes the incoming session attributes to the Lambda function. If you want Amazon Lex to return these session attributes back to the client, the Lambda function must return them.
    
    If there is no code hook configured for the intent, Amazon Lex simply returns the session attributes back to the client application.
    Parameters:
    sessionAttributes -
    By using session attributes, a client application can pass contextual information in the request to Amazon Lex For example,
    
    In Getting Started Exercise 1, the example bot uses the price session attribute to maintain the price of the flowers ordered (for example, "Price":25). The code hook (the Lambda function) sets this attribute based on the type of flowers ordered. For more information, see Review the Details of Information Flow.
    
    In the BookTrip bot exercise, the bot uses the currentReservation session attribute to maintain slot data during the in-progress conversation to book a hotel or book a car. For more information, see Details of Information Flow.
    
    You might use the session attributes (key, value pairs) to track the requestID of user requests.
    
    Amazon Lex simply passes these session attributes to the Lambda functions configured for the intent.
    
    In your Lambda function, you can also use the session attributes for initialization and customization (prompts and response cards). Some examples are:
    
    Initialization - In a pizza ordering bot, if you can pass the user location as a session attribute (for example, "Location" : "111 Maple street"), then your Lambda function might use this information to determine the closest pizzeria to place the order (perhaps to set the storeAddress slot value).
    
    Personalize prompts - For example, you can configure prompts to refer to the user name. (For example, "Hey [FirstName], what toppings would you like?"). You can pass the user name as a session attribute ( "FirstName" : "Joe") so that Amazon Lex can substitute the placeholder to provide a personalize prompt to the user ("Hey Joe, what toppings would you like?").
    
    Amazon Lex does not persist session attributes.
    
    If you configure a code hook for the intent, Amazon Lex passes the incoming session attributes to the Lambda function. If you want Amazon Lex to return these session attributes back to the client, the Lambda function must return them.
    
    If there is no code hook configured for the intent, Amazon Lex simply returns the session attributes back to the client application.
  - withSessionAttributes
```
public PostTextRequest withSessionAttributes(Map<String,String> sessionAttributes)
```
    By using session attributes, a client application can pass contextual information in the request to Amazon Lex For example,
    - In Getting Started Exercise 1, the example bot uses the price session attribute to maintain the price of the flowers ordered (for example, "Price":25). The code hook (the Lambda function) sets this attribute based on the type of flowers ordered. For more information, see Review the Details of Information Flow.
    - In the BookTrip bot exercise, the bot uses the currentReservation session attribute to maintain slot data during the in-progress conversation to book a hotel or book a car. For more information, see Details of Information Flow.
    - You might use the session attributes (key, value pairs) to track the requestID of user requests.
    Amazon Lex simply passes these session attributes to the Lambda functions configured for the intent.
    
    In your Lambda function, you can also use the session attributes for initialization and customization (prompts and response cards). Some examples are:
    - Initialization - In a pizza ordering bot, if you can pass the user location as a session attribute (for example, "Location" : "111 Maple street"), then your Lambda function might use this information to determine the closest pizzeria to place the order (perhaps to set the storeAddress slot value).
    - Personalize prompts - For example, you can configure prompts to refer to the user name. (For example, "Hey [FirstName], what toppings would you like?"). You can pass the user name as a session attribute ("FirstName" : "Joe") so that Amazon Lex can substitute the placeholder to provide a personalize prompt to the user ("Hey Joe, what toppings would you like?").
    Amazon Lex does not persist session attributes.
    
    If you configure a code hook for the intent, Amazon Lex passes the incoming session attributes to the Lambda function. If you want Amazon Lex to return these session attributes back to the client, the Lambda function must return them.
    
    If there is no code hook configured for the intent, Amazon Lex simply returns the session attributes back to the client application.
    
    Returns a reference to this object so that method calls can be chained together.
    Parameters:
    sessionAttributes -
    By using session attributes, a client application can pass contextual information in the request to Amazon Lex For example,
    
    In Getting Started Exercise 1, the example bot uses the price session attribute to maintain the price of the flowers ordered (for example, "Price":25). The code hook (the Lambda function) sets this attribute based on the type of flowers ordered. For more information, see Review the Details of Information Flow.
    
    In the BookTrip bot exercise, the bot uses the currentReservation session attribute to maintain slot data during the in-progress conversation to book a hotel or book a car. For more information, see Details of Information Flow.
    
    You might use the session attributes (key, value pairs) to track the requestID of user requests.
    
    Amazon Lex simply passes these session attributes to the Lambda functions configured for the intent.
    
    In your Lambda function, you can also use the session attributes for initialization and customization (prompts and response cards). Some examples are:
    
    Initialization - In a pizza ordering bot, if you can pass the user location as a session attribute (for example, "Location" : "111 Maple street"), then your Lambda function might use this information to determine the closest pizzeria to place the order (perhaps to set the storeAddress slot value).
    
    Personalize prompts - For example, you can configure prompts to refer to the user name. (For example, "Hey [FirstName], what toppings would you like?"). You can pass the user name as a session attribute ( "FirstName" : "Joe") so that Amazon Lex can substitute the placeholder to provide a personalize prompt to the user ("Hey Joe, what toppings would you like?").
    
    Amazon Lex does not persist session attributes.
    
    If you configure a code hook for the intent, Amazon Lex passes the incoming session attributes to the Lambda function. If you want Amazon Lex to return these session attributes back to the client, the Lambda function must return them.
    
    If there is no code hook configured for the intent, Amazon Lex simply returns the session attributes back to the client application.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addsessionAttributesEntry
```
public PostTextRequest addsessionAttributesEntry(String key,
                                                 String value)
```
    By using session attributes, a client application can pass contextual information in the request to Amazon Lex For example,
    - In Getting Started Exercise 1, the example bot uses the price session attribute to maintain the price of the flowers ordered (for example, "Price":25). The code hook (the Lambda function) sets this attribute based on the type of flowers ordered. For more information, see Review the Details of Information Flow.
    - In the BookTrip bot exercise, the bot uses the currentReservation session attribute to maintain slot data during the in-progress conversation to book a hotel or book a car. For more information, see Details of Information Flow.
    - You might use the session attributes (key, value pairs) to track the requestID of user requests.
    Amazon Lex simply passes these session attributes to the Lambda functions configured for the intent.
    
    In your Lambda function, you can also use the session attributes for initialization and customization (prompts and response cards). Some examples are:
    - Initialization - In a pizza ordering bot, if you can pass the user location as a session attribute (for example, "Location" : "111 Maple street"), then your Lambda function might use this information to determine the closest pizzeria to place the order (perhaps to set the storeAddress slot value).
    - Personalize prompts - For example, you can configure prompts to refer to the user name. (For example, "Hey [FirstName], what toppings would you like?"). You can pass the user name as a session attribute ("FirstName" : "Joe") so that Amazon Lex can substitute the placeholder to provide a personalize prompt to the user ("Hey Joe, what toppings would you like?").
    Amazon Lex does not persist session attributes.
    
    If you configure a code hook for the intent, Amazon Lex passes the incoming session attributes to the Lambda function. If you want Amazon Lex to return these session attributes back to the client, the Lambda function must return them.
    
    If there is no code hook configured for the intent, Amazon Lex simply returns the session attributes back to the client application.
    
    The method adds a new key-value pair into sessionAttributes parameter, and returns a reference to this object so that method calls can be chained together.
    Parameters:
    
    key - The key of the entry to be added into sessionAttributes.
    
    value - The corresponding value of the entry to be added into sessionAttributes.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearsessionAttributesEntries
```
public PostTextRequest clearsessionAttributesEntries()
```
    Removes all the entries added into sessionAttributes.
    Returns a reference to this object so that method calls can be chained together.
  - getInputText
```
public String getInputText()
```
    The text that the user entered (Amazon Lex interprets this text).
    
    Constraints:
    Length: 1 - 1024
    
    Returns:
    
    The text that the user entered (Amazon Lex interprets this text).
  - setInputText
```
public void setInputText(String inputText)
```
    The text that the user entered (Amazon Lex interprets this text).
    
    Constraints:
    Length: 1 - 1024
    
    Parameters:
    
    inputText -
    The text that the user entered (Amazon Lex interprets this text).
  - withInputText
```
public PostTextRequest withInputText(String inputText)
```
    The text that the user entered (Amazon Lex interprets this text).
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 1024
    
    Parameters:
    
    inputText -
    The text that the user entered (Amazon Lex interprets this text).
    
    Returns:
    
    A reference to this updated 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()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class PostTextRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

PostTextRequest

Method Detail

getBotName

setBotName

withBotName

getBotAlias

setBotAlias

withBotAlias

getUserId

setUserId

withUserId

getSessionAttributes

setSessionAttributes

withSessionAttributes

addsessionAttributesEntry

clearsessionAttributesEntries

getInputText

setInputText

withInputText

toString

hashCode

equals