Struct aws_sdk_lexruntimev2::operation::recognize_utterance::builders::RecognizeUtteranceInputBuilder

#[non_exhaustive]
pub struct RecognizeUtteranceInputBuilder { /* private fields */ }

A builder for RecognizeUtteranceInput.

Implementations

impl RecognizeUtteranceInputBuilder

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

The identifier of the bot that should receive the request.

This field is required.

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

The identifier of the bot that should receive the request.

pub fn get_bot_id(&self) -> &Option<String>

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.

This field is required.

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 get_bot_alias_id(&self) -> &Option<String>

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.

This field is required.

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

The locale where the session is in use.

pub fn get_locale_id(&self) -> &Option<String>

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.

This field is required.

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

The identifier of the session in use.

pub fn get_session_id(&self) -> &Option<String>

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

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

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

This field is required.

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

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 responseContentType 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 responseContentType 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 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 the responseContentType 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.

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.

pub fn build(self) -> Result<RecognizeUtteranceInput, BuildError>

Consumes the builder and constructs a RecognizeUtteranceInput.

impl RecognizeUtteranceInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<RecognizeUtteranceOutput, SdkError<RecognizeUtteranceError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Debug for RecognizeUtteranceInputBuilder

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

Formats the value using the given formatter.

impl Default for RecognizeUtteranceInputBuilder

fn default() -> RecognizeUtteranceInputBuilder

Returns the “default value” for a type.