@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

For SDK usage, please step to SDK reademe.