Class RecognizeTextCommandProtected

Sends user input to Amazon Lex V2. Client applications use this API to send requests to Amazon Lex V2 at runtime. Amazon Lex V2 then interprets the user input using the machine learning model that it build for the bot.

In response, Amazon Lex V2 returns the next message to convey to the user and an optional response card to display.

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.

Example

Use a bare-bones client and the command you need to make an API call.

import { LexRuntimeV2Client, RecognizeTextCommand } from "@aws-sdk/client-lex-runtime-v2"; // ES Modules import
// const { LexRuntimeV2Client, RecognizeTextCommand } = require("@aws-sdk/client-lex-runtime-v2"); // CommonJS import
const client = new LexRuntimeV2Client(config);
const input = { // RecognizeTextRequest
  botId: "STRING_VALUE", // required
  botAliasId: "STRING_VALUE", // required
  localeId: "STRING_VALUE", // required
  sessionId: "STRING_VALUE", // required
  text: "STRING_VALUE", // required
  sessionState: { // SessionState
    dialogAction: { // DialogAction
      type: "Close" || "ConfirmIntent" || "Delegate" || "ElicitIntent" || "ElicitSlot" || "None", // required
      slotToElicit: "STRING_VALUE",
      slotElicitationStyle: "Default" || "SpellByLetter" || "SpellByWord",
      subSlotToElicit: { // ElicitSubSlot
        name: "STRING_VALUE", // required
        subSlotToElicit: {
          name: "STRING_VALUE", // required
          subSlotToElicit: "<ElicitSubSlot>",
        },
      },
    },
    intent: { // Intent
      name: "STRING_VALUE", // required
      slots: { // Slots
        "<keys>": { // Slot
          value: { // Value
            originalValue: "STRING_VALUE",
            interpretedValue: "STRING_VALUE", // required
            resolvedValues: [ // StringList
              "STRING_VALUE",
            ],
          },
          shape: "Scalar" || "List" || "Composite",
          values: [ // Values
            {
              value: {
                originalValue: "STRING_VALUE",
                interpretedValue: "STRING_VALUE", // required
                resolvedValues: [
                  "STRING_VALUE",
                ],
              },
              shape: "Scalar" || "List" || "Composite",
              values: [
                "<Slot>",
              ],
              subSlots: {
                "<keys>": "<Slot>",
              },
            },
          ],
          subSlots: "<Slots>",
        },
      },
      state: "Failed" || "Fulfilled" || "InProgress" || "ReadyForFulfillment" || "Waiting" || "FulfillmentInProgress",
      confirmationState: "Confirmed" || "Denied" || "None",
    },
    activeContexts: [ // ActiveContextsList
      { // ActiveContext
        name: "STRING_VALUE", // required
        timeToLive: { // ActiveContextTimeToLive
          timeToLiveInSeconds: Number("int"), // required
          turnsToLive: Number("int"), // required
        },
        contextAttributes: { // ActiveContextParametersMap // required
          "<keys>": "STRING_VALUE",
        },
      },
    ],
    sessionAttributes: { // StringMap
      "<keys>": "STRING_VALUE",
    },
    originatingRequestId: "STRING_VALUE",
    runtimeHints: { // RuntimeHints
      slotHints: { // SlotHintsIntentMap
        "<keys>": { // SlotHintsSlotMap
          "<keys>": { // RuntimeHintDetails
            runtimeHintValues: [ // RuntimeHintValuesList
              { // RuntimeHintValue
                phrase: "STRING_VALUE", // required
              },
            ],
            subSlotHints: {
              "<keys>": {
                runtimeHintValues: [
                  {
                    phrase: "STRING_VALUE", // required
                  },
                ],
                subSlotHints: "<SlotHintsSlotMap>",
              },
            },
          },
        },
      },
    },
  },
  requestAttributes: {
    "<keys>": "STRING_VALUE",
  },
};
const command = new RecognizeTextCommand(input);
const response = await client.send(command);
// { // RecognizeTextResponse
//   messages: [ // Messages
//     { // Message
//       content: "STRING_VALUE",
//       contentType: "CustomPayload" || "ImageResponseCard" || "PlainText" || "SSML", // required
//       imageResponseCard: { // ImageResponseCard
//         title: "STRING_VALUE", // required
//         subtitle: "STRING_VALUE",
//         imageUrl: "STRING_VALUE",
//         buttons: [ // ButtonsList
//           { // Button
//             text: "STRING_VALUE", // required
//             value: "STRING_VALUE", // required
//           },
//         ],
//       },
//     },
//   ],
//   sessionState: { // SessionState
//     dialogAction: { // DialogAction
//       type: "Close" || "ConfirmIntent" || "Delegate" || "ElicitIntent" || "ElicitSlot" || "None", // required
//       slotToElicit: "STRING_VALUE",
//       slotElicitationStyle: "Default" || "SpellByLetter" || "SpellByWord",
//       subSlotToElicit: { // ElicitSubSlot
//         name: "STRING_VALUE", // required
//         subSlotToElicit: {
//           name: "STRING_VALUE", // required
//           subSlotToElicit: "<ElicitSubSlot>",
//         },
//       },
//     },
//     intent: { // Intent
//       name: "STRING_VALUE", // required
//       slots: { // Slots
//         "<keys>": { // Slot
//           value: { // Value
//             originalValue: "STRING_VALUE",
//             interpretedValue: "STRING_VALUE", // required
//             resolvedValues: [ // StringList
//               "STRING_VALUE",
//             ],
//           },
//           shape: "Scalar" || "List" || "Composite",
//           values: [ // Values
//             {
//               value: {
//                 originalValue: "STRING_VALUE",
//                 interpretedValue: "STRING_VALUE", // required
//                 resolvedValues: [
//                   "STRING_VALUE",
//                 ],
//               },
//               shape: "Scalar" || "List" || "Composite",
//               values: [
//                 "<Slot>",
//               ],
//               subSlots: {
//                 "<keys>": "<Slot>",
//               },
//             },
//           ],
//           subSlots: "<Slots>",
//         },
//       },
//       state: "Failed" || "Fulfilled" || "InProgress" || "ReadyForFulfillment" || "Waiting" || "FulfillmentInProgress",
//       confirmationState: "Confirmed" || "Denied" || "None",
//     },
//     activeContexts: [ // ActiveContextsList
//       { // ActiveContext
//         name: "STRING_VALUE", // required
//         timeToLive: { // ActiveContextTimeToLive
//           timeToLiveInSeconds: Number("int"), // required
//           turnsToLive: Number("int"), // required
//         },
//         contextAttributes: { // ActiveContextParametersMap // required
//           "<keys>": "STRING_VALUE",
//         },
//       },
//     ],
//     sessionAttributes: { // StringMap
//       "<keys>": "STRING_VALUE",
//     },
//     originatingRequestId: "STRING_VALUE",
//     runtimeHints: { // RuntimeHints
//       slotHints: { // SlotHintsIntentMap
//         "<keys>": { // SlotHintsSlotMap
//           "<keys>": { // RuntimeHintDetails
//             runtimeHintValues: [ // RuntimeHintValuesList
//               { // RuntimeHintValue
//                 phrase: "STRING_VALUE", // required
//               },
//             ],
//             subSlotHints: {
//               "<keys>": {
//                 runtimeHintValues: [
//                   {
//                     phrase: "STRING_VALUE", // required
//                   },
//                 ],
//                 subSlotHints: "<SlotHintsSlotMap>",
//               },
//             },
//           },
//         },
//       },
//     },
//   },
//   interpretations: [ // Interpretations
//     { // Interpretation
//       nluConfidence: { // ConfidenceScore
//         score: Number("double"),
//       },
//       sentimentResponse: { // SentimentResponse
//         sentiment: "MIXED" || "NEGATIVE" || "NEUTRAL" || "POSITIVE",
//         sentimentScore: { // SentimentScore
//           positive: Number("double"),
//           negative: Number("double"),
//           neutral: Number("double"),
//           mixed: Number("double"),
//         },
//       },
//       intent: {
//         name: "STRING_VALUE", // required
//         slots: "<Slots>",
//         state: "Failed" || "Fulfilled" || "InProgress" || "ReadyForFulfillment" || "Waiting" || "FulfillmentInProgress",
//         confirmationState: "Confirmed" || "Denied" || "None",
//       },
//     },
//   ],
//   requestAttributes: {
//     "<keys>": "STRING_VALUE",
//   },
//   sessionId: "STRING_VALUE",
//   recognizedBotMember: { // RecognizedBotMember
//     botId: "STRING_VALUE", // required
//     botName: "STRING_VALUE",
//   },
// };

Param

RecognizeTextCommandInput

Returns

RecognizeTextCommandOutput

See

• RecognizeTextCommandInput for command's input shape.
• RecognizeTextCommandOutput for command's response shape.
• config for LexRuntimeV2Client's config shape.

Throws

AccessDeniedException (client fault)

Throws

BadGatewayException (server fault)

Throws

ConflictException (client fault)

Throws

DependencyFailedException (client fault)

Throws

InternalServerException (server fault)

Throws

ResourceNotFoundException (client fault)

Throws

ThrottlingException (client fault)

Throws

ValidationException (client fault)

Throws

LexRuntimeV2ServiceException

Base exception class for all service exceptions from LexRuntimeV2 service.