Struct aws_sdk_lexruntimev2::client::fluent_builders::RecognizeText

pub struct RecognizeText<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

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

impl<C, M, R> RecognizeText<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<RecognizeTextOutput, SdkError<RecognizeTextError>> where
    R::Policy: SmithyRetryPolicy<RecognizeTextInputOperationOutputAlias, RecognizeTextOutput, RecognizeTextError, RecognizeTextInputOperationRetryAlias>, 

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.

pub fn bot_id(self, input: impl Into<String>) -> Self

The identifier of the bot that processes the request.

pub fn set_bot_id(self, input: Option<String>) -> Self

The identifier of the bot that processes the request.

pub fn bot_alias_id(self, input: impl Into<String>) -> Self

The alias identifier in use for the bot that processes the request.

pub fn set_bot_alias_id(self, input: Option<String>) -> Self

The alias identifier in use for the bot that processes the request.

pub fn locale_id(self, input: impl Into<String>) -> Self

The locale where the session is in use.

pub fn set_locale_id(self, input: Option<String>) -> Self

The locale where the session is in use.

pub fn session_id(self, input: impl Into<String>) -> Self

The identifier of the user session that is having the conversation.

pub fn set_session_id(self, input: Option<String>) -> Self

The identifier of the user session that is having the conversation.

pub fn text(self, input: impl Into<String>) -> Self

The text that the user entered. Amazon Lex V2 interprets this text.

pub fn set_text(self, input: Option<String>) -> Self

The text that the user entered. Amazon Lex V2 interprets this text.

pub fn session_state(self, input: SessionState) -> Self

The current state of the dialog between the user and the bot.

pub fn set_session_state(self, input: Option<SessionState>) -> Self

The current state of the dialog between the user and the bot.

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:.

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

impl<C: Clone, M: Clone, R: Clone> Clone for RecognizeText<C, M, R>

fn clone(&self) -> RecognizeText<C, M, R>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for RecognizeText<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.