pub struct RecognizeTextFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to RecognizeText.
Sends user input to Amazon Lex V2. Client applications use this API to send requests to Amazon Lex V2 at runtime. Amazon Lex V2 then interprets the user input using the machine learning model that it build for the bot.
In response, Amazon Lex V2 returns the next message to convey to the user and an optional response card to display.
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 RecognizeTextFluentBuilder
impl RecognizeTextFluentBuilder
Sourcepub fn as_input(&self) -> &RecognizeTextInputBuilder
pub fn as_input(&self) -> &RecognizeTextInputBuilder
Access the RecognizeText as a reference.
Sourcepub async fn send(
self,
) -> Result<RecognizeTextOutput, SdkError<RecognizeTextError, HttpResponse>>
pub async fn send( self, ) -> Result<RecognizeTextOutput, SdkError<RecognizeTextError, 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<RecognizeTextOutput, RecognizeTextError, Self>
pub fn customize( self, ) -> CustomizableOperation<RecognizeTextOutput, RecognizeTextError, 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 processes 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 processes the request.
Sourcepub fn get_bot_id(&self) -> &Option<String>
pub fn get_bot_id(&self) -> &Option<String>
The identifier of the bot that processes 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 processes 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 processes 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 processes 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 user session that is having the conversation.
Sourcepub fn set_session_id(self, input: Option<String>) -> Self
pub fn set_session_id(self, input: Option<String>) -> Self
The identifier of the user session that is having the conversation.
Sourcepub fn get_session_id(&self) -> &Option<String>
pub fn get_session_id(&self) -> &Option<String>
The identifier of the user session that is having the conversation.
Sourcepub fn text(self, input: impl Into<String>) -> Self
pub fn text(self, input: impl Into<String>) -> Self
The text that the user entered. Amazon Lex V2 interprets this text.
Sourcepub fn set_text(self, input: Option<String>) -> Self
pub fn set_text(self, input: Option<String>) -> Self
The text that the user entered. Amazon Lex V2 interprets this text.
Sourcepub fn get_text(&self) -> &Option<String>
pub fn get_text(&self) -> &Option<String>
The text that the user entered. Amazon Lex V2 interprets this text.
Sourcepub fn session_state(self, input: SessionState) -> Self
pub fn session_state(self, input: SessionState) -> Self
The current state of the dialog between the user and the bot.
Sourcepub fn set_session_state(self, input: Option<SessionState>) -> Self
pub fn set_session_state(self, input: Option<SessionState>) -> Self
The current state of the dialog between the user and the bot.
Sourcepub fn get_session_state(&self) -> &Option<SessionState>
pub fn get_session_state(&self) -> &Option<SessionState>
The current state of the dialog between the user and the bot.
Sourcepub fn request_attributes(
self,
k: impl Into<String>,
v: impl Into<String>,
) -> Self
pub fn request_attributes( self, k: impl Into<String>, v: impl Into<String>, ) -> Self
Adds a key-value pair to requestAttributes.
To override the contents of this collection use set_request_attributes.
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 with the prefix x-amz-lex:.
Sourcepub fn set_request_attributes(
self,
input: Option<HashMap<String, String>>,
) -> Self
pub fn set_request_attributes( self, input: Option<HashMap<String, 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 with the prefix x-amz-lex:.
Trait Implementations§
Source§impl Clone for RecognizeTextFluentBuilder
impl Clone for RecognizeTextFluentBuilder
Source§fn clone(&self) -> RecognizeTextFluentBuilder
fn clone(&self) -> RecognizeTextFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for RecognizeTextFluentBuilder
impl !RefUnwindSafe for RecognizeTextFluentBuilder
impl Send for RecognizeTextFluentBuilder
impl Sync for RecognizeTextFluentBuilder
impl Unpin for RecognizeTextFluentBuilder
impl !UnwindSafe for RecognizeTextFluentBuilder
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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);