Struct aws_sdk_lexruntimev2::client::fluent_builders::RecognizeUtterance

pub struct RecognizeUtterance { /* private fields */ }

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

impl RecognizeUtterance

pub async fn customize(
    self
) -> Result<CustomizableOperation<RecognizeUtterance, AwsResponseRetryClassifier>, SdkError<RecognizeUtteranceError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<RecognizeUtteranceOutput, SdkError<RecognizeUtteranceError>>

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 should receive the request.

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

The identifier of the bot that should receive the request.

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

The alias identifier in use for the bot that should receive the request.

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

The alias identifier in use for the bot that should receive 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 session in use.

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

The identifier of the session in use.

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.

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.

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.

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.

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

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

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 the requestContentType parameter. For example, if you specify audio/mpeg as the value, Amazon Lex V2 returns speech in the MPEG format.

• If the value is audio/pcm, the speech returned is audio/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

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 the requestContentType parameter. For example, if you specify audio/mpeg as the value, Amazon Lex V2 returns speech in the MPEG format.

• If the value is audio/pcm, the speech returned is audio/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

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.

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.

Trait Implementations

impl Debug for RecognizeUtterance

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

Formats the value using the given formatter.