/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::LexRuntimeV2::RecognizeUtterance

NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $runtime-v2-lex = Paws->service('LexRuntimeV2');
my $RecognizeUtteranceResponse = $runtime - v2 -lex->RecognizeUtterance(
  BotAliasId          => 'MyBotAliasIdentifier',
  BotId               => 'MyBotIdentifier',
  LocaleId            => 'MyLocaleId',
  RequestContentType  => 'MyNonEmptyString',
  SessionId           => 'MySessionId',
  InputStream         => 'BlobBlobStream',               # OPTIONAL
  RequestAttributes   => 'MySensitiveNonEmptyString',    # OPTIONAL
  ResponseContentType => 'MyNonEmptyString',             # OPTIONAL
  SessionState        => 'MySensitiveNonEmptyString',    # OPTIONAL
);

# Results:
my $AudioStream       = $RecognizeUtteranceResponse->AudioStream;
my $ContentType       = $RecognizeUtteranceResponse->ContentType;
my $InputMode         = $RecognizeUtteranceResponse->InputMode;
my $InputTranscript   = $RecognizeUtteranceResponse->InputTranscript;
my $Interpretations   = $RecognizeUtteranceResponse->Interpretations;
my $Messages          = $RecognizeUtteranceResponse->Messages;
my $RequestAttributes = $RecognizeUtteranceResponse->RequestAttributes;
my $SessionId         = $RecognizeUtteranceResponse->SessionId;
my $SessionState      = $RecognizeUtteranceResponse->SessionState;

# Returns a L<Paws::LexRuntimeV2::RecognizeUtteranceResponse> 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/RecognizeUtterance

ATTRIBUTES

REQUIRED BotAliasId => Str

The alias identifier in use for the bot that should receive the request.

REQUIRED BotId => Str

The identifier of the bot that should receive the request.

InputStream => Str

User input in PCM or Opus audio format or text format as described in the requestContentType parameter.

REQUIRED LocaleId => Str

The locale where the session is in use.

RequestAttributes => Str

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 for prefix x-amz-lex:.

The requestAttributes field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.

REQUIRED RequestContentType => Str

Indicates the format for audio input or that the content is text. The header must start with one of the following prefixes:

  • PCM format, audio data must be in little-endian byte order.

    • audio/l16; rate=16000; channels=1

    • audio/x-l16; sample-rate=16000; channel-count=1

    • audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false

  • Opus format

    • audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4

  • Text format

    • text/plain; charset=utf-8

ResponseContentType => Str

The message that Amazon Lex V2 returns in the response can be either text or speech based on the responseContentType value.

  • If the value is text/plain;charset=utf-8, Amazon Lex V2 returns text in the response.

  • If the value begins with audio/, Amazon Lex V2 returns speech in the response. Amazon Lex V2 uses Amazon Polly to generate the speech using the configuration that you specified in the requestContentType parameter. For example, if you specify audio/mpeg as the value, Amazon Lex V2 returns speech in the MPEG format.

  • If the value is audio/pcm, the speech returned is audio/pcm at 16 KHz in 16-bit, little-endian format.

  • The following are the accepted values:

    • audio/mpeg

    • audio/ogg

    • audio/pcm (16 KHz)

    • audio/* (defaults to mpeg)

    • text/plain; charset=utf-8

REQUIRED SessionId => Str

The identifier of the session in use.

SessionState => Str

Sets the state of the session with the user. You can use this to set the current intent, attributes, context, and dialog action. Use the dialog action to determine the next step that Amazon Lex V2 should use in the conversation with the user.

The sessionState field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.

SEE ALSO

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

BUGS and CONTRIBUTIONS

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