@aws-sdk/client-lex-runtime-service

What is @aws-sdk/client-lex-runtime-service?

@aws-sdk/client-lex-runtime-service is an AWS SDK for JavaScript package that allows developers to interact with the Amazon Lex Runtime Service. This service enables you to build conversational interfaces using voice and text. The package provides methods to send user input to Amazon Lex and receive responses, manage session attributes, and more.

What are @aws-sdk/client-lex-runtime-service's main functionalities?

PostText

The PostText feature allows you to send user input text to Amazon Lex and receive a response. This is useful for text-based conversational interfaces.

{"import":"import { LexRuntimeServiceClient, PostTextCommand } from '@aws-sdk/client-lex-runtime-service';","client":"const client = new LexRuntimeServiceClient({ region: 'us-west-2' });","command":"const command = new PostTextCommand({ botName: 'BookTrip', botAlias: 'Prod', userId: 'user123', inputText: 'I want to book a hotel' });","response":"const response = await client.send(command);","log":"console.log(response);"}

PostContent

The PostContent feature allows you to send user input in audio format to Amazon Lex and receive a response. This is useful for voice-based conversational interfaces.

{"import":"import { LexRuntimeServiceClient, PostContentCommand } from '@aws-sdk/client-lex-runtime-service';","client":"const client = new LexRuntimeServiceClient({ region: 'us-west-2' });","command":"const command = new PostContentCommand({ botName: 'BookTrip', botAlias: 'Prod', userId: 'user123', contentType: 'audio/l16; rate=16000; channels=1', inputStream: audioStream });","response":"const response = await client.send(command);","log":"console.log(response);"}

GetSession

The GetSession feature allows you to retrieve session information for a user. This can be useful for managing and maintaining the state of a conversation.

{"import":"import { LexRuntimeServiceClient, GetSessionCommand } from '@aws-sdk/client-lex-runtime-service';","client":"const client = new LexRuntimeServiceClient({ region: 'us-west-2' });","command":"const command = new GetSessionCommand({ botName: 'BookTrip', botAlias: 'Prod', userId: 'user123' });","response":"const response = await client.send(command);","log":"console.log(response);"}

PutSession

The PutSession feature allows you to create or update a session for a user. This can be useful for setting session attributes and managing the flow of a conversation.

{"import":"import { LexRuntimeServiceClient, PutSessionCommand } from '@aws-sdk/client-lex-runtime-service';","client":"const client = new LexRuntimeServiceClient({ region: 'us-west-2' });","command":"const command = new PutSessionCommand({ botName: 'BookTrip', botAlias: 'Prod', userId: 'user123', sessionAttributes: { key: 'value' }, dialogAction: { type: 'ElicitIntent', intentName: 'BookHotel' } });","response":"const response = await client.send(command);","log":"console.log(response);"}

Other packages similar to @aws-sdk/client-lex-runtime-service

dialogflow

The dialogflow package allows you to interact with Google Dialogflow, a natural language understanding platform used to design and integrate conversational user interfaces. It offers similar functionalities to Amazon Lex, such as handling text and voice inputs, managing sessions, and more.

botframework

The botframework package is part of Microsoft's Bot Framework, which provides tools to build, test, and deploy chatbots. It supports multiple channels and offers features like natural language understanding, dialog management, and integration with various services.

rasa

Rasa is an open-source machine learning framework for automated text and voice-based conversations. It provides tools for intent recognition, entity extraction, and dialogue management, similar to Amazon Lex. Rasa allows for more customization and control over the conversational models.

README

@aws-sdk/client-lex-runtime-service

Description

AWS SDK for JavaScript LexRuntimeService Client for Node.js, Browser and React Native.

Amazon Lex provides both build and runtime endpoints. Each endpoint provides a set of operations (API). Your conversational bot uses the runtime API to understand user utterances (user input text or voice). For example, suppose a user says "I want pizza", your bot sends this input to Amazon Lex using the runtime API. Amazon Lex recognizes that the user request is for the OrderPizza intent (one of the intents defined in the bot). Then Amazon Lex engages in user conversation on behalf of the bot to elicit required information (slot values, such as pizza size and crust type), and then performs fulfillment activity (that you configured when you created the bot). You use the build-time API to create and manage your Amazon Lex bot. For a list of build-time operations, see the build-time API, .

Installing

To install this package, simply type add or install @aws-sdk/client-lex-runtime-service using your favorite package manager:

