| 1 | |||
| 2 | package Paws::LexRuntime::PostTextResponse; | ||
| 3 | use Moose; | ||
| 4 | has ActiveContexts => (is => 'ro', isa => 'ArrayRef[Paws::LexRuntime::ActiveContext]', traits => ['NameInRequest'], request_name => 'activeContexts'); | ||
| 5 | has AlternativeIntents => (is => 'ro', isa => 'ArrayRef[Paws::LexRuntime::PredictedIntent]', traits => ['NameInRequest'], request_name => 'alternativeIntents'); | ||
| 6 | has BotVersion => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'botVersion'); | ||
| 7 | has DialogState => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'dialogState'); | ||
| 8 | has IntentName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'intentName'); | ||
| 9 | has Message => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'message'); | ||
| 10 | has MessageFormat => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'messageFormat'); | ||
| 11 | has NluIntentConfidence => (is => 'ro', isa => 'Paws::LexRuntime::IntentConfidence', traits => ['NameInRequest'], request_name => 'nluIntentConfidence'); | ||
| 12 | has ResponseCard => (is => 'ro', isa => 'Paws::LexRuntime::ResponseCard', traits => ['NameInRequest'], request_name => 'responseCard'); | ||
| 13 | has SentimentResponse => (is => 'ro', isa => 'Paws::LexRuntime::SentimentResponse', traits => ['NameInRequest'], request_name => 'sentimentResponse'); | ||
| 14 | has SessionAttributes => (is => 'ro', isa => 'Paws::LexRuntime::StringMap', traits => ['NameInRequest'], request_name => 'sessionAttributes'); | ||
| 15 | has SessionId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'sessionId'); | ||
| 16 | has Slots => (is => 'ro', isa => 'Paws::LexRuntime::StringMap', traits => ['NameInRequest'], request_name => 'slots'); | ||
| 17 | has SlotToElicit => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'slotToElicit'); | ||
| 18 | |||
| 19 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::LexRuntime::PostTextResponse | ||
| 27 | |||
| 28 | =head1 ATTRIBUTES | ||
| 29 | |||
| 30 | |||
| 31 | =head2 ActiveContexts => ArrayRef[L<Paws::LexRuntime::ActiveContext>] | ||
| 32 | |||
| 33 | A list of active contexts for the session. A context can be set when an | ||
| 34 | intent is fulfilled or by calling the C<PostContent>, C<PostText>, or | ||
| 35 | C<PutSession> operation. | ||
| 36 | |||
| 37 | You can use a context to control the intents that can follow up an | ||
| 38 | intent, or to modify the operation of your application. | ||
| 39 | |||
| 40 | |||
| 41 | =head2 AlternativeIntents => ArrayRef[L<Paws::LexRuntime::PredictedIntent>] | ||
| 42 | |||
| 43 | One to four alternative intents that may be applicable to the user's | ||
| 44 | intent. | ||
| 45 | |||
| 46 | Each alternative includes a score that indicates how confident Amazon | ||
| 47 | Lex is that the intent matches the user's intent. The intents are | ||
| 48 | sorted by the confidence score. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 BotVersion => Str | ||
| 52 | |||
| 53 | The version of the bot that responded to the conversation. You can use | ||
| 54 | this information to help determine if one version of a bot is | ||
| 55 | performing better than another version. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 DialogState => Str | ||
| 59 | |||
| 60 | Identifies the current state of the user interaction. Amazon Lex | ||
| 61 | returns one of the following values as C<dialogState>. The client can | ||
| 62 | optionally use this information to customize the user interface. | ||
| 63 | |||
| 64 | =over | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | C<ElicitIntent> - Amazon Lex wants to elicit user intent. | ||
| 69 | |||
| 70 | For example, a user might utter an intent ("I want to order a pizza"). | ||
| 71 | If Amazon Lex cannot infer the user intent from this utterance, it will | ||
| 72 | return this dialogState. | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | C<ConfirmIntent> - Amazon Lex is expecting a "yes" or "no" response. | ||
| 77 | |||
| 78 | For example, Amazon Lex wants user confirmation before fulfilling an | ||
| 79 | intent. | ||
| 80 | |||
| 81 | Instead of a simple "yes" or "no," a user might respond with additional | ||
| 82 | information. For example, "yes, but make it thick crust pizza" or "no, | ||
| 83 | I want to order a drink". Amazon Lex can process such additional | ||
| 84 | information (in these examples, update the crust type slot value, or | ||
| 85 | change intent from OrderPizza to OrderDrink). | ||
| 86 | |||
| 87 | =item * | ||
| 88 | |||
| 89 | C<ElicitSlot> - Amazon Lex is expecting a slot value for the current | ||
| 90 | intent. | ||
| 91 | |||
| 92 | For example, suppose that in the response Amazon Lex sends this | ||
| 93 | message: "What size pizza would you like?". A user might reply with the | ||
| 94 | slot value (e.g., "medium"). The user might also provide additional | ||
| 95 | information in the response (e.g., "medium thick crust pizza"). Amazon | ||
| 96 | Lex can process such additional information appropriately. | ||
| 97 | |||
| 98 | =item * | ||
| 99 | |||
| 100 | C<Fulfilled> - Conveys that the Lambda function configured for the | ||
| 101 | intent has successfully fulfilled the intent. | ||
| 102 | |||
| 103 | =item * | ||
| 104 | |||
| 105 | C<ReadyForFulfillment> - Conveys that the client has to fulfill the | ||
| 106 | intent. | ||
| 107 | |||
| 108 | =item * | ||
| 109 | |||
| 110 | C<Failed> - Conveys that the conversation with the user failed. | ||
| 111 | |||
| 112 | This can happen for various reasons including that the user did not | ||
| 113 | provide an appropriate response to prompts from the service (you can | ||
| 114 | configure how many times Amazon Lex can prompt a user for specific | ||
| 115 | information), or the Lambda function failed to fulfill the intent. | ||
| 116 | |||
| 117 | =back | ||
| 118 | |||
| 119 | |||
| 120 | Valid values are: C<"ElicitIntent">, C<"ConfirmIntent">, C<"ElicitSlot">, C<"Fulfilled">, C<"ReadyForFulfillment">, C<"Failed"> | ||
| 121 | =head2 IntentName => Str | ||
| 122 | |||
| 123 | The current user intent that Amazon Lex is aware of. | ||
| 124 | |||
| 125 | |||
| 126 | =head2 Message => Str | ||
| 127 | |||
| 128 | The message to convey to the user. The message can come from the bot's | ||
| 129 | configuration or from a Lambda function. | ||
| 130 | |||
| 131 | If the intent is not configured with a Lambda function, or if the | ||
| 132 | Lambda function returned C<Delegate> as the C<dialogAction.type> its | ||
| 133 | response, Amazon Lex decides on the next course of action and selects | ||
| 134 | an appropriate message from the bot's configuration based on the | ||
| 135 | current interaction context. For example, if Amazon Lex isn't able to | ||
| 136 | understand user input, it uses a clarification prompt message. | ||
| 137 | |||
| 138 | When you create an intent you can assign messages to groups. When | ||
| 139 | messages are assigned to groups Amazon Lex returns one message from | ||
| 140 | each group in the response. The message field is an escaped JSON string | ||
| 141 | containing the messages. For more information about the structure of | ||
| 142 | the JSON string returned, see msg-prompts-formats. | ||
| 143 | |||
| 144 | If the Lambda function returns a message, Amazon Lex passes it to the | ||
| 145 | client in its response. | ||
| 146 | |||
| 147 | |||
| 148 | =head2 MessageFormat => Str | ||
| 149 | |||
| 150 | The format of the response message. One of the following values: | ||
| 151 | |||
| 152 | =over | ||
| 153 | |||
| 154 | =item * | ||
| 155 | |||
| 156 | C<PlainText> - The message contains plain UTF-8 text. | ||
| 157 | |||
| 158 | =item * | ||
| 159 | |||
| 160 | C<CustomPayload> - The message is a custom format defined by the Lambda | ||
| 161 | function. | ||
| 162 | |||
| 163 | =item * | ||
| 164 | |||
| 165 | C<SSML> - The message contains text formatted for voice output. | ||
| 166 | |||
| 167 | =item * | ||
| 168 | |||
| 169 | C<Composite> - The message contains an escaped JSON object containing | ||
| 170 | one or more messages from the groups that messages were assigned to | ||
| 171 | when the intent was created. | ||
| 172 | |||
| 173 | =back | ||
| 174 | |||
| 175 | |||
| 176 | Valid values are: C<"PlainText">, C<"CustomPayload">, C<"SSML">, C<"Composite"> | ||
| 177 | =head2 NluIntentConfidence => L<Paws::LexRuntime::IntentConfidence> | ||
| 178 | |||
| 179 | Provides a score that indicates how confident Amazon Lex is that the | ||
| 180 | returned intent is the one that matches the user's intent. The score is | ||
| 181 | between 0.0 and 1.0. For more information, see Confidence Scores | ||
| 182 | (https://docs.aws.amazon.com/lex/latest/dg/confidence-scores.html). | ||
| 183 | |||
| 184 | The score is a relative score, not an absolute score. The score may | ||
| 185 | change based on improvements to Amazon Lex. | ||
| 186 | |||
| 187 | |||
| 188 | =head2 ResponseCard => L<Paws::LexRuntime::ResponseCard> | ||
| 189 | |||
| 190 | Represents the options that the user has to respond to the current | ||
| 191 | prompt. Response Card can come from the bot configuration (in the | ||
| 192 | Amazon Lex console, choose the settings button next to a slot) or from | ||
| 193 | a code hook (Lambda function). | ||
| 194 | |||
| 195 | |||
| 196 | =head2 SentimentResponse => L<Paws::LexRuntime::SentimentResponse> | ||
| 197 | |||
| 198 | The sentiment expressed in and utterance. | ||
| 199 | |||
| 200 | When the bot is configured to send utterances to Amazon Comprehend for | ||
| 201 | sentiment analysis, this field contains the result of the analysis. | ||
| 202 | |||
| 203 | |||
| 204 | =head2 SessionAttributes => L<Paws::LexRuntime::StringMap> | ||
| 205 | |||
| 206 | A map of key-value pairs representing the session-specific context | ||
| 207 | information. | ||
| 208 | |||
| 209 | |||
| 210 | =head2 SessionId => Str | ||
| 211 | |||
| 212 | A unique identifier for the session. | ||
| 213 | |||
| 214 | |||
| 215 | =head2 Slots => L<Paws::LexRuntime::StringMap> | ||
| 216 | |||
| 217 | The intent slots that Amazon Lex detected from the user input in the | ||
| 218 | conversation. | ||
| 219 | |||
| 220 | Amazon Lex creates a resolution list containing likely values for a | ||
| 221 | slot. The value that it returns is determined by the | ||
| 222 | C<valueSelectionStrategy> selected when the slot type was created or | ||
| 223 | updated. If C<valueSelectionStrategy> is set to C<ORIGINAL_VALUE>, the | ||
| 224 | value provided by the user is returned, if the user value is similar to | ||
| 225 | the slot values. If C<valueSelectionStrategy> is set to | ||
| 226 | C<TOP_RESOLUTION> Amazon Lex returns the first value in the resolution | ||
| 227 | list or, if there is no resolution list, null. If you don't specify a | ||
| 228 | C<valueSelectionStrategy>, the default is C<ORIGINAL_VALUE>. | ||
| 229 | |||
| 230 | |||
| 231 | =head2 SlotToElicit => Str | ||
| 232 | |||
| 233 | If the C<dialogState> value is C<ElicitSlot>, returns the name of the | ||
| 234 | slot for which Amazon Lex is eliciting a value. | ||
| 235 | |||
| 236 | |||
| 237 | =head2 _request_id => Str | ||
| 238 | |||
| 239 | |||
| 240 | =cut | ||
| 241 |