Struct aws_sdk_lexruntimev2::operation::recognize_utterance::RecognizeUtteranceInput

#[non_exhaustive]
pub struct RecognizeUtteranceInput {
    pub bot_id: Option<String>,
    pub bot_alias_id: Option<String>,
    pub locale_id: Option<String>,
    pub session_id: Option<String>,
    pub session_state: Option<String>,
    pub request_attributes: Option<String>,
    pub request_content_type: Option<String>,
    pub response_content_type: Option<String>,
    pub input_stream: ByteStream,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

bot_id: Option<String>

The identifier of the bot that should receive the request.

bot_alias_id: Option<String>

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

locale_id: Option<String>

The locale where the session is in use.

session_id: Option<String>

The identifier of the session in use.

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

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

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

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

input_stream: ByteStream

User input in PCM or Opus audio format or text format as described in the requestContentType parameter.

Implementations

impl RecognizeUtteranceInput

pub fn bot_id(&self) -> Option<&str>

The identifier of the bot that should receive the request.

pub fn bot_alias_id(&self) -> Option<&str>

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

pub fn locale_id(&self) -> Option<&str>

The locale where the session is in use.

pub fn session_id(&self) -> Option<&str>

The identifier of the session in use.

pub fn session_state(&self) -> Option<&str>

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) -> Option<&str>

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) -> Option<&str>

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) -> Option<&str>

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) -> &ByteStream

User input in PCM or Opus audio format or text format as described in the requestContentType parameter.

impl RecognizeUtteranceInput

pub fn builder() -> RecognizeUtteranceInputBuilder

Creates a new builder-style object to manufacture RecognizeUtteranceInput.

Trait Implementations

impl Debug for RecognizeUtteranceInput

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

Formats the value using the given formatter.