Skip to content

/AWS1/IF_LR2=>RECOGNIZEUTTERANCE()

About RecognizeUtterance

Sends user input to Amazon Lex V2. You can send text or speech. Clients use this API to send text and audio requests to Amazon Lex V2 at runtime. Amazon Lex V2 interprets the user input using the machine learning model built for the bot.

The following request fields must be compressed with gzip and then base64 encoded before you send them to Amazon Lex V2.

  • requestAttributes

  • sessionState

The following response fields are compressed using gzip and then base64 encoded by Amazon Lex V2. Before you can use these fields, you must decode and decompress them.

  • inputTranscript

  • interpretations

  • messages

  • requestAttributes

  • sessionState

The example contains a Java application that compresses and encodes a Java object to send to Amazon Lex V2, and a second that decodes and decompresses a response from Amazon Lex V2.

If the optional post-fulfillment response is specified, the messages are returned as follows. For more information, see PostFulfillmentStatusSpecification.

  • Success message - Returned if the Lambda function completes successfully and the intent state is fulfilled or ready fulfillment if the message is present.

  • Failed message - The failed message is returned if the Lambda function throws an exception or if the Lambda function returns a failed intent state without a message.

  • Timeout message - If you don't configure a timeout message and a timeout, and the Lambda function doesn't return within 30 seconds, the timeout message is returned. If you configure a timeout, the timeout message is returned when the period times out.

For more information, see Completion message.

Method Signature

METHODS /AWS1/IF_LR2~RECOGNIZEUTTERANCE
  IMPORTING
    !IV_BOTID TYPE /AWS1/LR2BOTIDENTIFIER OPTIONAL
    !IV_BOTALIASID TYPE /AWS1/LR2BOTALIASIDENTIFIER OPTIONAL
    !IV_LOCALEID TYPE /AWS1/LR2LOCALEID OPTIONAL
    !IV_SESSIONID TYPE /AWS1/LR2SESSIONID OPTIONAL
    !IV_SESSIONSTATE TYPE /AWS1/LR2SENSITIVENONEMPTYSTR OPTIONAL
    !IV_REQUESTATTRIBUTES TYPE /AWS1/LR2SENSITIVENONEMPTYSTR OPTIONAL
    !IV_REQUESTCONTENTTYPE TYPE /AWS1/LR2NONEMPTYSTRING OPTIONAL
    !IV_RESPONSECONTENTTYPE TYPE /AWS1/LR2NONEMPTYSTRING OPTIONAL
    !IV_INPUTSTREAM TYPE /AWS1/LR2BLOBSTREAM OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lr2recognizeutteran01
  RAISING
    /AWS1/CX_LR2ACCESSDENIEDEX
    /AWS1/CX_LR2BADGATEWAYEX
    /AWS1/CX_LR2CONFLICTEXCEPTION
    /AWS1/CX_LR2DEPENDENCYFAILEDEX
    /AWS1/CX_LR2INTERNALSERVEREX
    /AWS1/CX_LR2RESOURCENOTFOUNDEX
    /AWS1/CX_LR2THROTTLINGEX
    /AWS1/CX_LR2VALIDATIONEX
    /AWS1/CX_LR2CLIENTEXC
    /AWS1/CX_LR2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_botid TYPE /AWS1/LR2BOTIDENTIFIER /AWS1/LR2BOTIDENTIFIER

The identifier of the bot that should receive the request.

iv_botaliasid TYPE /AWS1/LR2BOTALIASIDENTIFIER /AWS1/LR2BOTALIASIDENTIFIER

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

iv_localeid TYPE /AWS1/LR2LOCALEID /AWS1/LR2LOCALEID

The locale where the session is in use.

iv_sessionid TYPE /AWS1/LR2SESSIONID /AWS1/LR2SESSIONID

The identifier of the session in use.

iv_requestcontenttype TYPE /AWS1/LR2NONEMPTYSTRING /AWS1/LR2NONEMPTYSTRING

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

Optional arguments:

iv_sessionstate TYPE /AWS1/LR2SENSITIVENONEMPTYSTR /AWS1/LR2SENSITIVENONEMPTYSTR

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.

iv_requestattributes TYPE /AWS1/LR2SENSITIVENONEMPTYSTR /AWS1/LR2SENSITIVENONEMPTYSTR

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.

iv_responsecontenttype TYPE /AWS1/LR2NONEMPTYSTRING /AWS1/LR2NONEMPTYSTRING

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 responseContentType 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

iv_inputstream TYPE /AWS1/LR2BLOBSTREAM /AWS1/LR2BLOBSTREAM

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

RETURNING

oo_output TYPE REF TO /aws1/cl_lr2recognizeutteran01 /AWS1/CL_LR2RECOGNIZEUTTERAN01

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->recognizeutterance(
  iv_botaliasid = |string|
  iv_botid = |string|
  iv_inputstream = '5347567362473873563239796247513D'
  iv_localeid = |string|
  iv_requestattributes = |string|
  iv_requestcontenttype = |string|
  iv_responsecontenttype = |string|
  iv_sessionid = |string|
  iv_sessionstate = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_nonemptystring = lo_result->get_inputmode( ).
  lv_nonemptystring = lo_result->get_contenttype( ).
  lv_nonemptystring = lo_result->get_messages( ).
  lv_nonemptystring = lo_result->get_interpretations( ).
  lv_nonemptystring = lo_result->get_sessionstate( ).
  lv_nonemptystring = lo_result->get_requestattributes( ).
  lv_sessionid = lo_result->get_sessionid( ).
  lv_nonemptystring = lo_result->get_inputtranscript( ).
  lv_blobstream = lo_result->get_audiostream( ).
  lv_nonemptystring = lo_result->get_recognizedbotmember( ).
ENDIF.