Struct rusoto_lex_runtime::LexRuntimeClient
source · [−]pub struct LexRuntimeClient { /* private fields */ }
Expand description
A client for the Amazon Lex Runtime Service API.
Implementations
sourceimpl LexRuntimeClient
impl LexRuntimeClient
sourcepub fn new(region: Region) -> LexRuntimeClient
pub fn new(region: Region) -> LexRuntimeClient
Creates a client backed by the default tokio event loop.
The client will use the default credentials provider and tls client.
pub fn new_with<P, D>(
request_dispatcher: D,
credentials_provider: P,
region: Region
) -> LexRuntimeClient where
P: ProvideAwsCredentials + Send + Sync + 'static,
D: DispatchSignedRequest + Send + Sync + 'static,
pub fn new_with_client(client: Client, region: Region) -> LexRuntimeClient
Trait Implementations
sourceimpl Clone for LexRuntimeClient
impl Clone for LexRuntimeClient
sourcefn clone(&self) -> LexRuntimeClient
fn clone(&self) -> LexRuntimeClient
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl LexRuntime for LexRuntimeClient
impl LexRuntime for LexRuntimeClient
sourcefn delete_session<'life0, 'async_trait>(
&'life0 self,
input: DeleteSessionRequest
) -> Pin<Box<dyn Future<Output = Result<DeleteSessionResponse, RusotoError<DeleteSessionError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn delete_session<'life0, 'async_trait>(
&'life0 self,
input: DeleteSessionRequest
) -> Pin<Box<dyn Future<Output = Result<DeleteSessionResponse, RusotoError<DeleteSessionError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Removes session information for a specified bot, alias, and user ID.
sourcefn get_session<'life0, 'async_trait>(
&'life0 self,
input: GetSessionRequest
) -> Pin<Box<dyn Future<Output = Result<GetSessionResponse, RusotoError<GetSessionError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn get_session<'life0, 'async_trait>(
&'life0 self,
input: GetSessionRequest
) -> Pin<Box<dyn Future<Output = Result<GetSessionResponse, RusotoError<GetSessionError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Returns session information for a specified bot, alias, and user ID.
sourcefn post_content<'life0, 'async_trait>(
&'life0 self,
input: PostContentRequest
) -> Pin<Box<dyn Future<Output = Result<PostContentResponse, RusotoError<PostContentError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn post_content<'life0, 'async_trait>(
&'life0 self,
input: PostContentRequest
) -> Pin<Box<dyn Future<Output = Result<PostContentResponse, RusotoError<PostContentError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Sends user input (text or speech) to Amazon Lex. 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 that it built for the bot.
The PostContent
operation supports audio input at 8kHz and 16kHz. You can use 8kHz audio to achieve higher speech recognition accuracy in telephone audio applications.
In response, Amazon Lex returns the next message to convey to the user. Consider the following example messages:
-
For a user input "I would like a pizza," Amazon Lex might return a response with a message eliciting slot data (for example,
PizzaSize
): "What size pizza would you like?". -
After the user provides all of the pizza order information, Amazon Lex might return a response with a message to get user confirmation: "Order the pizza?".
-
After the user replies "Yes" to the confirmation prompt, Amazon Lex might return a conclusion statement: "Thank you, your cheese pizza has been ordered.".
Not all Amazon Lex messages require a response from the user. For example, conclusion statements do not require a response. Some messages require only a yes or no response. In addition to the message
, Amazon Lex provides additional context about the message in the response that you can use to enhance client behavior, such as displaying the appropriate client user interface. Consider the following examples:
-
If the message is to elicit slot data, Amazon Lex returns the following context information:
-
x-amz-lex-dialog-state
header set toElicitSlot
-
x-amz-lex-intent-name
header set to the intent name in the current context -
x-amz-lex-slot-to-elicit
header set to the slot name for which themessage
is eliciting information -
x-amz-lex-slots
header set to a map of slots configured for the intent with their current values
-
-
If the message is a confirmation prompt, the
x-amz-lex-dialog-state
header is set toConfirmation
and thex-amz-lex-slot-to-elicit
header is omitted. -
If the message is a clarification prompt configured for the intent, indicating that the user intent is not understood, the
x-amz-dialog-state
header is set toElicitIntent
and thex-amz-slot-to-elicit
header is omitted.
In addition, Amazon Lex also returns your application-specific sessionAttributes
. For more information, see Managing Conversation Context.
sourcefn post_text<'life0, 'async_trait>(
&'life0 self,
input: PostTextRequest
) -> Pin<Box<dyn Future<Output = Result<PostTextResponse, RusotoError<PostTextError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn post_text<'life0, 'async_trait>(
&'life0 self,
input: PostTextRequest
) -> Pin<Box<dyn Future<Output = Result<PostTextResponse, RusotoError<PostTextError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Sends user input to Amazon Lex. Client applications can use this API to send requests to Amazon Lex at runtime. Amazon Lex then interprets the user input using the machine learning model it built for the bot.
In response, Amazon Lex returns the next message
to convey to the user an optional responseCard
to display. Consider the following example messages:
-
For a user input "I would like a pizza", Amazon Lex might return a response with a message eliciting slot data (for example, PizzaSize): "What size pizza would you like?"
-
After the user provides all of the pizza order information, Amazon Lex might return a response with a message to obtain user confirmation "Proceed with the pizza order?".
-
After the user replies to a confirmation prompt with a "yes", Amazon Lex might return a conclusion statement: "Thank you, your cheese pizza has been ordered.".
Not all Amazon Lex messages require a user response. For example, a conclusion statement does not require a response. Some messages require only a "yes" or "no" user response. In addition to the message
, Amazon Lex provides additional context about the message in the response that you might use to enhance client behavior, for example, to display the appropriate client user interface. These are the slotToElicit
, dialogState
, intentName
, and slots
fields in the response. Consider the following examples:
-
If the message is to elicit slot data, Amazon Lex returns the following context information:
-
dialogState
set to ElicitSlot -
intentName
set to the intent name in the current context -
slotToElicit
set to the slot name for which themessage
is eliciting information -
slots
set to a map of slots, configured for the intent, with currently known values
-
-
If the message is a confirmation prompt, the
dialogState
is set to ConfirmIntent andSlotToElicit
is set to null. -
If the message is a clarification prompt (configured for the intent) that indicates that user intent is not understood, the
dialogState
is set to ElicitIntent andslotToElicit
is set to null.
In addition, Amazon Lex also returns your application-specific sessionAttributes
. For more information, see Managing Conversation Context.
sourcefn put_session<'life0, 'async_trait>(
&'life0 self,
input: PutSessionRequest
) -> Pin<Box<dyn Future<Output = Result<PutSessionResponse, RusotoError<PutSessionError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn put_session<'life0, 'async_trait>(
&'life0 self,
input: PutSessionRequest
) -> Pin<Box<dyn Future<Output = Result<PutSessionResponse, RusotoError<PutSessionError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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.
For more information, see Managing Sessions.
Auto Trait Implementations
impl !RefUnwindSafe for LexRuntimeClient
impl Send for LexRuntimeClient
impl Sync for LexRuntimeClient
impl Unpin for LexRuntimeClient
impl !UnwindSafe for LexRuntimeClient
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more