GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::LexRuntimeV2::RecognizeText(3) User Contributed Perl Documentation Paws::LexRuntimeV2::RecognizeText(3)

Paws::LexRuntimeV2::RecognizeText - Arguments for method RecognizeText on Paws::LexRuntimeV2

This class represents the parameters used for calling the method RecognizeText on the Amazon Lex Runtime V2 service. Use the attributes of this class as arguments to method RecognizeText.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RecognizeText.

    my $runtime-v2-lex = Paws->service('LexRuntimeV2');
    my $RecognizeTextResponse = $runtime - v2 -lex->RecognizeText(
      BotAliasId        => 'MyBotAliasIdentifier',
      BotId             => 'MyBotIdentifier',
      LocaleId          => 'MyLocaleId',
      SessionId         => 'MySessionId',
      Text              => 'MyText',
      RequestAttributes => {
        'MyNonEmptyString' => 'MyString',    # key: min: 1
      },    # OPTIONAL
      SessionState => {
        ActiveContexts => [
          {
            ContextAttributes => {
              'MyParameterName' =>
                'MyText',    # key: min: 1, max: 100, value: min: 1, max: 1024
            },    # max: 10
            Name       => 'MyActiveContextName',    # min: 1, max: 100
            TimeToLive => {
              TimeToLiveInSeconds => 1,             # min: 5, max: 86400
              TurnsToLive         => 1,             # min: 1, max: 20
            },
          },
          ...
        ],    # max: 20; OPTIONAL
        DialogAction => {
          Type => 'Close'
          ,   # values: Close, ConfirmIntent, Delegate, ElicitIntent, ElicitSlot
          SlotToElicit => 'MyNonEmptyString',    # min: 1
        },    # OPTIONAL
        Intent => {
          Name              => 'MyNonEmptyString',    # min: 1
          ConfirmationState =>
            'Confirmed',    # values: Confirmed, Denied, None; OPTIONAL
          Slots => {
            'MyNonEmptyString' => {
              Shape => 'Scalar',    # values: Scalar, List; OPTIONAL
              Value => {
                InterpretedValue => 'MyNonEmptyString',    # min: 1
                OriginalValue    => 'MyNonEmptyString',    # min: 1
                ResolvedValues   => [
                  'MyNonEmptyString', ...                  # min: 1
                ],    # OPTIONAL
              },    # OPTIONAL
              Values => [ <Slot>, ... ],    # OPTIONAL
            },    # key: min: 1
          },    # OPTIONAL
          State => 'Failed'
          , # values: Failed, Fulfilled, InProgress, ReadyForFulfillment, Waiting; OPTIONAL
        },    # OPTIONAL
        OriginatingRequestId => 'MyNonEmptyString',    # min: 1
        SessionAttributes    => {
          'MyNonEmptyString' => 'MyString',            # key: min: 1
        },
      },    # OPTIONAL
    );
    # Results:
    my $Interpretations   = $RecognizeTextResponse->Interpretations;
    my $Messages          = $RecognizeTextResponse->Messages;
    my $RequestAttributes = $RecognizeTextResponse->RequestAttributes;
    my $SessionId         = $RecognizeTextResponse->SessionId;
    my $SessionState      = $RecognizeTextResponse->SessionState;
    # Returns a L<Paws::LexRuntimeV2::RecognizeTextResponse> object.

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. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/runtime-v2-lex/RecognizeText>

REQUIRED BotAliasId => Str

The alias identifier in use for the bot that processes the request.

REQUIRED BotId => Str

The identifier of the bot that processes the request.

REQUIRED LocaleId => Str

The locale where the session is in use.

Request-specific information passed between the client application and Amazon Lex V2

The namespace "x-amz-lex:" is reserved for special attributes. Don't create any request attributes with the prefix "x-amz-lex:".

REQUIRED SessionId => Str

The identifier of the user session that is having the conversation.

The current state of the dialog between the user and the bot.

REQUIRED Text => Str

The text that the user entered. Amazon Lex V2 interprets this text.

This class forms part of Paws, documenting arguments for method RecognizeText in Paws::LexRuntimeV2

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>

2022-06-01 perl v5.40.2

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.