• npm install @aws-sdk/client-lex-runtime-service
• yarn add @aws-sdk/client-lex-runtime-service
• pnpm add @aws-sdk/client-lex-runtime-service

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the LexRuntimeServiceClient and the commands you need, for example GetSessionCommand:

// ES5 example
const { LexRuntimeServiceClient, GetSessionCommand } = require("@aws-sdk/client-lex-runtime-service");

// ES6+ example
import { LexRuntimeServiceClient, GetSessionCommand } from "@aws-sdk/client-lex-runtime-service";

Usage

To send a request, you:

• Initiate client with configuration (e.g. credentials, region).
• Initiate command with input parameters.
• Call send operation on client with command object as input.
• If you are using a custom http handler, you may call destroy() to close open connections.

// a client can be shared by different commands.
const client = new LexRuntimeServiceClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new GetSessionCommand(params);

Async/await

We recommend using await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

Promises

You can also use Promise chaining to execute send operation.

client.send(command).then(
  (data) => {
    // process data.
  },
  (error) => {
    // error handling.
  }
);

Promises can also be called using .catch() and .finally() as follows:

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
client.send(command, (err, data) => {
  // process err and data.
});

v2 compatible style

The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript

import * as AWS from "@aws-sdk/client-lex-runtime-service";
const client = new AWS.LexRuntimeService({ region: "REGION" });

// async/await.
try {
  const data = await client.getSession(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .getSession(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks.
client.getSession(params, (err, data) => {
  // process err and data.
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by specifying exception names:
   * if (error.name === 'SomeServiceException') {
   *     const value = error.specialKeyInException;
   * }
   */
}

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

• Visit Developer Guide or API Reference.
• Check out the blog posts tagged with aws-sdk-js on AWS Developer Blog.
• Ask a question on StackOverflow and tag it with aws-sdk-js.
• Join the AWS JavaScript community on gitter.
• If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-lex-runtime-service package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

DeleteSession

Command API Reference / Input / Output

GetSession

Command API Reference / Input / Output

PostContent

Command API Reference / Input / Output

PostText

Command API Reference / Input / Output

PutSession

Command API Reference / Input / Output

Changelog

3.692.0 (2024-11-14)

Features

• client-accessanalyzer: Expand analyzer configuration capabilities for unused access analyzers. Unused access analyzer configurations now support the ability to exclude accounts and resource tags from analysis providing more granular control over the scope of analysis. (b2df1e1)
• client-cloudcontrol: Added support for CloudFormation Hooks with Cloud Control API. The GetResourceRequestStatus API response now includes an optional HooksProgressEvent and HooksRequestToken parameter for Hooks Invocation Progress as part of resource operation with Cloud Control. (e90cde2)
• client-deadline: Adds support for select GPU accelerated instance types when creating new service-managed fleets. (ac3309b)
• client-iam: This release includes support for five new APIs and changes to existing APIs that give AWS Organizations customers the ability to use temporary root credentials, targeted to member accounts in the organization. (c9dfef1)
• client-iot-wireless: New FuotaTask resource type to enable logging for your FUOTA tasks. A ParticipatingGatewaysforMulticast parameter to choose the list of gateways to receive the multicast downlink message and the transmission interval between them. Descriptor field which will be sent to devices during FUOTA transfer. (69415e0)
• client-ivs: IVS now offers customers the ability to stream multitrack video to Channels. (84b6f4c)
• client-license-manager-user-subscriptions: New and updated API operations to support License Included User-based Subscription of Microsoft Remote Desktop Services (RDS). (5c7c349)
• client-partnercentral-selling: Announcing AWS Partner Central API for Selling: This service launch Introduces new APIs for co-selling opportunity management and related functions. Key features include notifications, a dynamic sandbox for testing, and streamlined validations. (07b84d2)
• client-quicksight: This release adds APIs for Custom Permissions management in QuickSight, and APIs to support QuickSight Branding. (81b1f8c)
• client-redshift: Adds support for Amazon Redshift S3AccessGrants (bf85814)
• client-s3: This release updates the ListBuckets API Reference documentation in support of the new 10,000 general purpose bucket default quota on all AWS accounts. To increase your bucket quota from 10,000 to up to 1 million buckets, simply request a quota increase via Service Quotas. (1e42456)
• client-sagemaker: Add support for Neuron instance types [ trn1/trn1n/inf2 ] on SageMaker Notebook Instances Platform. (dd44e8a)
• client-sts: This release introduces the new API 'AssumeRoot', which returns short-term credentials that you can use to perform privileged tasks. (5528f54)
• clients: update client endpoints as of 2024-11-14 (87df5bd)