Struct Slot 

#[non_exhaustive]
pub struct Slot {
    pub name: String,
    pub description: Option<String>,
    pub slot_constraint: SlotConstraint,
    pub slot_type: Option<String>,
    pub slot_type_version: Option<String>,
    pub value_elicitation_prompt: Option<Prompt>,
    pub priority: Option<i32>,
    pub sample_utterances: Option<Vec<String>>,
    pub response_card: Option<String>,
    pub obfuscation_setting: Option<ObfuscationSetting>,
    pub default_value_spec: Option<SlotDefaultValueSpec>,
}

Identifies the version of a specific slot.

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.

name: String

The name of the slot.

description: Option<String>

A description of the slot.

slot_constraint: SlotConstraint

Specifies whether the slot is required or optional.

slot_type: Option<String>

The type of the slot, either a custom slot type that you defined or one of the built-in slot types.

slot_type_version: Option<String>

The version of the slot type.

value_elicitation_prompt: Option<Prompt>

The prompt that Amazon Lex uses to elicit the slot value from the user.

priority: Option<i32>

Directs Amazon Lex the order in which to elicit this slot value from the user. For example, if the intent has two slots with priorities 1 and 2, AWS Amazon Lex first elicits a value for the slot with priority 1.

If multiple slots share the same priority, the order in which Amazon Lex elicits values is arbitrary.

sample_utterances: Option<Vec<String>>

If you know a specific pattern with which users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.

response_card: Option<String>

A set of possible responses for the slot type used by text-based clients. A user chooses an option from the response card, instead of using text to reply.

obfuscation_setting: Option<ObfuscationSetting>

Determines whether a slot is obfuscated in conversation logs and stored utterances. When you obfuscate a slot, the value is replaced by the slot name in curly braces ({}). For example, if the slot name is "full_name", obfuscated values are replaced with "{full_name}". For more information, see Slot Obfuscation .

default_value_spec: Option<SlotDefaultValueSpec>

A list of default values for the slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.

Implementations

impl Slot

pub fn name(&self) -> &str

The name of the slot.

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

A description of the slot.

pub fn slot_constraint(&self) -> &SlotConstraint

Specifies whether the slot is required or optional.

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

The type of the slot, either a custom slot type that you defined or one of the built-in slot types.

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

The version of the slot type.

pub fn value_elicitation_prompt(&self) -> Option<&Prompt>

The prompt that Amazon Lex uses to elicit the slot value from the user.

pub fn priority(&self) -> Option<i32>

Directs Amazon Lex the order in which to elicit this slot value from the user. For example, if the intent has two slots with priorities 1 and 2, AWS Amazon Lex first elicits a value for the slot with priority 1.

If multiple slots share the same priority, the order in which Amazon Lex elicits values is arbitrary.

pub fn sample_utterances(&self) -> &[String]

If you know a specific pattern with which users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.

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

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

A set of possible responses for the slot type used by text-based clients. A user chooses an option from the response card, instead of using text to reply.

pub fn obfuscation_setting(&self) -> Option<&ObfuscationSetting>

Determines whether a slot is obfuscated in conversation logs and stored utterances. When you obfuscate a slot, the value is replaced by the slot name in curly braces ({}). For example, if the slot name is "full_name", obfuscated values are replaced with "{full_name}". For more information, see Slot Obfuscation .

pub fn default_value_spec(&self) -> Option<&SlotDefaultValueSpec>

A list of default values for the slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.

impl Slot

pub fn builder() -> SlotBuilder

Creates a new builder-style object to manufacture Slot.

Trait Implementations

impl Clone for Slot

fn clone(&self) -> Slot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Slot

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

Formats the value using the given formatter.

impl PartialEq for Slot

fn eq(&self, other: &Slot) -> 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 Slot