Struct aws_sdk_lexmodelsv2::types::UtteranceSpecification

#[non_exhaustive]
pub struct UtteranceSpecification {

    pub bot_alias_id: Option<String>,
    pub bot_version: Option<String>,
    pub locale_id: Option<String>,
    pub session_id: Option<String>,
    pub channel: Option<String>,
    pub mode: Option<AnalyticsModality>,
    pub conversation_start_time: Option<DateTime>,
    pub conversation_end_time: Option<DateTime>,
    pub utterance: Option<String>,
    pub utterance_timestamp: Option<DateTime>,
    pub audio_voice_duration_millis: Option<i64>,
    pub utterance_understood: bool,
    pub input_type: Option<String>,
    pub output_type: Option<String>,
    pub associated_intent_name: Option<String>,
    pub associated_slot_name: Option<String>,
    pub intent_state: Option<IntentState>,
    pub dialog_action_type: Option<String>,
    pub bot_response_audio_voice_id: Option<String>,
    pub slots_filled_in_session: Option<String>,
    pub utterance_request_id: Option<String>,
    pub bot_responses: Option<Vec<UtteranceBotResponse>>,
}

An object containing information about a specific utterance.

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_alias_id: Option<String>

The identifier of the alias of the bot that the utterance was made to.

bot_version: Option<String>

The version of the bot that the utterance was made to.

locale_id: Option<String>

The locale of the bot that the utterance was made to.

session_id: Option<String>

The identifier of the session that the utterance was made in.

channel: Option<String>

The channel that is integrated with the bot that the utterance was made to.

mode: Option<AnalyticsModality>

The mode of the session. The possible values are as follows:

• Speech – The session consisted of spoken dialogue.

• Text – The session consisted of written dialogue.

• DTMF – The session consisted of touch-tone keypad (Dual Tone Multi-Frequency) key presses.

• MultiMode – The session consisted of multiple modes.

conversation_start_time: Option<DateTime>

The date and time when the conversation in which the utterance took place began. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

conversation_end_time: Option<DateTime>

The date and time when the conversation in which the utterance took place ended. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

utterance: Option<String>

The text of the utterance.

utterance_timestamp: Option<DateTime>

The date and time when the utterance took place.

audio_voice_duration_millis: Option<i64>

The duration in milliseconds of the audio associated with the utterance.

utterance_understood: bool

Specifies whether the bot understood the utterance or not.

input_type: Option<String>

The input type of the utterance. The possible values are as follows:

• 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

output_type: Option<String>

The output type of the utterance. The possible values are as follows:

• audio/mpeg

• audio/ogg

• audio/pcm (16 KHz)

• audio/ (defaults to mpeg)

• text/plain; charset=utf-8

associated_intent_name: Option<String>

The name of the intent that the utterance is associated to.

associated_slot_name: Option<String>

The name of the slot that the utterance is associated to.

intent_state: Option<IntentState>

The state of the intent that the utterance is associated to.

dialog_action_type: Option<String>

The type of dialog action that the utterance is associated to. See the type field in DialogAction for more information.

bot_response_audio_voice_id: Option<String>

The identifier for the audio of the bot response.

slots_filled_in_session: Option<String>

The slots that have been filled in the session by the time of the utterance.

utterance_request_id: Option<String>

The identifier of the request associated with the utterance.

bot_responses: Option<Vec<UtteranceBotResponse>>

A list of objects containing information about the bot response to the utterance.

Implementations

impl UtteranceSpecification

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

The identifier of the alias of the bot that the utterance was made to.

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

The version of the bot that the utterance was made to.

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

The locale of the bot that the utterance was made to.

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

The identifier of the session that the utterance was made in.

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

The channel that is integrated with the bot that the utterance was made to.

pub fn mode(&self) -> Option<&AnalyticsModality>

The mode of the session. The possible values are as follows:

• Speech – The session consisted of spoken dialogue.

• Text – The session consisted of written dialogue.

• DTMF – The session consisted of touch-tone keypad (Dual Tone Multi-Frequency) key presses.

• MultiMode – The session consisted of multiple modes.

pub fn conversation_start_time(&self) -> Option<&DateTime>

The date and time when the conversation in which the utterance took place began. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

pub fn conversation_end_time(&self) -> Option<&DateTime>

The date and time when the conversation in which the utterance took place ended. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

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

The text of the utterance.

pub fn utterance_timestamp(&self) -> Option<&DateTime>

The date and time when the utterance took place.

pub fn audio_voice_duration_millis(&self) -> Option<i64>

The duration in milliseconds of the audio associated with the utterance.

pub fn utterance_understood(&self) -> bool

Specifies whether the bot understood the utterance or not.

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

The input type of the utterance. The possible values are as follows:

• 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 output_type(&self) -> Option<&str>

The output type of the utterance. The possible values are as follows:

• audio/mpeg

• audio/ogg

• audio/pcm (16 KHz)

• audio/ (defaults to mpeg)

• text/plain; charset=utf-8

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

The name of the intent that the utterance is associated to.

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

The name of the slot that the utterance is associated to.

pub fn intent_state(&self) -> Option<&IntentState>

The state of the intent that the utterance is associated to.

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

The type of dialog action that the utterance is associated to. See the type field in DialogAction for more information.

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

The identifier for the audio of the bot response.

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

The slots that have been filled in the session by the time of the utterance.

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

The identifier of the request associated with the utterance.

pub fn bot_responses(&self) -> &[UtteranceBotResponse]

A list of objects containing information about the bot response to the utterance.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .bot_responses.is_none().

impl UtteranceSpecification

pub fn builder() -> UtteranceSpecificationBuilder

Creates a new builder-style object to manufacture UtteranceSpecification.

Trait Implementations

impl Clone for UtteranceSpecification

fn clone(&self) -> UtteranceSpecification

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UtteranceSpecification

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

Formats the value using the given formatter.

impl PartialEq for UtteranceSpecification

fn eq(&self, other: &UtteranceSpecification) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UtteranceSpecification