Struct PutSessionInput

#[non_exhaustive]
pub struct PutSessionInput {
    pub bot_name: Option<String>,
    pub bot_alias: Option<String>,
    pub user_id: Option<String>,
    pub session_attributes: Option<HashMap<String, String>>,
    pub dialog_action: Option<DialogAction>,
    pub recent_intent_summary_view: Option<Vec<IntentSummary>>,
    pub accept: Option<String>,
    pub active_contexts: Option<Vec<ActiveContext>>,
}

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

The name of the bot that contains the session data.

bot_alias: Option<String>

The alias in use for the bot that contains the session data.

user_id: Option<String>

The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.

session_attributes: Option<HashMap<String, String>>

Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

dialog_action: Option<DialogAction>

Sets the next action that the bot should take to fulfill the conversation.

recent_intent_summary_view: Option<Vec<IntentSummary>>

A summary of the recent intents for the bot. You can use the intent summary view to set a checkpoint label on an intent and modify attributes of intents. You can also use it to remove or add intent summary objects to the list.

An intent that you modify or add to the list must make sense for the bot. For example, the intent name must be valid for the bot. You must provide valid values for:

• intentName

• slot names

• slotToElict

If you send the recentIntentSummaryView parameter in a PutSession request, the contents of the new summary view replaces the old summary view. For example, if a GetSession request returns three intents in the summary view and you call PutSession with one intent in the summary view, the next call to GetSession will only return one intent.

accept: Option<String>

The message that Amazon Lex returns in the response can be either text or speech based depending on the value of this field.

• If the value is text/plain; charset=utf-8, Amazon Lex returns text in the response.

• If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech in the configuration that you specify. For example, if you specify audio/mpeg as the value, Amazon Lex returns speech in the MPEG format.

• If the value is audio/pcm, the speech is returned as audio/pcm in 16-bit, little endian format.

• The following are the accepted values:

  • audio/mpeg

  • audio/ogg

  • audio/pcm

  • audio/* (defaults to mpeg)

  • text/plain; charset=utf-8

active_contexts: Option<Vec<ActiveContext>>

A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,

If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.

Implementations

impl PutSessionInput

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

The name of the bot that contains the session data.

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

The alias in use for the bot that contains the session data.

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

The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.

pub fn session_attributes(&self) -> Option<&HashMap<String, String>>

Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

pub fn dialog_action(&self) -> Option<&DialogAction>

Sets the next action that the bot should take to fulfill the conversation.

pub fn recent_intent_summary_view(&self) -> &[IntentSummary]

A summary of the recent intents for the bot. You can use the intent summary view to set a checkpoint label on an intent and modify attributes of intents. You can also use it to remove or add intent summary objects to the list.

An intent that you modify or add to the list must make sense for the bot. For example, the intent name must be valid for the bot. You must provide valid values for:

• intentName

• slot names

• slotToElict

If you send the recentIntentSummaryView parameter in a PutSession request, the contents of the new summary view replaces the old summary view. For example, if a GetSession request returns three intents in the summary view and you call PutSession with one intent in the summary view, the next call to GetSession will only return one intent.

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

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

The message that Amazon Lex returns in the response can be either text or speech based depending on the value of this field.

• If the value is text/plain; charset=utf-8, Amazon Lex returns text in the response.

• If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech in the configuration that you specify. For example, if you specify audio/mpeg as the value, Amazon Lex returns speech in the MPEG format.

• If the value is audio/pcm, the speech is returned as audio/pcm in 16-bit, little endian format.

• The following are the accepted values:

  • audio/mpeg

  • audio/ogg

  • audio/pcm

  • audio/* (defaults to mpeg)

  • text/plain; charset=utf-8

pub fn active_contexts(&self) -> &[ActiveContext]

A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,

If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.

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

impl PutSessionInput

pub fn builder() -> PutSessionInputBuilder

Creates a new builder-style object to manufacture PutSessionInput.

Trait Implementations

impl Clone for PutSessionInput

fn clone(&self) -> PutSessionInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PutSessionInput

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

Formats the value using the given formatter.

impl PartialEq for PutSessionInput

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

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

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