aws_lex_runtime_v2
Summary
Functions
-
delete_session(Client, BotAliasId, BotId, LocaleId, SessionId, Input)
Removes session information for a specified bot, alias, and user ID.
- delete_session(Client, BotAliasId, BotId, LocaleId, SessionId, Input0, Options0)
-
get_session(Client, BotAliasId, BotId, LocaleId, SessionId)
Returns session information for a specified bot, alias, and user.
- get_session(Client, BotAliasId, BotId, LocaleId, SessionId, QueryMap, HeadersMap)
- get_session(Client, BotAliasId, BotId, LocaleId, SessionId, QueryMap, HeadersMap, Options0)
-
put_session(Client, BotAliasId, BotId, LocaleId, SessionId, Input)
Creates a new session or modifies an existing session with an Amazon Lex bot.
- put_session(Client, BotAliasId, BotId, LocaleId, SessionId, Input0, Options0)
-
recognize_text(Client, BotAliasId, BotId, LocaleId, SessionId, Input)
Sends user input to Amazon Lex.
- recognize_text(Client, BotAliasId, BotId, LocaleId, SessionId, Input0, Options0)
-
recognize_utterance(Client, BotAliasId, BotId, LocaleId, SessionId, Input)
Sends user input to Amazon Lex.
- recognize_utterance(Client, BotAliasId, BotId, LocaleId, SessionId, Input0, Options0)
-
start_conversation(Client, BotAliasId, BotId, LocaleId, SessionId, Input)
Starts an HTTP/2 bidirectional event stream that enables you to send audio, text, or DTMF input in real time.
- start_conversation(Client, BotAliasId, BotId, LocaleId, SessionId, Input0, Options0)
Functions
delete_session(Client, BotAliasId, BotId, LocaleId, SessionId, Input)
Removes session information for a specified bot, alias, and user ID.
You can use this operation to restart a conversation with a bot. When you remove a session, the entire history of the session is removed so that you can start again.
You don't need to delete a session. Sessions have a time limit and will expire. Set the session time limit when you create the bot. The default is 5 minutes, but you can specify anything between 1 minute and 24 hours.
If you specify a bot or alias ID that doesn't exist, you receive a
BadRequestException.
BadRequestException
.
delete_session(Client, BotAliasId, BotId, LocaleId, SessionId, Input0, Options0)
get_session(Client, BotAliasId, BotId, LocaleId, SessionId)
Returns session information for a specified bot, alias, and user.
For example, you can use this operation to retrieve session information for a user that has left a long-running session in use.
If the bot, alias, or session identifier doesn't exist, Amazon Lex returns aBadRequestException
. If the locale doesn't exist or is not enabled for
the alias, you receive a BadRequestException
.
get_session(Client, BotAliasId, BotId, LocaleId, SessionId, QueryMap, HeadersMap)
get_session(Client, BotAliasId, BotId, LocaleId, SessionId, QueryMap, HeadersMap, Options0)
put_session(Client, BotAliasId, BotId, LocaleId, SessionId, Input)
Creates a new session or modifies an existing session with an Amazon Lex bot.
Use this operation to enable your application to set the state of the bot.put_session(Client, BotAliasId, BotId, LocaleId, SessionId, Input0, Options0)
recognize_text(Client, BotAliasId, BotId, LocaleId, SessionId, Input)
Sends user input to Amazon Lex.
Client applications use this API to send requests to Amazon Lex at runtime. Amazon Lex then interprets the user input using the machine learning model that it build for the bot.
In response, Amazon Lex returns the next message to convey to the user and an optional response card to display.recognize_text(Client, BotAliasId, BotId, LocaleId, SessionId, Input0, Options0)
recognize_utterance(Client, BotAliasId, BotId, LocaleId, SessionId, Input)
Sends user input to Amazon Lex.
You can send text or speech. Clients use this API to send text and audio requests to Amazon Lex at runtime. Amazon Lex interprets the user input using the machine learning model built for the bot.recognize_utterance(Client, BotAliasId, BotId, LocaleId, SessionId, Input0, Options0)
start_conversation(Client, BotAliasId, BotId, LocaleId, SessionId, Input)
Starts an HTTP/2 bidirectional event stream that enables you to send audio, text, or DTMF input in real time.
After your application starts a conversation, users send input to Amazon Lex as a stream of events. Amazon Lex processes the incoming events and responds with streaming text or audio events.