« blib/lib/Paws/LexRuntimeV2/PutSessionResponse.pm
↑ Summary
blib/lib/Paws/LexRuntimeV2/RecognizeTextResponse.pm »
| 1 | |||
| 2 | package Paws::LexRuntimeV2::RecognizeText; | ||
| 3 | use Moose; | ||
| 4 | has BotAliasId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'botAliasId', required => 1); | ||
| 5 | has BotId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'botId', required => 1); | ||
| 6 | has LocaleId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'localeId', required => 1); | ||
| 7 | has RequestAttributes => (is => 'ro', isa => 'Paws::LexRuntimeV2::StringMap', traits => ['NameInRequest'], request_name => 'requestAttributes'); | ||
| 8 | has SessionId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'sessionId', required => 1); | ||
| 9 | has SessionState => (is => 'ro', isa => 'Paws::LexRuntimeV2::SessionState', traits => ['NameInRequest'], request_name => 'sessionState'); | ||
| 10 | has Text => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'text', required => 1); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'RecognizeText'); | ||
| 15 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/bots/{botId}/botAliases/{botAliasId}/botLocales/{localeId}/sessions/{sessionId}/text'); | ||
| 16 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LexRuntimeV2::RecognizeTextResponse'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::LexRuntimeV2::RecognizeText - Arguments for method RecognizeText on L<Paws::LexRuntimeV2> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method RecognizeText on the | ||
| 29 | L<Amazon Lex Runtime V2|Paws::LexRuntimeV2> service. Use the attributes of this class | ||
| 30 | as arguments to method RecognizeText. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RecognizeText. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $runtime-v2-lex = Paws->service('LexRuntimeV2'); | ||
| 37 | my $RecognizeTextResponse = $runtime - v2 -lex->RecognizeText( | ||
| 38 | BotAliasId => 'MyBotAliasIdentifier', | ||
| 39 | BotId => 'MyBotIdentifier', | ||
| 40 | LocaleId => 'MyLocaleId', | ||
| 41 | SessionId => 'MySessionId', | ||
| 42 | Text => 'MyText', | ||
| 43 | RequestAttributes => { | ||
| 44 | 'MyNonEmptyString' => 'MyString', # key: min: 1 | ||
| 45 | }, # OPTIONAL | ||
| 46 | SessionState => { | ||
| 47 | ActiveContexts => [ | ||
| 48 | { | ||
| 49 | ContextAttributes => { | ||
| 50 | 'MyParameterName' => | ||
| 51 | 'MyText', # key: min: 1, max: 100, value: min: 1, max: 1024 | ||
| 52 | }, # max: 10 | ||
| 53 | Name => 'MyActiveContextName', # min: 1, max: 100 | ||
| 54 | TimeToLive => { | ||
| 55 | TimeToLiveInSeconds => 1, # min: 5, max: 86400 | ||
| 56 | TurnsToLive => 1, # min: 1, max: 20 | ||
| 57 | |||
| 58 | }, | ||
| 59 | |||
| 60 | }, | ||
| 61 | ... | ||
| 62 | ], # max: 20; OPTIONAL | ||
| 63 | DialogAction => { | ||
| 64 | Type => 'Close' | ||
| 65 | , # values: Close, ConfirmIntent, Delegate, ElicitIntent, ElicitSlot | ||
| 66 | SlotToElicit => 'MyNonEmptyString', # min: 1 | ||
| 67 | }, # OPTIONAL | ||
| 68 | Intent => { | ||
| 69 | Name => 'MyNonEmptyString', # min: 1 | ||
| 70 | ConfirmationState => | ||
| 71 | 'Confirmed', # values: Confirmed, Denied, None; OPTIONAL | ||
| 72 | Slots => { | ||
| 73 | 'MyNonEmptyString' => { | ||
| 74 | Shape => 'Scalar', # values: Scalar, List; OPTIONAL | ||
| 75 | Value => { | ||
| 76 | InterpretedValue => 'MyNonEmptyString', # min: 1 | ||
| 77 | OriginalValue => 'MyNonEmptyString', # min: 1 | ||
| 78 | ResolvedValues => [ | ||
| 79 | 'MyNonEmptyString', ... # min: 1 | ||
| 80 | ], # OPTIONAL | ||
| 81 | }, # OPTIONAL | ||
| 82 | Values => [ <Slot>, ... ], # OPTIONAL | ||
| 83 | }, # key: min: 1 | ||
| 84 | }, # OPTIONAL | ||
| 85 | State => 'Failed' | ||
| 86 | , # values: Failed, Fulfilled, InProgress, ReadyForFulfillment, Waiting; OPTIONAL | ||
| 87 | }, # OPTIONAL | ||
| 88 | OriginatingRequestId => 'MyNonEmptyString', # min: 1 | ||
| 89 | SessionAttributes => { | ||
| 90 | 'MyNonEmptyString' => 'MyString', # key: min: 1 | ||
| 91 | }, | ||
| 92 | }, # OPTIONAL | ||
| 93 | ); | ||
| 94 | |||
| 95 | # Results: | ||
| 96 | my $Interpretations = $RecognizeTextResponse->Interpretations; | ||
| 97 | my $Messages = $RecognizeTextResponse->Messages; | ||
| 98 | my $RequestAttributes = $RecognizeTextResponse->RequestAttributes; | ||
| 99 | my $SessionId = $RecognizeTextResponse->SessionId; | ||
| 100 | my $SessionState = $RecognizeTextResponse->SessionState; | ||
| 101 | |||
| 102 | # Returns a L<Paws::LexRuntimeV2::RecognizeTextResponse> object. | ||
| 103 | |||
| 104 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 105 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/runtime-v2-lex/RecognizeText> | ||
| 106 | |||
| 107 | =head1 ATTRIBUTES | ||
| 108 | |||
| 109 | |||
| 110 | =head2 B<REQUIRED> BotAliasId => Str | ||
| 111 | |||
| 112 | The alias identifier in use for the bot that processes the request. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 B<REQUIRED> BotId => Str | ||
| 117 | |||
| 118 | The identifier of the bot that processes the request. | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | =head2 B<REQUIRED> LocaleId => Str | ||
| 123 | |||
| 124 | The locale where the session is in use. | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head2 RequestAttributes => L<Paws::LexRuntimeV2::StringMap> | ||
| 129 | |||
| 130 | Request-specific information passed between the client application and | ||
| 131 | Amazon Lex V2 | ||
| 132 | |||
| 133 | The namespace C<x-amz-lex:> is reserved for special attributes. Don't | ||
| 134 | create any request attributes with the prefix C<x-amz-lex:>. | ||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | =head2 B<REQUIRED> SessionId => Str | ||
| 139 | |||
| 140 | The identifier of the user session that is having the conversation. | ||
| 141 | |||
| 142 | |||
| 143 | |||
| 144 | =head2 SessionState => L<Paws::LexRuntimeV2::SessionState> | ||
| 145 | |||
| 146 | The current state of the dialog between the user and the bot. | ||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | =head2 B<REQUIRED> Text => Str | ||
| 151 | |||
| 152 | The text that the user entered. Amazon Lex V2 interprets this text. | ||
| 153 | |||
| 154 | |||
| 155 | |||
| 156 | |||
| 157 | =head1 SEE ALSO | ||
| 158 | |||
| 159 | This class forms part of L<Paws>, documenting arguments for method RecognizeText in L<Paws::LexRuntimeV2> | ||
| 160 | |||
| 161 | =head1 BUGS and CONTRIBUTIONS | ||
| 162 | |||
| 163 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 164 | |||
| 165 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 166 | |||
| 167 | =cut | ||
| 168 |