Struct SessionSpecification

#[non_exhaustive]
pub struct SessionSpecification {

    pub bot_alias_id: Option<String>,
    pub bot_version: Option<String>,
    pub locale_id: Option<String>,
    pub channel: Option<String>,
    pub session_id: Option<String>,
    pub conversation_start_time: Option<DateTime>,
    pub conversation_end_time: Option<DateTime>,
    pub conversation_duration_seconds: Option<i64>,
    pub conversation_end_state: Option<ConversationEndState>,
    pub mode: Option<AnalyticsModality>,
    pub number_of_turns: Option<i64>,
    pub invoked_intent_samples: Option<Vec<InvokedIntentSample>>,
    pub originating_request_id: Option<String>,
}

An object containing information about a specific session.

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 session was held with.

bot_version: Option<String>

The version of the bot that the session was held with.

locale_id: Option<String>

The locale of the bot that the session was held with.

channel: Option<String>

The channel that is integrated with the bot that the session was held with.

session_id: Option<String>

The identifier of the session.

conversation_start_time: Option<DateTime>

The date and time when the conversation 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 ended. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

conversation_duration_seconds: Option<i64>

The duration of the conversation in seconds. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

conversation_end_state: Option<ConversationEndState>

The final state of the conversation. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

mode: Option<AnalyticsModality>

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

• Speech – The session was spoken.

• Text – The session was written.

• DTMF – The session used a touch-tone keypad (Dual Tone Multi-Frequency).

• MultiMode – The session used multiple modes.

number_of_turns: Option<i64>

The number of turns that the session took.

invoked_intent_samples: Option<Vec<InvokedIntentSample>>

A list of objects containing the name of an intent that was invoked.

originating_request_id: Option<String>

The identifier of the first request in a session.

Implementations

impl SessionSpecification

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

The identifier of the alias of the bot that the session was held with.

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

The version of the bot that the session was held with.

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

The locale of the bot that the session was held with.

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

The channel that is integrated with the bot that the session was held with.

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

The identifier of the session.

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

The date and time when the conversation 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 ended. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

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

The duration of the conversation in seconds. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

pub fn conversation_end_state(&self) -> Option<&ConversationEndState>

The final state of the conversation. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

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

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

• Speech – The session was spoken.

• Text – The session was written.

• DTMF – The session used a touch-tone keypad (Dual Tone Multi-Frequency).

• MultiMode – The session used multiple modes.

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

The number of turns that the session took.

pub fn invoked_intent_samples(&self) -> &[InvokedIntentSample]

A list of objects containing the name of an intent that was invoked.

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

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

The identifier of the first request in a session.

impl SessionSpecification

pub fn builder() -> SessionSpecificationBuilder

Creates a new builder-style object to manufacture SessionSpecification.

Trait Implementations

impl Clone for SessionSpecification

fn clone(&self) -> SessionSpecification

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SessionSpecification

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

Formats the value using the given formatter.

impl PartialEq for SessionSpecification

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for SessionSpecification