pub struct RecognizeUtteranceFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to RecognizeUtterance
.
Sends user input to Amazon Lex V2. You can send text or speech. Clients use this API to send text and audio requests to Amazon Lex V2 at runtime. Amazon Lex V2 interprets the user input using the machine learning model built for the bot.
The following request fields must be compressed with gzip and then base64 encoded before you send them to Amazon Lex V2.
-
requestAttributes
-
sessionState
The following response fields are compressed using gzip and then base64 encoded by Amazon Lex V2. Before you can use these fields, you must decode and decompress them.
-
inputTranscript
-
interpretations
-
messages
-
requestAttributes
-
sessionState
The example contains a Java application that compresses and encodes a Java object to send to Amazon Lex V2, and a second that decodes and decompresses a response from Amazon Lex V2.
If the optional post-fulfillment response is specified, the messages are returned as follows. For more information, see PostFulfillmentStatusSpecification.
-
Success message - Returned if the Lambda function completes successfully and the intent state is fulfilled or ready fulfillment if the message is present.
-
Failed message - The failed message is returned if the Lambda function throws an exception or if the Lambda function returns a failed intent state without a message.
-
Timeout message - If you don't configure a timeout message and a timeout, and the Lambda function doesn't return within 30 seconds, the timeout message is returned. If you configure a timeout, the timeout message is returned when the period times out.
For more information, see Completion message.
Implementations§
Source§impl RecognizeUtteranceFluentBuilder
impl RecognizeUtteranceFluentBuilder
Sourcepub fn as_input(&self) -> &RecognizeUtteranceInputBuilder
pub fn as_input(&self) -> &RecognizeUtteranceInputBuilder
Access the RecognizeUtterance as a reference.
Sourcepub async fn send(
self,
) -> Result<RecognizeUtteranceOutput, SdkError<RecognizeUtteranceError, HttpResponse>>
pub async fn send( self, ) -> Result<RecognizeUtteranceOutput, SdkError<RecognizeUtteranceError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<RecognizeUtteranceOutput, RecognizeUtteranceError, Self>
pub fn customize( self, ) -> CustomizableOperation<RecognizeUtteranceOutput, RecognizeUtteranceError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn bot_id(self, input: impl Into<String>) -> Self
pub fn bot_id(self, input: impl Into<String>) -> Self
The identifier of the bot that should receive the request.
Sourcepub fn set_bot_id(self, input: Option<String>) -> Self
pub fn set_bot_id(self, input: Option<String>) -> Self
The identifier of the bot that should receive the request.
Sourcepub fn get_bot_id(&self) -> &Option<String>
pub fn get_bot_id(&self) -> &Option<String>
The identifier of the bot that should receive the request.
Sourcepub fn bot_alias_id(self, input: impl Into<String>) -> Self
pub fn bot_alias_id(self, input: impl Into<String>) -> Self
The alias identifier in use for the bot that should receive the request.
Sourcepub fn set_bot_alias_id(self, input: Option<String>) -> Self
pub fn set_bot_alias_id(self, input: Option<String>) -> Self
The alias identifier in use for the bot that should receive the request.
Sourcepub fn get_bot_alias_id(&self) -> &Option<String>
pub fn get_bot_alias_id(&self) -> &Option<String>
The alias identifier in use for the bot that should receive the request.
Sourcepub fn locale_id(self, input: impl Into<String>) -> Self
pub fn locale_id(self, input: impl Into<String>) -> Self
The locale where the session is in use.
Sourcepub fn set_locale_id(self, input: Option<String>) -> Self
pub fn set_locale_id(self, input: Option<String>) -> Self
The locale where the session is in use.
Sourcepub fn get_locale_id(&self) -> &Option<String>
pub fn get_locale_id(&self) -> &Option<String>
The locale where the session is in use.
Sourcepub fn session_id(self, input: impl Into<String>) -> Self
pub fn session_id(self, input: impl Into<String>) -> Self
The identifier of the session in use.
Sourcepub fn set_session_id(self, input: Option<String>) -> Self
pub fn set_session_id(self, input: Option<String>) -> Self
The identifier of the session in use.
Sourcepub fn get_session_id(&self) -> &Option<String>
pub fn get_session_id(&self) -> &Option<String>
The identifier of the session in use.
Sourcepub fn session_state(self, input: impl Into<String>) -> Self
pub fn session_state(self, input: impl Into<String>) -> Self
Sets the state of the session with the user. You can use this to set the current intent, attributes, context, and dialog action. Use the dialog action to determine the next step that Amazon Lex V2 should use in the conversation with the user.
The sessionState
field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.
Sourcepub fn set_session_state(self, input: Option<String>) -> Self
pub fn set_session_state(self, input: Option<String>) -> Self
Sets the state of the session with the user. You can use this to set the current intent, attributes, context, and dialog action. Use the dialog action to determine the next step that Amazon Lex V2 should use in the conversation with the user.
The sessionState
field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.
Sourcepub fn get_session_state(&self) -> &Option<String>
pub fn get_session_state(&self) -> &Option<String>
Sets the state of the session with the user. You can use this to set the current intent, attributes, context, and dialog action. Use the dialog action to determine the next step that Amazon Lex V2 should use in the conversation with the user.
The sessionState
field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.
Sourcepub fn request_attributes(self, input: impl Into<String>) -> Self
pub fn request_attributes(self, input: impl Into<String>) -> Self
Request-specific information passed between the client application and Amazon Lex V2
The namespace x-amz-lex:
is reserved for special attributes. Don't create any request attributes for prefix x-amz-lex:
.
The requestAttributes
field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.
Sourcepub fn set_request_attributes(self, input: Option<String>) -> Self
pub fn set_request_attributes(self, input: Option<String>) -> Self
Request-specific information passed between the client application and Amazon Lex V2
The namespace x-amz-lex:
is reserved for special attributes. Don't create any request attributes for prefix x-amz-lex:
.
The requestAttributes
field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.
Sourcepub fn get_request_attributes(&self) -> &Option<String>
pub fn get_request_attributes(&self) -> &Option<String>
Request-specific information passed between the client application and Amazon Lex V2
The namespace x-amz-lex:
is reserved for special attributes. Don't create any request attributes for prefix x-amz-lex:
.
The requestAttributes
field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.
Sourcepub fn request_content_type(self, input: impl Into<String>) -> Self
pub fn request_content_type(self, input: impl Into<String>) -> Self
Indicates the format for audio input or that the content is text. The header must start with one of the following prefixes:
-
PCM format, audio data must be in little-endian byte order.
-
audio/l16; rate=16000; channels=1
-
audio/x-l16; sample-rate=16000; channel-count=1
-
audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false
-
-
Opus format
-
audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4
-
-
Text format
-
text/plain; charset=utf-8
-
Sourcepub fn set_request_content_type(self, input: Option<String>) -> Self
pub fn set_request_content_type(self, input: Option<String>) -> Self
Indicates the format for audio input or that the content is text. The header must start with one of the following prefixes:
-
PCM format, audio data must be in little-endian byte order.
-
audio/l16; rate=16000; channels=1
-
audio/x-l16; sample-rate=16000; channel-count=1
-
audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false
-
-
Opus format
-
audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4
-
-
Text format
-
text/plain; charset=utf-8
-
Sourcepub fn get_request_content_type(&self) -> &Option<String>
pub fn get_request_content_type(&self) -> &Option<String>
Indicates the format for audio input or that the content is text. The header must start with one of the following prefixes:
-
PCM format, audio data must be in little-endian byte order.
-
audio/l16; rate=16000; channels=1
-
audio/x-l16; sample-rate=16000; channel-count=1
-
audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false
-
-
Opus format
-
audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4
-
-
Text format
-
text/plain; charset=utf-8
-
Sourcepub fn response_content_type(self, input: impl Into<String>) -> Self
pub fn response_content_type(self, input: impl Into<String>) -> Self
The message that Amazon Lex V2 returns in the response can be either text or speech based on the responseContentType
value.
-
If the value is
text/plain;charset=utf-8
, Amazon Lex V2 returns text in the response. -
If the value begins with
audio/
, Amazon Lex V2 returns speech in the response. Amazon Lex V2 uses Amazon Polly to generate the speech using the configuration that you specified in theresponseContentType
parameter. For example, if you specifyaudio/mpeg
as the value, Amazon Lex V2 returns speech in the MPEG format. -
If the value is
audio/pcm
, the speech returned isaudio/pcm
at 16 KHz in 16-bit, little-endian format. -
The following are the accepted values:
-
audio/mpeg
-
audio/ogg
-
audio/pcm (16 KHz)
-
audio/* (defaults to mpeg)
-
text/plain; charset=utf-8
-
Sourcepub fn set_response_content_type(self, input: Option<String>) -> Self
pub fn set_response_content_type(self, input: Option<String>) -> Self
The message that Amazon Lex V2 returns in the response can be either text or speech based on the responseContentType
value.
-
If the value is
text/plain;charset=utf-8
, Amazon Lex V2 returns text in the response. -
If the value begins with
audio/
, Amazon Lex V2 returns speech in the response. Amazon Lex V2 uses Amazon Polly to generate the speech using the configuration that you specified in theresponseContentType
parameter. For example, if you specifyaudio/mpeg
as the value, Amazon Lex V2 returns speech in the MPEG format. -
If the value is
audio/pcm
, the speech returned isaudio/pcm
at 16 KHz in 16-bit, little-endian format. -
The following are the accepted values:
-
audio/mpeg
-
audio/ogg
-
audio/pcm (16 KHz)
-
audio/* (defaults to mpeg)
-
text/plain; charset=utf-8
-
Sourcepub fn get_response_content_type(&self) -> &Option<String>
pub fn get_response_content_type(&self) -> &Option<String>
The message that Amazon Lex V2 returns in the response can be either text or speech based on the responseContentType
value.
-
If the value is
text/plain;charset=utf-8
, Amazon Lex V2 returns text in the response. -
If the value begins with
audio/
, Amazon Lex V2 returns speech in the response. Amazon Lex V2 uses Amazon Polly to generate the speech using the configuration that you specified in theresponseContentType
parameter. For example, if you specifyaudio/mpeg
as the value, Amazon Lex V2 returns speech in the MPEG format. -
If the value is
audio/pcm
, the speech returned isaudio/pcm
at 16 KHz in 16-bit, little-endian format. -
The following are the accepted values:
-
audio/mpeg
-
audio/ogg
-
audio/pcm (16 KHz)
-
audio/* (defaults to mpeg)
-
text/plain; charset=utf-8
-
Sourcepub fn input_stream(self, input: ByteStream) -> Self
pub fn input_stream(self, input: ByteStream) -> Self
User input in PCM or Opus audio format or text format as described in the requestContentType
parameter.
Sourcepub fn set_input_stream(self, input: Option<ByteStream>) -> Self
pub fn set_input_stream(self, input: Option<ByteStream>) -> Self
User input in PCM or Opus audio format or text format as described in the requestContentType
parameter.
Sourcepub fn get_input_stream(&self) -> &Option<ByteStream>
pub fn get_input_stream(&self) -> &Option<ByteStream>
User input in PCM or Opus audio format or text format as described in the requestContentType
parameter.
Trait Implementations§
Auto Trait Implementations§
impl !Freeze for RecognizeUtteranceFluentBuilder
impl !RefUnwindSafe for RecognizeUtteranceFluentBuilder
impl Send for RecognizeUtteranceFluentBuilder
impl Sync for RecognizeUtteranceFluentBuilder
impl Unpin for RecognizeUtteranceFluentBuilder
impl !UnwindSafe for RecognizeUtteranceFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);