Class: AWS.LexRuntimeV2

var params = {
  botAliasId: 'STRING_VALUE', /* required */
  botId: 'STRING_VALUE', /* required */
  localeId: 'STRING_VALUE', /* required */
  sessionId: 'STRING_VALUE' /* required */
};
lexruntimev2.getSession(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • botId — (String)

    The identifier of the bot that contains the session data.

  • botAliasId — (String)

    The alias identifier in use for the bot that contains the session data.

  • localeId — (String)

    The locale where the session is in use.

  • sessionId — (String)

    The identifier of the session to return.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • sessionId — (String)

      The identifier of the returned session.

    • messages — (Array<map>)

      A list of messages that were last sent to the user. The messages are ordered based on the order that your returned the messages from your Lambda function or the order that messages are defined in the bot.

      • content — (String)

        The text of the message.

      • contentType — required — (String)

        Indicates the type of response.

        Possible values include:
        • "CustomPayload"
        • "ImageResponseCard"
        • "PlainText"
        • "SSML"
      • imageResponseCard — (map)

        A card that is shown to the user by a messaging platform. You define the contents of the card, the card is displayed by the platform.

        When you use a response card, the response from the user is constrained to the text associated with a button on the card.

        • title — required — (String)

          The title to display on the response card. The format of the title is determined by the platform displaying the response card.

        • subtitle — (String)

          The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

        • imageUrl — (String)

          The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

        • buttons — (Array<map>)

          A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

          • text — required — (String)

            The text that is displayed on the button.

          • value — required — (String)

            The value returned to Amazon Lex V2 when a user chooses the button.

    • interpretations — (Array<map>)

      A list of intents that Amazon Lex V2 determined might satisfy the user's utterance.

      Each interpretation includes the intent, a score that indicates how confident Amazon Lex V2 is that the interpretation is the correct one, and an optional sentiment response that indicates the sentiment expressed in the utterance.

      • nluConfidence — (map)

        Determines the threshold where Amazon Lex V2 will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a response. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

        • score — (Float)

          A score that indicates how confident Amazon Lex V2 is that an intent satisfies the user's intent. Ranges between 0.00 and 1.00. Higher scores indicate higher confidence.

      • sentimentResponse — (map)

        The sentiment expressed in an utterance.

        When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.

        • sentiment — (String)

          The overall sentiment expressed in the user's response. This is the sentiment most likely expressed by the user based on the analysis by Amazon Comprehend.

          Possible values include:
          • "MIXED"
          • "NEGATIVE"
          • "NEUTRAL"
          • "POSITIVE"
        • sentimentScore — (map)

          The individual sentiment responses for the utterance.

          • positive — (Float)

            The level of confidence that Amazon Comprehend has in the accuracy of its detection of the POSITIVE sentiment.

          • negative — (Float)

            The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEGATIVE sentiment.

          • neutral — (Float)

            The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEUTRAL sentiment.

          • mixed — (Float)

            The level of confidence that Amazon Comprehend has in the accuracy of its detection of the MIXED sentiment.

      • intent — (map)

        A list of intents that might satisfy the user's utterance. The intents are ordered by the confidence score.

        • name — required — (String)

          The name of the intent.

        • slots — (map<map>)

          A map of all of the slots for the intent. The name of the slot maps to the value of the slot. If a slot has not been filled, the value is null.

          • value — (map)

            The current value of the slot.

            • originalValue — (String)

              The part of the user's response to the slot elicitation that Amazon Lex V2 determines is relevant to the slot value.

            • interpretedValue — required — (String)

              The value that Amazon Lex V2 determines for the slot, given the user input. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex V2 choose the first value in the resolvedValues list.

            • resolvedValues — (Array<String>)

              A list of values that Amazon Lex V2 determines are possible resolutions for the user input. The first value matches the interpretedValue.

          • shape — (String)

            When the shape value is List, it indicates that the values field contains a list of slot values. When the value is Scalar, it indicates that the value field contains a single value.

            Possible values include:
            • "Scalar"
            • "List"
            • "Composite"
          • values — (Array<map>)

            A list of one or more values that the user provided for the slot. For example, if a for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

        • state — (String)

          Indicates the fulfillment state for the intent. The meanings of each value are as follows:

          • Failed – The bot failed to fulfill the intent.

          • Fulfilled – The bot has completed fulfillment of the intent.

          • FulfillmentInProgress – The bot is in the middle of fulfilling the intent.

          • InProgress – The bot is in the middle of eliciting the slot values that are necessary to fulfill the intent.

          • ReadyForFulfillment – The bot has elicited all the slot values for the intent and is ready to fulfill the intent.

          • Waiting – The bot is waiting for a response from the user (limited to streaming conversations).

          Possible values include:
          • "Failed"
          • "Fulfilled"
          • "InProgress"
          • "ReadyForFulfillment"
          • "Waiting"
          • "FulfillmentInProgress"
        • confirmationState — (String)

          Indicates whether the intent has been Confirmed, Denied, or None if the confirmation stage has not yet been reached.

          Possible values include:
          • "Confirmed"
          • "Denied"
          • "None"
      • interpretationSource — (String)

        Specifies the service that interpreted the input.

        Possible values include:
        • "Bedrock"
        • "Lex"
    • sessionState — (map)

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

      You can use this to determine the progress of the conversation and what the next action might be.

      • dialogAction — (map)

        The next step that Amazon Lex V2 should take in the conversation with a user.

        • type — required — (String)

          The next action that the bot should take in its interaction with the user. The following values are possible:

          • Close – Indicates that there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.

          • ConfirmIntent – The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"

          • Delegate – The next action is determined by Amazon Lex V2.

          • ElicitIntent – The next action is to elicit an intent from the user.

          • ElicitSlot – The next action is to elicit a slot value from the user.

          Possible values include:
          • "Close"
          • "ConfirmIntent"
          • "Delegate"
          • "ElicitIntent"
          • "ElicitSlot"
          • "None"
        • slotToElicit — (String)

          The name of the slot that should be elicited from the user.

        • slotElicitationStyle — (String)

          Configures the slot to use spell-by-letter or spell-by-word style. When you use a style on a slot, users can spell out their input to make it clear to your bot.

          • Spell by letter - "b" "o" "b"

          • Spell by word - "b as in boy" "o as in oscar" "b as in boy"

          For more information, see Using spelling to enter slot values .

          Possible values include:
          • "Default"
          • "SpellByLetter"
          • "SpellByWord"
        • subSlotToElicit — (map)

          The name of the constituent sub slot of the composite slot specified in slotToElicit that should be elicited from the user.

          • name — required — (String)

            The name of the slot that should be elicited from the user.

      • intent — (map)

        The active intent that Amazon Lex V2 is processing.

        • name — required — (String)

          The name of the intent.

        • slots — (map<map>)

          A map of all of the slots for the intent. The name of the slot maps to the value of the slot. If a slot has not been filled, the value is null.

          • value — (map)

            The current value of the slot.

            • originalValue — (String)

              The part of the user's response to the slot elicitation that Amazon Lex V2 determines is relevant to the slot value.

            • interpretedValue — required — (String)

              The value that Amazon Lex V2 determines for the slot, given the user input. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex V2 choose the first value in the resolvedValues list.

            • resolvedValues — (Array<String>)

              A list of values that Amazon Lex V2 determines are possible resolutions for the user input. The first value matches the interpretedValue.

          • shape — (String)

            When the shape value is List, it indicates that the values field contains a list of slot values. When the value is Scalar, it indicates that the value field contains a single value.

            Possible values include:
            • "Scalar"
            • "List"
            • "Composite"
          • values — (Array<map>)

            A list of one or more values that the user provided for the slot. For example, if a for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

        • state — (String)

          Indicates the fulfillment state for the intent. The meanings of each value are as follows:

          • Failed – The bot failed to fulfill the intent.

          • Fulfilled – The bot has completed fulfillment of the intent.

          • FulfillmentInProgress – The bot is in the middle of fulfilling the intent.

          • InProgress – The bot is in the middle of eliciting the slot values that are necessary to fulfill the intent.

          • ReadyForFulfillment – The bot has elicited all the slot values for the intent and is ready to fulfill the intent.

          • Waiting – The bot is waiting for a response from the user (limited to streaming conversations).

          Possible values include:
          • "Failed"
          • "Fulfilled"
          • "InProgress"
          • "ReadyForFulfillment"
          • "Waiting"
          • "FulfillmentInProgress"
        • confirmationState — (String)

          Indicates whether the intent has been Confirmed, Denied, or None if the confirmation stage has not yet been reached.

          Possible values include:
          • "Confirmed"
          • "Denied"
          • "None"
      • activeContexts — (Array<map>)

        One or more contexts that indicate to Amazon Lex V2 the context of a request. When a context is active, Amazon Lex V2 considers intents with the matching context as a trigger as the next intent in a session.

        • name — required — (String)

          The name of the context.

        • timeToLive — required — (map)

          Indicates the number of turns or seconds that the context is active. Once the time to live expires, the context is no longer returned in a response.

          • timeToLiveInSeconds — required — (Integer)

            The number of seconds that the context is active. You can specify between 5 and 86400 seconds (24 hours).

          • turnsToLive — required — (Integer)

            The number of turns that the context is active. You can specify up to 20 turns. Each request and response from the bot is a turn.

        • contextAttributes — required — (map<String>)

          A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request.

          If you don't specify a list of contexts, Amazon Lex V2 will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.

      • sessionAttributes — (map<String>)

        Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex V2 and a client application.

      • originatingRequestId — (String)

        A unique identifier for a specific request.

      • runtimeHints — (map)

        Hints for phrases that a customer is likely to use for a slot. Amazon Lex V2 uses the hints to help determine the correct value of a slot.

        • slotHints — (map<map<map>>)

          A list of the slots in the intent that should have runtime hints added, and the phrases that should be added for each slot.

          The first level of the slotHints map is the name of the intent. The second level is the name of the slot within the intent. For more information, see Using hints to improve accuracy.

          The intent name and slot name must exist.

          • runtimeHintValues — (Array<map>)

            One or more strings that Amazon Lex V2 should look for in the input to the bot. Each phrase is given preference when deciding on slot values.

            • phrase — required — (String)

              The phrase that Amazon Lex V2 should look for in the user's input to the bot.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  botAliasId: 'STRING_VALUE', /* required */
  botId: 'STRING_VALUE', /* required */
  localeId: 'STRING_VALUE', /* required */
  sessionId: 'STRING_VALUE', /* required */
  sessionState: { /* required */
    activeContexts: [
      {
        contextAttributes: { /* required */
          '<ParameterName>': 'STRING_VALUE',
          /* '<ParameterName>': ... */
        },
        name: 'STRING_VALUE', /* required */
        timeToLive: { /* required */
          timeToLiveInSeconds: 'NUMBER_VALUE', /* required */
          turnsToLive: 'NUMBER_VALUE' /* required */
        }
      },
      /* more items */
    ],
    dialogAction: {
      type: Close | ConfirmIntent | Delegate | ElicitIntent | ElicitSlot | None, /* required */
      slotElicitationStyle: Default | SpellByLetter | SpellByWord,
      slotToElicit: 'STRING_VALUE',
      subSlotToElicit: { /* ElicitSubSlot */
        name: 'STRING_VALUE', /* required */
        subSlotToElicit: /* recursive ElicitSubSlot */
      }
    },
    intent: {
      name: 'STRING_VALUE', /* required */
      confirmationState: Confirmed | Denied | None,
      slots: { /* Slots */
        '<NonEmptyString>': { /* Slot */
          shape: Scalar | List | Composite,
          subSlots: /* recursive Slots */,
          value: {
            interpretedValue: 'STRING_VALUE', /* required */
            originalValue: 'STRING_VALUE',
            resolvedValues: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          values: [
            /* recursive Slot */,
            /* more items */
          ]
        },
        /* '<NonEmptyString>': ... */
      },
      state: Failed | Fulfilled | InProgress | ReadyForFulfillment | Waiting | FulfillmentInProgress
    },
    originatingRequestId: 'STRING_VALUE',
    runtimeHints: {
      slotHints: {
        '<Name>': { /* SlotHintsSlotMap */
          '<Name>': {
            runtimeHintValues: [
              {
                phrase: 'STRING_VALUE' /* required */
              },
              /* more items */
            ],
            subSlotHints: /* recursive SlotHintsSlotMap */
          },
          /* '<Name>': ... */
        },
        /* '<Name>': ... */
      }
    },
    sessionAttributes: {
      '<NonEmptyString>': 'STRING_VALUE',
      /* '<NonEmptyString>': ... */
    }
  },
  messages: [
    {
      contentType: CustomPayload | ImageResponseCard | PlainText | SSML, /* required */
      content: 'STRING_VALUE',
      imageResponseCard: {
        title: 'STRING_VALUE', /* required */
        buttons: [
          {
            text: 'STRING_VALUE', /* required */
            value: 'STRING_VALUE' /* required */
          },
          /* more items */
        ],
        imageUrl: 'STRING_VALUE',
        subtitle: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  requestAttributes: {
    '<NonEmptyString>': 'STRING_VALUE',
    /* '<NonEmptyString>': ... */
  },
  responseContentType: 'STRING_VALUE'
};
lexruntimev2.putSession(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • botId — (String)

    The identifier of the bot that receives the session data.

  • botAliasId — (String)

    The alias identifier of the bot that receives the session data.

  • localeId — (String)

    The locale where the session is in use.

  • sessionId — (String)

    The identifier of the session that receives the session data.

  • messages — (Array<map>)

    A list of messages to send to the user. Messages are sent in the order that they are defined in the list.

    • content — (String)

      The text of the message.

    • contentType — required — (String)

      Indicates the type of response.

      Possible values include:
      • "CustomPayload"
      • "ImageResponseCard"
      • "PlainText"
      • "SSML"
    • imageResponseCard — (map)

      A card that is shown to the user by a messaging platform. You define the contents of the card, the card is displayed by the platform.

      When you use a response card, the response from the user is constrained to the text associated with a button on the card.

      • title — required — (String)

        The title to display on the response card. The format of the title is determined by the platform displaying the response card.

      • subtitle — (String)

        The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

      • imageUrl — (String)

        The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

      • buttons — (Array<map>)

        A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

        • text — required — (String)

          The text that is displayed on the button.

        • value — required — (String)

          The value returned to Amazon Lex V2 when a user chooses the button.

  • sessionState — (map)

    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.

    • dialogAction — (map)

      The next step that Amazon Lex V2 should take in the conversation with a user.

      • type — required — (String)

        The next action that the bot should take in its interaction with the user. The following values are possible:

        • Close – Indicates that there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.

        • ConfirmIntent – The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"

        • Delegate – The next action is determined by Amazon Lex V2.

        • ElicitIntent – The next action is to elicit an intent from the user.

        • ElicitSlot – The next action is to elicit a slot value from the user.

        Possible values include:
        • "Close"
        • "ConfirmIntent"
        • "Delegate"
        • "ElicitIntent"
        • "ElicitSlot"
        • "None"
      • slotToElicit — (String)

        The name of the slot that should be elicited from the user.

      • slotElicitationStyle — (String)

        Configures the slot to use spell-by-letter or spell-by-word style. When you use a style on a slot, users can spell out their input to make it clear to your bot.

        • Spell by letter - "b" "o" "b"

        • Spell by word - "b as in boy" "o as in oscar" "b as in boy"

        For more information, see Using spelling to enter slot values .

        Possible values include:
        • "Default"
        • "SpellByLetter"
        • "SpellByWord"
      • subSlotToElicit — (map)

        The name of the constituent sub slot of the composite slot specified in slotToElicit that should be elicited from the user.

        • name — required — (String)

          The name of the slot that should be elicited from the user.

    • intent — (map)

      The active intent that Amazon Lex V2 is processing.

      • name — required — (String)

        The name of the intent.

      • slots — (map<map>)

        A map of all of the slots for the intent. The name of the slot maps to the value of the slot. If a slot has not been filled, the value is null.

        • value — (map)

          The current value of the slot.

          • originalValue — (String)

            The part of the user's response to the slot elicitation that Amazon Lex V2 determines is relevant to the slot value.

          • interpretedValue — required — (String)

            The value that Amazon Lex V2 determines for the slot, given the user input. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex V2 choose the first value in the resolvedValues list.

          • resolvedValues — (Array<String>)

            A list of values that Amazon Lex V2 determines are possible resolutions for the user input. The first value matches the interpretedValue.

        • shape — (String)

          When the shape value is List, it indicates that the values field contains a list of slot values. When the value is Scalar, it indicates that the value field contains a single value.

          Possible values include:
          • "Scalar"
          • "List"
          • "Composite"
        • values — (Array<map>)

          A list of one or more values that the user provided for the slot. For example, if a for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

      • state — (String)

        Indicates the fulfillment state for the intent. The meanings of each value are as follows:

        • Failed – The bot failed to fulfill the intent.

        • Fulfilled – The bot has completed fulfillment of the intent.

        • FulfillmentInProgress – The bot is in the middle of fulfilling the intent.

        • InProgress – The bot is in the middle of eliciting the slot values that are necessary to fulfill the intent.

        • ReadyForFulfillment – The bot has elicited all the slot values for the intent and is ready to fulfill the intent.

        • Waiting – The bot is waiting for a response from the user (limited to streaming conversations).

        Possible values include:
        • "Failed"
        • "Fulfilled"
        • "InProgress"
        • "ReadyForFulfillment"
        • "Waiting"
        • "FulfillmentInProgress"
      • confirmationState — (String)

        Indicates whether the intent has been Confirmed, Denied, or None if the confirmation stage has not yet been reached.

        Possible values include:
        • "Confirmed"
        • "Denied"
        • "None"
    • activeContexts — (Array<map>)

      One or more contexts that indicate to Amazon Lex V2 the context of a request. When a context is active, Amazon Lex V2 considers intents with the matching context as a trigger as the next intent in a session.

      • name — required — (String)

        The name of the context.

      • timeToLive — required — (map)

        Indicates the number of turns or seconds that the context is active. Once the time to live expires, the context is no longer returned in a response.

        • timeToLiveInSeconds — required — (Integer)

          The number of seconds that the context is active. You can specify between 5 and 86400 seconds (24 hours).

        • turnsToLive — required — (Integer)

          The number of turns that the context is active. You can specify up to 20 turns. Each request and response from the bot is a turn.

      • contextAttributes — required — (map<String>)

        A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request.

        If you don't specify a list of contexts, Amazon Lex V2 will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.

    • sessionAttributes — (map<String>)

      Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex V2 and a client application.

    • originatingRequestId — (String)

      A unique identifier for a specific request.

    • runtimeHints — (map)

      Hints for phrases that a customer is likely to use for a slot. Amazon Lex V2 uses the hints to help determine the correct value of a slot.

      • slotHints — (map<map<map>>)

        A list of the slots in the intent that should have runtime hints added, and the phrases that should be added for each slot.

        The first level of the slotHints map is the name of the intent. The second level is the name of the slot within the intent. For more information, see Using hints to improve accuracy.

        The intent name and slot name must exist.

        • runtimeHintValues — (Array<map>)

          One or more strings that Amazon Lex V2 should look for in the input to the bot. Each phrase is given preference when deciding on slot values.

          • phrase — required — (String)

            The phrase that Amazon Lex V2 should look for in the user's input to the bot.

  • requestAttributes — (map<String>)

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

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

  • responseContentType — (String)

    The message that Amazon Lex V2 returns in the response can be either text or speech depending on the value of this parameter.

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • contentType — (String)

      The type of response. Same as the type specified in the responseContentType field in the request.

    • messages — (String)

      A list of messages that were last sent to the user. The messages are ordered based on how you return the messages from you Lambda function or the order that the messages are defined in the bot.

    • sessionState — (String)

      A base-64-encoded gzipped field that represents the current state of the dialog between the user and the bot. Use this to determine the progress of the conversation and what the next action may be.

    • requestAttributes — (String)

      A base-64-encoded gzipped field that provides request-specific information passed between the client application and Amazon Lex V2. These are the same as the requestAttribute parameter in the call to the PutSession operation.

    • sessionId — (String)

      The identifier of the session that received the data.

    • audioStream — (Buffer(Node.js), Typed Array(Browser), ReadableStream)

      If the requested content type was audio, the audio version of the message to convey to the user.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  botAliasId: 'STRING_VALUE', /* required */
  botId: 'STRING_VALUE', /* required */
  localeId: 'STRING_VALUE', /* required */
  sessionId: 'STRING_VALUE', /* required */
  text: 'STRING_VALUE', /* required */
  requestAttributes: {
    '<NonEmptyString>': 'STRING_VALUE',
    /* '<NonEmptyString>': ... */
  },
  sessionState: {
    activeContexts: [
      {
        contextAttributes: { /* required */
          '<ParameterName>': 'STRING_VALUE',
          /* '<ParameterName>': ... */
        },
        name: 'STRING_VALUE', /* required */
        timeToLive: { /* required */
          timeToLiveInSeconds: 'NUMBER_VALUE', /* required */
          turnsToLive: 'NUMBER_VALUE' /* required */
        }
      },
      /* more items */
    ],
    dialogAction: {
      type: Close | ConfirmIntent | Delegate | ElicitIntent | ElicitSlot | None, /* required */
      slotElicitationStyle: Default | SpellByLetter | SpellByWord,
      slotToElicit: 'STRING_VALUE',
      subSlotToElicit: { /* ElicitSubSlot */
        name: 'STRING_VALUE', /* required */
        subSlotToElicit: /* recursive ElicitSubSlot */
      }
    },
    intent: {
      name: 'STRING_VALUE', /* required */
      confirmationState: Confirmed | Denied | None,
      slots: { /* Slots */
        '<NonEmptyString>': { /* Slot */
          shape: Scalar | List | Composite,
          subSlots: /* recursive Slots */,
          value: {
            interpretedValue: 'STRING_VALUE', /* required */
            originalValue: 'STRING_VALUE',
            resolvedValues: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          values: [
            /* recursive Slot */,
            /* more items */
          ]
        },
        /* '<NonEmptyString>': ... */
      },
      state: Failed | Fulfilled | InProgress | ReadyForFulfillment | Waiting | FulfillmentInProgress
    },
    originatingRequestId: 'STRING_VALUE',
    runtimeHints: {
      slotHints: {
        '<Name>': { /* SlotHintsSlotMap */
          '<Name>': {
            runtimeHintValues: [
              {
                phrase: 'STRING_VALUE' /* required */
              },
              /* more items */
            ],
            subSlotHints: /* recursive SlotHintsSlotMap */
          },
          /* '<Name>': ... */
        },
        /* '<Name>': ... */
      }
    },
    sessionAttributes: {
      '<NonEmptyString>': 'STRING_VALUE',
      /* '<NonEmptyString>': ... */
    }
  }
};
lexruntimev2.recognizeText(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • botId — (String)

    The identifier of the bot that processes the request.

  • botAliasId — (String)

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

  • localeId — (String)

    The locale where the session is in use.

  • sessionId — (String)

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

  • text — (String)

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

  • sessionState — (map)

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

    • dialogAction — (map)

      The next step that Amazon Lex V2 should take in the conversation with a user.

      • type — required — (String)

        The next action that the bot should take in its interaction with the user. The following values are possible:

        • Close – Indicates that there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.

        • ConfirmIntent – The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"

        • Delegate – The next action is determined by Amazon Lex V2.

        • ElicitIntent – The next action is to elicit an intent from the user.

        • ElicitSlot – The next action is to elicit a slot value from the user.

        Possible values include:
        • "Close"
        • "ConfirmIntent"
        • "Delegate"
        • "ElicitIntent"
        • "ElicitSlot"
        • "None"
      • slotToElicit — (String)

        The name of the slot that should be elicited from the user.

      • slotElicitationStyle — (String)

        Configures the slot to use spell-by-letter or spell-by-word style. When you use a style on a slot, users can spell out their input to make it clear to your bot.

        • Spell by letter - "b" "o" "b"

        • Spell by word - "b as in boy" "o as in oscar" "b as in boy"

        For more information, see Using spelling to enter slot values .

        Possible values include:
        • "Default"
        • "SpellByLetter"
        • "SpellByWord"
      • subSlotToElicit — (map)

        The name of the constituent sub slot of the composite slot specified in slotToElicit that should be elicited from the user.

        • name — required — (String)

          The name of the slot that should be elicited from the user.

    • intent — (map)

      The active intent that Amazon Lex V2 is processing.

      • name — required — (String)

        The name of the intent.

      • slots — (map<map>)

        A map of all of the slots for the intent. The name of the slot maps to the value of the slot. If a slot has not been filled, the value is null.

        • value — (map)

          The current value of the slot.

          • originalValue — (String)

            The part of the user's response to the slot elicitation that Amazon Lex V2 determines is relevant to the slot value.

          • interpretedValue — required — (String)

            The value that Amazon Lex V2 determines for the slot, given the user input. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex V2 choose the first value in the resolvedValues list.

          • resolvedValues — (Array<String>)

            A list of values that Amazon Lex V2 determines are possible resolutions for the user input. The first value matches the interpretedValue.

        • shape — (String)

          When the shape value is List, it indicates that the values field contains a list of slot values. When the value is Scalar, it indicates that the value field contains a single value.

          Possible values include:
          • "Scalar"
          • "List"
          • "Composite"
        • values — (Array<map>)

          A list of one or more values that the user provided for the slot. For example, if a for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

      • state — (String)

        Indicates the fulfillment state for the intent. The meanings of each value are as follows:

        • Failed – The bot failed to fulfill the intent.

        • Fulfilled – The bot has completed fulfillment of the intent.

        • FulfillmentInProgress – The bot is in the middle of fulfilling the intent.

        • InProgress – The bot is in the middle of eliciting the slot values that are necessary to fulfill the intent.

        • ReadyForFulfillment – The bot has elicited all the slot values for the intent and is ready to fulfill the intent.

        • Waiting – The bot is waiting for a response from the user (limited to streaming conversations).

        Possible values include:
        • "Failed"
        • "Fulfilled"
        • "InProgress"
        • "ReadyForFulfillment"
        • "Waiting"
        • "FulfillmentInProgress"
      • confirmationState — (String)

        Indicates whether the intent has been Confirmed, Denied, or None if the confirmation stage has not yet been reached.

        Possible values include:
        • "Confirmed"
        • "Denied"
        • "None"
    • activeContexts — (Array<map>)

      One or more contexts that indicate to Amazon Lex V2 the context of a request. When a context is active, Amazon Lex V2 considers intents with the matching context as a trigger as the next intent in a session.

      • name — required — (String)

        The name of the context.

      • timeToLive — required — (map)

        Indicates the number of turns or seconds that the context is active. Once the time to live expires, the context is no longer returned in a response.

        • timeToLiveInSeconds — required — (Integer)

          The number of seconds that the context is active. You can specify between 5 and 86400 seconds (24 hours).

        • turnsToLive — required — (Integer)

          The number of turns that the context is active. You can specify up to 20 turns. Each request and response from the bot is a turn.

      • contextAttributes — required — (map<String>)

        A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request.

        If you don't specify a list of contexts, Amazon Lex V2 will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.

    • sessionAttributes — (map<String>)

      Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex V2 and a client application.

    • originatingRequestId — (String)

      A unique identifier for a specific request.

    • runtimeHints — (map)

      Hints for phrases that a customer is likely to use for a slot. Amazon Lex V2 uses the hints to help determine the correct value of a slot.

      • slotHints — (map<map<map>>)

        A list of the slots in the intent that should have runtime hints added, and the phrases that should be added for each slot.

        The first level of the slotHints map is the name of the intent. The second level is the name of the slot within the intent. For more information, see Using hints to improve accuracy.

        The intent name and slot name must exist.

        • runtimeHintValues — (Array<map>)

          One or more strings that Amazon Lex V2 should look for in the input to the bot. Each phrase is given preference when deciding on slot values.

          • phrase — required — (String)

            The phrase that Amazon Lex V2 should look for in the user's input to the bot.

  • requestAttributes — (map<String>)

    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:.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • messages — (Array<map>)

      A list of messages last sent to the user. The messages are ordered based on the order that you returned the messages from your Lambda function or the order that the messages are defined in the bot.

      • content — (String)

        The text of the message.

      • contentType — required — (String)

        Indicates the type of response.

        Possible values include:
        • "CustomPayload"
        • "ImageResponseCard"
        • "PlainText"
        • "SSML"
      • imageResponseCard — (map)

        A card that is shown to the user by a messaging platform. You define the contents of the card, the card is displayed by the platform.

        When you use a response card, the response from the user is constrained to the text associated with a button on the card.

        • title — required — (String)

          The title to display on the response card. The format of the title is determined by the platform displaying the response card.

        • subtitle — (String)

          The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

        • imageUrl — (String)

          The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

        • buttons — (Array<map>)

          A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

          • text — required — (String)

            The text that is displayed on the button.

          • value — required — (String)

            The value returned to Amazon Lex V2 when a user chooses the button.

    • sessionState — (map)

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

      Use this to determine the progress of the conversation and what the next action may be.

      • dialogAction — (map)

        The next step that Amazon Lex V2 should take in the conversation with a user.

        • type — required — (String)

          The next action that the bot should take in its interaction with the user. The following values are possible:

          • Close – Indicates that there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.

          • ConfirmIntent – The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"

          • Delegate – The next action is determined by Amazon Lex V2.

          • ElicitIntent – The next action is to elicit an intent from the user.

          • ElicitSlot – The next action is to elicit a slot value from the user.

          Possible values include:
          • "Close"
          • "ConfirmIntent"
          • "Delegate"
          • "ElicitIntent"
          • "ElicitSlot"
          • "None"
        • slotToElicit — (String)

          The name of the slot that should be elicited from the user.

        • slotElicitationStyle — (String)

          Configures the slot to use spell-by-letter or spell-by-word style. When you use a style on a slot, users can spell out their input to make it clear to your bot.

          • Spell by letter - "b" "o" "b"

          • Spell by word - "b as in boy" "o as in oscar" "b as in boy"

          For more information, see Using spelling to enter slot values .

          Possible values include:
          • "Default"
          • "SpellByLetter"
          • "SpellByWord"
        • subSlotToElicit — (map)

          The name of the constituent sub slot of the composite slot specified in slotToElicit that should be elicited from the user.

          • name — required — (String)

            The name of the slot that should be elicited from the user.

      • intent — (map)

        The active intent that Amazon Lex V2 is processing.

        • name — required — (String)

          The name of the intent.

        • slots — (map<map>)

          A map of all of the slots for the intent. The name of the slot maps to the value of the slot. If a slot has not been filled, the value is null.

          • value — (map)

            The current value of the slot.

            • originalValue — (String)

              The part of the user's response to the slot elicitation that Amazon Lex V2 determines is relevant to the slot value.

            • interpretedValue — required — (String)

              The value that Amazon Lex V2 determines for the slot, given the user input. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex V2 choose the first value in the resolvedValues list.

            • resolvedValues — (Array<String>)

              A list of values that Amazon Lex V2 determines are possible resolutions for the user input. The first value matches the interpretedValue.

          • shape — (String)

            When the shape value is List, it indicates that the values field contains a list of slot values. When the value is Scalar, it indicates that the value field contains a single value.

            Possible values include:
            • "Scalar"
            • "List"
            • "Composite"
          • values — (Array<map>)

            A list of one or more values that the user provided for the slot. For example, if a for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

        • state — (String)

          Indicates the fulfillment state for the intent. The meanings of each value are as follows:

          • Failed – The bot failed to fulfill the intent.

          • Fulfilled – The bot has completed fulfillment of the intent.

          • FulfillmentInProgress – The bot is in the middle of fulfilling the intent.

          • InProgress – The bot is in the middle of eliciting the slot values that are necessary to fulfill the intent.

          • ReadyForFulfillment – The bot has elicited all the slot values for the intent and is ready to fulfill the intent.

          • Waiting – The bot is waiting for a response from the user (limited to streaming conversations).

          Possible values include:
          • "Failed"
          • "Fulfilled"
          • "InProgress"
          • "ReadyForFulfillment"
          • "Waiting"
          • "FulfillmentInProgress"
        • confirmationState — (String)

          Indicates whether the intent has been Confirmed, Denied, or None if the confirmation stage has not yet been reached.

          Possible values include:
          • "Confirmed"
          • "Denied"
          • "None"
      • activeContexts — (Array<map>)

        One or more contexts that indicate to Amazon Lex V2 the context of a request. When a context is active, Amazon Lex V2 considers intents with the matching context as a trigger as the next intent in a session.

        • name — required — (String)

          The name of the context.

        • timeToLive — required — (map)

          Indicates the number of turns or seconds that the context is active. Once the time to live expires, the context is no longer returned in a response.

          • timeToLiveInSeconds — required — (Integer)

            The number of seconds that the context is active. You can specify between 5 and 86400 seconds (24 hours).

          • turnsToLive — required — (Integer)

            The number of turns that the context is active. You can specify up to 20 turns. Each request and response from the bot is a turn.

        • contextAttributes — required — (map<String>)

          A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request.

          If you don't specify a list of contexts, Amazon Lex V2 will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.

      • sessionAttributes — (map<String>)

        Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex V2 and a client application.

      • originatingRequestId — (String)

        A unique identifier for a specific request.

      • runtimeHints — (map)

        Hints for phrases that a customer is likely to use for a slot. Amazon Lex V2 uses the hints to help determine the correct value of a slot.

        • slotHints — (map<map<map>>)

          A list of the slots in the intent that should have runtime hints added, and the phrases that should be added for each slot.

          The first level of the slotHints map is the name of the intent. The second level is the name of the slot within the intent. For more information, see Using hints to improve accuracy.

          The intent name and slot name must exist.

          • runtimeHintValues — (Array<map>)

            One or more strings that Amazon Lex V2 should look for in the input to the bot. Each phrase is given preference when deciding on slot values.

            • phrase — required — (String)

              The phrase that Amazon Lex V2 should look for in the user's input to the bot.

    • interpretations — (Array<map>)

      A list of intents that Amazon Lex V2 determined might satisfy the user's utterance.

      Each interpretation includes the intent, a score that indicates now confident Amazon Lex V2 is that the interpretation is the correct one, and an optional sentiment response that indicates the sentiment expressed in the utterance.

      • nluConfidence — (map)

        Determines the threshold where Amazon Lex V2 will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a response. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

        • score — (Float)

          A score that indicates how confident Amazon Lex V2 is that an intent satisfies the user's intent. Ranges between 0.00 and 1.00. Higher scores indicate higher confidence.

      • sentimentResponse — (map)

        The sentiment expressed in an utterance.

        When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.

        • sentiment — (String)

          The overall sentiment expressed in the user's response. This is the sentiment most likely expressed by the user based on the analysis by Amazon Comprehend.

          Possible values include:
          • "MIXED"
          • "NEGATIVE"
          • "NEUTRAL"
          • "POSITIVE"
        • sentimentScore — (map)

          The individual sentiment responses for the utterance.

          • positive — (Float)

            The level of confidence that Amazon Comprehend has in the accuracy of its detection of the POSITIVE sentiment.

          • negative — (Float)

            The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEGATIVE sentiment.

          • neutral — (Float)

            The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEUTRAL sentiment.

          • mixed — (Float)

            The level of confidence that Amazon Comprehend has in the accuracy of its detection of the MIXED sentiment.

      • intent — (map)

        A list of intents that might satisfy the user's utterance. The intents are ordered by the confidence score.

        • name — required — (String)

          The name of the intent.

        • slots — (map<map>)

          A map of all of the slots for the intent. The name of the slot maps to the value of the slot. If a slot has not been filled, the value is null.

          • value — (map)

            The current value of the slot.

            • originalValue — (String)

              The part of the user's response to the slot elicitation that Amazon Lex V2 determines is relevant to the slot value.

            • interpretedValue — required — (String)

              The value that Amazon Lex V2 determines for the slot, given the user input. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex V2 choose the first value in the resolvedValues list.

            • resolvedValues — (Array<String>)

              A list of values that Amazon Lex V2 determines are possible resolutions for the user input. The first value matches the interpretedValue.

          • shape — (String)

            When the shape value is List, it indicates that the values field contains a list of slot values. When the value is Scalar, it indicates that the value field contains a single value.

            Possible values include:
            • "Scalar"
            • "List"
            • "Composite"
          • values — (Array<map>)

            A list of one or more values that the user provided for the slot. For example, if a for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

        • state — (String)

          Indicates the fulfillment state for the intent. The meanings of each value are as follows:

          • Failed – The bot failed to fulfill the intent.

          • Fulfilled – The bot has completed fulfillment of the intent.

          • FulfillmentInProgress – The bot is in the middle of fulfilling the intent.

          • InProgress – The bot is in the middle of eliciting the slot values that are necessary to fulfill the intent.

          • ReadyForFulfillment – The bot has elicited all the slot values for the intent and is ready to fulfill the intent.

          • Waiting – The bot is waiting for a response from the user (limited to streaming conversations).

          Possible values include:
          • "Failed"
          • "Fulfilled"
          • "InProgress"
          • "ReadyForFulfillment"
          • "Waiting"
          • "FulfillmentInProgress"
        • confirmationState — (String)

          Indicates whether the intent has been Confirmed, Denied, or None if the confirmation stage has not yet been reached.

          Possible values include:
          • "Confirmed"
          • "Denied"
          • "None"
      • interpretationSource — (String)

        Specifies the service that interpreted the input.

        Possible values include:
        • "Bedrock"
        • "Lex"
    • requestAttributes — (map<String>)

      The attributes sent in the request.

    • sessionId — (String)

      The identifier of the session in use.

    • recognizedBotMember — (map)

      The bot member that recognized the text.

      • botId — required — (String)

        The identifier of the bot member that processes the request.

      • botName — (String)

        The name of the bot member that processes the request.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  botAliasId: 'STRING_VALUE', /* required */
  botId: 'STRING_VALUE', /* required */
  localeId: 'STRING_VALUE', /* required */
  requestContentType: 'STRING_VALUE', /* required */
  sessionId: 'STRING_VALUE', /* required */
  inputStream: Buffer.from('...') || 'STRING_VALUE' || streamObject,
  requestAttributes: 'STRING_VALUE',
  responseContentType: 'STRING_VALUE',
  sessionState: 'STRING_VALUE'
};
lexruntimev2.recognizeUtterance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • botId — (String)

    The identifier of the bot that should receive the request.

  • botAliasId — (String)

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

  • localeId — (String)

    The locale where the session is in use.

  • sessionId — (String)

    The identifier of the session in use.

  • sessionState — (String)

    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.

  • requestAttributes — (String)

    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.

  • requestContentType — (String)

    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 — (String)

    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

  • inputStream — (Buffer, Typed Array, Blob, String, ReadableStream)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • inputMode — (String)

      Indicates whether the input mode to the operation was text, speech, or from a touch-tone keypad.

    • contentType — (String)

      Content type as specified in the responseContentType in the request.

    • messages — (String)

      A list of messages that were last sent to the user. The messages are ordered based on the order that you returned the messages from your Lambda function or the order that the messages are defined in the bot.

      The messages field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.

    • interpretations — (String)

      A list of intents that Amazon Lex V2 determined might satisfy the user's utterance.

      Each interpretation includes the intent, a score that indicates how confident Amazon Lex V2 is that the interpretation is the correct one, and an optional sentiment response that indicates the sentiment expressed in the utterance.

      The interpretations field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.

    • sessionState — (String)

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

      Use this to determine the progress of the conversation and what the next action might be.

      The sessionState field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.

    • requestAttributes — (String)

      The attributes sent in the request.

      The requestAttributes field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents.

    • sessionId — (String)

      The identifier of the session in use.

    • inputTranscript — (String)

      The text used to process the request.

      If the input was an audio stream, the inputTranscript field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex V2 is correctly processing the audio that you send.

      The inputTranscript field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.

    • audioStream — (Buffer(Node.js), Typed Array(Browser), ReadableStream)

      The prompt or statement to send to the user. This is based on the bot configuration and context. For example, if Amazon Lex V2 did not understand the user intent, it sends the clarificationPrompt configured for the bot. If the intent requires confirmation before taking the fulfillment action, it sends the confirmationPrompt. Another example: Suppose that the Lambda function successfully fulfilled the intent, and sent a message to convey to the user. Then Amazon Lex V2 sends that message in the response.

    • recognizedBotMember — (String)

      The bot member that recognized the utterance.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.