@aws-sdk/client-lex-runtime-service
Advanced tools
AWS SDK for JavaScript Lex Runtime Service Client for Node.js, Browser and React Native
@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.
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);"}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.
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 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.
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, .
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-serviceyarn add @aws-sdk/client-lex-runtime-servicepnpm add @aws-sdk/client-lex-runtime-serviceThe 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";
To send a request, you:
send operation on client with command object as input.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);
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.
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.
});
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.
});
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.
});
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;
* }
*/
}
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.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
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.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
FAQs
AWS SDK for JavaScript Lex Runtime Service Client for Node.js, Browser and React Native
The npm package @aws-sdk/client-lex-runtime-service receives a total of 298,155 weekly downloads. As such, @aws-sdk/client-lex-runtime-service popularity was classified as popular.
We found that @aws-sdk/client-lex-runtime-service demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
Security News
Research
Socket researchers found a malicious Maven package impersonating the legitimate ‘XZ for Java’ library, introducing a backdoor for remote code execution.
Security News
Node.js v22.12.0 (LTS) debuts with require(esm) enabled by default, alongside security milestones and automated workflows for faster, more stable releases.