« blib/lib/Paws/LexRuntimeV2/StartConversation.pm
↑ Summary
blib/lib/Paws/LexRuntimeV2/StartConversationResponse.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::LexRuntimeV2::StartConversationRequestEventStream; | ||
| 3 | use Moose; | ||
| 4 | has AudioInputEvent => (is => 'ro', isa => 'Paws::LexRuntimeV2::AudioInputEvent'); | ||
| 5 | has ConfigurationEvent => (is => 'ro', isa => 'Paws::LexRuntimeV2::ConfigurationEvent'); | ||
| 6 | has DisconnectionEvent => (is => 'ro', isa => 'Paws::LexRuntimeV2::DisconnectionEvent'); | ||
| 7 | has DTMFInputEvent => (is => 'ro', isa => 'Paws::LexRuntimeV2::DTMFInputEvent'); | ||
| 8 | has PlaybackCompletionEvent => (is => 'ro', isa => 'Paws::LexRuntimeV2::PlaybackCompletionEvent'); | ||
| 9 | has TextInputEvent => (is => 'ro', isa => 'Paws::LexRuntimeV2::TextInputEvent'); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::LexRuntimeV2::StartConversationRequestEventStream | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::LexRuntimeV2::StartConversationRequestEventStream object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { AudioInputEvent => $value, ..., TextInputEvent => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::LexRuntimeV2::StartConversationRequestEventStream object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->AudioInputEvent | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | Represents a stream of events between your application and Amazon Lex | ||
| 42 | V2. | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 AudioInputEvent => L<Paws::LexRuntimeV2::AudioInputEvent> | ||
| 48 | |||
| 49 | Speech audio sent from your client application to Amazon Lex V2. Audio | ||
| 50 | starts accumulating when Amazon Lex V2 identifies a voice and continues | ||
| 51 | until a natural pause in the speech is found before processing. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 ConfigurationEvent => L<Paws::LexRuntimeV2::ConfigurationEvent> | ||
| 55 | |||
| 56 | Configuration information sent from your client application to Amazon | ||
| 57 | Lex V2 | ||
| 58 | |||
| 59 | |||
| 60 | =head2 DisconnectionEvent => L<Paws::LexRuntimeV2::DisconnectionEvent> | ||
| 61 | |||
| 62 | Event sent from the client application to indicate to Amazon Lex V2 | ||
| 63 | that the conversation is over. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 DTMFInputEvent => L<Paws::LexRuntimeV2::DTMFInputEvent> | ||
| 67 | |||
| 68 | DTMF information sent to Amazon Lex V2 by your application. Amazon Lex | ||
| 69 | V2 accumulates the DMTF information from when the user sends the first | ||
| 70 | character and ends | ||
| 71 | |||
| 72 | =over | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | when there's a pause longer that the value configured for the end | ||
| 77 | timeout. | ||
| 78 | |||
| 79 | =item * | ||
| 80 | |||
| 81 | when there's a digit that is the configured end character. | ||
| 82 | |||
| 83 | =item * | ||
| 84 | |||
| 85 | when Amazon Lex V2 accumulates characters equal to the maximum DTMF | ||
| 86 | character configuration. | ||
| 87 | |||
| 88 | =back | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 PlaybackCompletionEvent => L<Paws::LexRuntimeV2::PlaybackCompletionEvent> | ||
| 93 | |||
| 94 | Event sent from the client application to Amazon Lex V2 to indicate | ||
| 95 | that it has finished playing audio and that Amazon Lex V2 should start | ||
| 96 | listening for user input. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 TextInputEvent => L<Paws::LexRuntimeV2::TextInputEvent> | ||
| 100 | |||
| 101 | Text sent from your client application to Amazon Lex V2. Each | ||
| 102 | C<TextInputEvent> is processed individually. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head1 SEE ALSO | ||
| 107 | |||
| 108 | This class forms part of L<Paws>, describing an object used in L<Paws::LexRuntimeV2> | ||
| 109 | |||
| 110 | =head1 BUGS and CONTRIBUTIONS | ||
| 111 | |||
| 112 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 113 | |||
| 114 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 115 | |||
| 116 | =cut | ||
| 117 |