Struct PutSessionOutput

#[non_exhaustive]
pub struct PutSessionOutput {
    pub content_type: Option<String>,
    pub intent_name: Option<String>,
    pub slots: Option<String>,
    pub session_attributes: Option<String>,
    pub message: Option<String>,
    pub encoded_message: Option<String>,
    pub message_format: Option<MessageFormatType>,
    pub dialog_state: Option<DialogState>,
    pub slot_to_elicit: Option<String>,
    pub audio_stream: ByteStream,
    pub session_id: Option<String>,
    pub active_contexts: Option<String>,
    /* private fields */
}

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.

content_type: Option<String>

Content type as specified in the Accept HTTP header in the request.

intent_name: Option<String>

The name of the current intent.

slots: Option<String>

Map of zero or more intent slots Amazon Lex detected from the user input during the conversation.

Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the valueSelectionStrategy selected when the slot type was created or updated. If valueSelectionStrategy is set to ORIGINAL_VALUE, the value provided by the user is returned, if the user value is similar to the slot values. If valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy the default is ORIGINAL_VALUE.

session_attributes: Option<String>

Map of key/value pairs representing session-specific context information.

message: Option<String>

👎Deprecated: The message field is deprecated, use the encodedMessage field instead. The message field is available only in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR and it-IT locales.

The next message that should be presented to the user.

You can only use this field in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and it-IT locales. In all other locales, the message field is null. You should use the encodedMessage field instead.

encoded_message: Option<String>

The next message that should be presented to the user.

The encodedMessage field is base-64 encoded. You must decode the field before you can use the value.

message_format: Option<MessageFormatType>

The format of the response message. One of the following values:

• PlainText - The message contains plain UTF-8 text.

• CustomPayload - The message is a custom format for the client.

• SSML - The message contains text formatted for voice output.

• Composite - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.

dialog_state: Option<DialogState>

• ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response to confirm the intent before fulfilling an intent.

• ElicitIntent - Amazon Lex wants to elicit the user's intent.

• ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.

• Failed - Conveys that the conversation with the user has failed. This can happen for various reasons, including the user does not provide an appropriate response to prompts from the service, or if the Lambda function fails to fulfill the intent.

• Fulfilled - Conveys that the Lambda function has sucessfully fulfilled the intent.

• ReadyForFulfillment - Conveys that the client has to fulfill the intent.

slot_to_elicit: Option<String>

If the dialogState is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.

audio_stream: ByteStream

The audio version of the message to convey to the user.

session_id: Option<String>

A unique identifier for the session.

active_contexts: Option<String>

A list of active contexts for the session.

Implementations

impl PutSessionOutput

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

Content type as specified in the Accept HTTP header in the request.

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

The name of the current intent.

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

Map of zero or more intent slots Amazon Lex detected from the user input during the conversation.

Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the valueSelectionStrategy selected when the slot type was created or updated. If valueSelectionStrategy is set to ORIGINAL_VALUE, the value provided by the user is returned, if the user value is similar to the slot values. If valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy the default is ORIGINAL_VALUE.

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

Map of key/value pairs representing session-specific context information.

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

👎Deprecated: The message field is deprecated, use the encodedMessage field instead. The message field is available only in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR and it-IT locales.

The next message that should be presented to the user.

You can only use this field in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and it-IT locales. In all other locales, the message field is null. You should use the encodedMessage field instead.

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

The next message that should be presented to the user.

The encodedMessage field is base-64 encoded. You must decode the field before you can use the value.

pub fn message_format(&self) -> Option<&MessageFormatType>

The format of the response message. One of the following values:

• PlainText - The message contains plain UTF-8 text.

• CustomPayload - The message is a custom format for the client.

• SSML - The message contains text formatted for voice output.

• Composite - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.

pub fn dialog_state(&self) -> Option<&DialogState>

• ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response to confirm the intent before fulfilling an intent.

• ElicitIntent - Amazon Lex wants to elicit the user's intent.

• ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.

• Failed - Conveys that the conversation with the user has failed. This can happen for various reasons, including the user does not provide an appropriate response to prompts from the service, or if the Lambda function fails to fulfill the intent.

• Fulfilled - Conveys that the Lambda function has sucessfully fulfilled the intent.

• ReadyForFulfillment - Conveys that the client has to fulfill the intent.

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

If the dialogState is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.

pub fn audio_stream(&self) -> &ByteStream

The audio version of the message to convey to the user.

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

A unique identifier for the session.

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

A list of active contexts for the session.

impl PutSessionOutput

pub fn builder() -> PutSessionOutputBuilder

Creates a new builder-style object to manufacture PutSessionOutput.

Trait Implementations

impl Debug for PutSessionOutput

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

Formats the value using the given formatter.

impl RequestId for PutSessionOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.