« blib/lib/Paws/LexRuntimeV2/RecognizeUtterance.pm
↑ Summary
blib/lib/Paws/LexRuntimeV2/ResourceNotFoundException.pm »
| 1 | |||
| 2 | package Paws::LexRuntimeV2::RecognizeUtteranceResponse; | ||
| 3 | use Moose; | ||
| 4 | has AudioStream => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'audioStream'); | ||
| 5 | has ContentType => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'Content-Type'); | ||
| 6 | has InputMode => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-lex-input-mode'); | ||
| 7 | has InputTranscript => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-lex-input-transcript'); | ||
| 8 | has Interpretations => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-lex-interpretations'); | ||
| 9 | has Messages => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-lex-messages'); | ||
| 10 | has RequestAttributes => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-lex-request-attributes'); | ||
| 11 | has SessionId => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-lex-session-id'); | ||
| 12 | has SessionState => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-lex-session-state'); | ||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | class_has _stream_param => (is => 'ro', default => 'AudioStream'); | ||
| 15 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::LexRuntimeV2::RecognizeUtteranceResponse | ||
| 23 | |||
| 24 | =head1 ATTRIBUTES | ||
| 25 | |||
| 26 | |||
| 27 | =head2 AudioStream => Str | ||
| 28 | |||
| 29 | The prompt or statement to send to the user. This is based on the bot | ||
| 30 | configuration and context. For example, if Amazon Lex V2 did not | ||
| 31 | understand the user intent, it sends the C<clarificationPrompt> | ||
| 32 | configured for the bot. If the intent requires confirmation before | ||
| 33 | taking the fulfillment action, it sends the C<confirmationPrompt>. | ||
| 34 | Another example: Suppose that the Lambda function successfully | ||
| 35 | fulfilled the intent, and sent a message to convey to the user. Then | ||
| 36 | Amazon Lex V2 sends that message in the response. | ||
| 37 | |||
| 38 | |||
| 39 | =head2 ContentType => Str | ||
| 40 | |||
| 41 | Content type as specified in the C<responseContentType> in the request. | ||
| 42 | |||
| 43 | |||
| 44 | =head2 InputMode => Str | ||
| 45 | |||
| 46 | Indicates whether the input mode to the operation was text or speech. | ||
| 47 | |||
| 48 | |||
| 49 | =head2 InputTranscript => Str | ||
| 50 | |||
| 51 | The text used to process the request. | ||
| 52 | |||
| 53 | If the input was an audio stream, the C<inputTranscript> field contains | ||
| 54 | the text extracted from the audio stream. This is the text that is | ||
| 55 | actually processed to recognize intents and slot values. You can use | ||
| 56 | this information to determine if Amazon Lex V2 is correctly processing | ||
| 57 | the audio that you send. | ||
| 58 | |||
| 59 | The C<inputTranscript> field is compressed with gzip and then base64 | ||
| 60 | encoded. Before you can use the contents of the field, you must decode | ||
| 61 | and decompress the contents. See the example for a simple function to | ||
| 62 | decode and decompress the contents. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 Interpretations => Str | ||
| 66 | |||
| 67 | A list of intents that Amazon Lex V2 determined might satisfy the | ||
| 68 | user's utterance. | ||
| 69 | |||
| 70 | Each interpretation includes the intent, a score that indicates how | ||
| 71 | confident Amazon Lex V2 is that the interpretation is the correct one, | ||
| 72 | and an optional sentiment response that indicates the sentiment | ||
| 73 | expressed in the utterance. | ||
| 74 | |||
| 75 | The C<interpretations> field is compressed with gzip and then base64 | ||
| 76 | encoded. Before you can use the contents of the field, you must decode | ||
| 77 | and decompress the contents. See the example for a simple function to | ||
| 78 | decode and decompress the contents. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 Messages => Str | ||
| 82 | |||
| 83 | A list of messages that were last sent to the user. The messages are | ||
| 84 | ordered based on the order that you returned the messages from your | ||
| 85 | Lambda function or the order that the messages are defined in the bot. | ||
| 86 | |||
| 87 | The C<messages> field is compressed with gzip and then base64 encoded. | ||
| 88 | Before you can use the contents of the field, you must decode and | ||
| 89 | decompress the contents. See the example for a simple function to | ||
| 90 | decode and decompress the contents. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 RequestAttributes => Str | ||
| 94 | |||
| 95 | The attributes sent in the request. | ||
| 96 | |||
| 97 | The C<requestAttributes> field is compressed with gzip and then base64 | ||
| 98 | encoded. Before you can use the contents of the field, you must decode | ||
| 99 | and decompress the contents. | ||
| 100 | |||
| 101 | |||
| 102 | =head2 SessionId => Str | ||
| 103 | |||
| 104 | The identifier of the session in use. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 SessionState => Str | ||
| 108 | |||
| 109 | Represents the current state of the dialog between the user and the | ||
| 110 | bot. | ||
| 111 | |||
| 112 | Use this to determine the progress of the conversation and what the | ||
| 113 | next action might be. | ||
| 114 | |||
| 115 | The C<sessionState> field is compressed with gzip and then base64 | ||
| 116 | encoded. Before you can use the contents of the field, you must decode | ||
| 117 | and decompress the contents. See the example for a simple function to | ||
| 118 | decode and decompress the contents. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 _request_id => Str | ||
| 122 | |||
| 123 | |||
| 124 | =cut | ||
| 125 |