Class CfnBot.SubSlotValueElicitationSettingProperty

Subslot elicitation settings.

Inheritance

object

CfnBot.SubSlotValueElicitationSettingProperty

Implements

CfnBot.ISubSlotValueElicitationSettingProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Lex

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnBot.SubSlotValueElicitationSettingProperty : CfnBot.ISubSlotValueElicitationSettingProperty

Syntax (vb)

Public Class CfnBot.SubSlotValueElicitationSettingProperty Implements CfnBot.ISubSlotValueElicitationSettingProperty

Remarks

DefaultValueSpecification is a list of default values for a constituent sub slot in a composite 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. This is similar to DefaultValueSpecification for slots.

PromptSpecification is the prompt that Amazon Lex uses to elicit the sub slot value from the user. This is similar to PromptSpecification for slots.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-subslotvalueelicitationsetting.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Lex;

             var subSlotValueElicitationSettingProperty = new SubSlotValueElicitationSettingProperty {
                 DefaultValueSpecification = new SlotDefaultValueSpecificationProperty {
                     DefaultValueList = new [] { new SlotDefaultValueProperty {
                         DefaultValue = "defaultValue"
                     } }
                 },
                 PromptSpecification = new PromptSpecificationProperty {
                     MaxRetries = 123,
                     MessageGroupsList = new [] { new MessageGroupProperty {
                         Message = new MessageProperty {
                             CustomPayload = new CustomPayloadProperty {
                                 Value = "value"
                             },
                             ImageResponseCard = new ImageResponseCardProperty {
                                 Title = "title",

                                 // the properties below are optional
                                 Buttons = new [] { new ButtonProperty {
                                     Text = "text",
                                     Value = "value"
                                 } },
                                 ImageUrl = "imageUrl",
                                 Subtitle = "subtitle"
                             },
                             PlainTextMessage = new PlainTextMessageProperty {
                                 Value = "value"
                             },
                             SsmlMessage = new SSMLMessageProperty {
                                 Value = "value"
                             }
                         },

                         // the properties below are optional
                         Variations = new [] { new MessageProperty {
                             CustomPayload = new CustomPayloadProperty {
                                 Value = "value"
                             },
                             ImageResponseCard = new ImageResponseCardProperty {
                                 Title = "title",

                                 // the properties below are optional
                                 Buttons = new [] { new ButtonProperty {
                                     Text = "text",
                                     Value = "value"
                                 } },
                                 ImageUrl = "imageUrl",
                                 Subtitle = "subtitle"
                             },
                             PlainTextMessage = new PlainTextMessageProperty {
                                 Value = "value"
                             },
                             SsmlMessage = new SSMLMessageProperty {
                                 Value = "value"
                             }
                         } }
                     } },

                     // the properties below are optional
                     AllowInterrupt = false,
                     MessageSelectionStrategy = "messageSelectionStrategy",
                     PromptAttemptsSpecification = new Dictionary<string, object> {
                         { "promptAttemptsSpecificationKey", new PromptAttemptSpecificationProperty {
                             AllowedInputTypes = new AllowedInputTypesProperty {
                                 AllowAudioInput = false,
                                 AllowDtmfInput = false
                             },

                             // the properties below are optional
                             AllowInterrupt = false,
                             AudioAndDtmfInputSpecification = new AudioAndDTMFInputSpecificationProperty {
                                 StartTimeoutMs = 123,

                                 // the properties below are optional
                                 AudioSpecification = new AudioSpecificationProperty {
                                     EndTimeoutMs = 123,
                                     MaxLengthMs = 123
                                 },
                                 DtmfSpecification = new DTMFSpecificationProperty {
                                     DeletionCharacter = "deletionCharacter",
                                     EndCharacter = "endCharacter",
                                     EndTimeoutMs = 123,
                                     MaxLength = 123
                                 }
                             },
                             TextInputSpecification = new TextInputSpecificationProperty {
                                 StartTimeoutMs = 123
                             }
                         } }
                     }
                 },
                 SampleUtterances = new [] { new SampleUtteranceProperty {
                     Utterance = "utterance"
                 } },
                 WaitAndContinueSpecification = new WaitAndContinueSpecificationProperty {
                     ContinueResponse = new ResponseSpecificationProperty {
                         MessageGroupsList = new [] { new MessageGroupProperty {
                             Message = new MessageProperty {
                                 CustomPayload = new CustomPayloadProperty {
                                     Value = "value"
                                 },
                                 ImageResponseCard = new ImageResponseCardProperty {
                                     Title = "title",

                                     // the properties below are optional
                                     Buttons = new [] { new ButtonProperty {
                                         Text = "text",
                                         Value = "value"
                                     } },
                                     ImageUrl = "imageUrl",
                                     Subtitle = "subtitle"
                                 },
                                 PlainTextMessage = new PlainTextMessageProperty {
                                     Value = "value"
                                 },
                                 SsmlMessage = new SSMLMessageProperty {
                                     Value = "value"
                                 }
                             },

                             // the properties below are optional
                             Variations = new [] { new MessageProperty {
                                 CustomPayload = new CustomPayloadProperty {
                                     Value = "value"
                                 },
                                 ImageResponseCard = new ImageResponseCardProperty {
                                     Title = "title",

                                     // the properties below are optional
                                     Buttons = new [] { new ButtonProperty {
                                         Text = "text",
                                         Value = "value"
                                     } },
                                     ImageUrl = "imageUrl",
                                     Subtitle = "subtitle"
                                 },
                                 PlainTextMessage = new PlainTextMessageProperty {
                                     Value = "value"
                                 },
                                 SsmlMessage = new SSMLMessageProperty {
                                     Value = "value"
                                 }
                             } }
                         } },

                         // the properties below are optional
                         AllowInterrupt = false
                     },
                     WaitingResponse = new ResponseSpecificationProperty {
                         MessageGroupsList = new [] { new MessageGroupProperty {
                             Message = new MessageProperty {
                                 CustomPayload = new CustomPayloadProperty {
                                     Value = "value"
                                 },
                                 ImageResponseCard = new ImageResponseCardProperty {
                                     Title = "title",

                                     // the properties below are optional
                                     Buttons = new [] { new ButtonProperty {
                                         Text = "text",
                                         Value = "value"
                                     } },
                                     ImageUrl = "imageUrl",
                                     Subtitle = "subtitle"
                                 },
                                 PlainTextMessage = new PlainTextMessageProperty {
                                     Value = "value"
                                 },
                                 SsmlMessage = new SSMLMessageProperty {
                                     Value = "value"
                                 }
                             },

                             // the properties below are optional
                             Variations = new [] { new MessageProperty {
                                 CustomPayload = new CustomPayloadProperty {
                                     Value = "value"
                                 },
                                 ImageResponseCard = new ImageResponseCardProperty {
                                     Title = "title",

                                     // the properties below are optional
                                     Buttons = new [] { new ButtonProperty {
                                         Text = "text",
                                         Value = "value"
                                     } },
                                     ImageUrl = "imageUrl",
                                     Subtitle = "subtitle"
                                 },
                                 PlainTextMessage = new PlainTextMessageProperty {
                                     Value = "value"
                                 },
                                 SsmlMessage = new SSMLMessageProperty {
                                     Value = "value"
                                 }
                             } }
                         } },

                         // the properties below are optional
                         AllowInterrupt = false
                     },

                     // the properties below are optional
                     IsActive = false,
                     StillWaitingResponse = new StillWaitingResponseSpecificationProperty {
                         FrequencyInSeconds = 123,
                         MessageGroupsList = new [] { new MessageGroupProperty {
                             Message = new MessageProperty {
                                 CustomPayload = new CustomPayloadProperty {
                                     Value = "value"
                                 },
                                 ImageResponseCard = new ImageResponseCardProperty {
                                     Title = "title",

                                     // the properties below are optional
                                     Buttons = new [] { new ButtonProperty {
                                         Text = "text",
                                         Value = "value"
                                     } },
                                     ImageUrl = "imageUrl",
                                     Subtitle = "subtitle"
                                 },
                                 PlainTextMessage = new PlainTextMessageProperty {
                                     Value = "value"
                                 },
                                 SsmlMessage = new SSMLMessageProperty {
                                     Value = "value"
                                 }
                             },

                             // the properties below are optional
                             Variations = new [] { new MessageProperty {
                                 CustomPayload = new CustomPayloadProperty {
                                     Value = "value"
                                 },
                                 ImageResponseCard = new ImageResponseCardProperty {
                                     Title = "title",

                                     // the properties below are optional
                                     Buttons = new [] { new ButtonProperty {
                                         Text = "text",
                                         Value = "value"
                                     } },
                                     ImageUrl = "imageUrl",
                                     Subtitle = "subtitle"
                                 },
                                 PlainTextMessage = new PlainTextMessageProperty {
                                     Value = "value"
                                 },
                                 SsmlMessage = new SSMLMessageProperty {
                                     Value = "value"
                                 }
                             } }
                         } },
                         TimeoutInSeconds = 123,

                         // the properties below are optional
                         AllowInterrupt = false
                     }
                 }
             };

Synopsis

Constructors

SubSlotValueElicitationSettingProperty()

Subslot elicitation settings.

Properties

DefaultValueSpecification	Subslot elicitation settings.
PromptSpecification	Subslot elicitation settings.
SampleUtterances	If you know a specific pattern that users might respond to an Amazon Lex request for a sub slot value, you can provide those utterances to improve accuracy.
WaitAndContinueSpecification	Subslot elicitation settings.

Constructors

SubSlotValueElicitationSettingProperty()

Subslot elicitation settings.

public SubSlotValueElicitationSettingProperty()

Remarks

DefaultValueSpecification is a list of default values for a constituent sub slot in a composite 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. This is similar to DefaultValueSpecification for slots.

PromptSpecification is the prompt that Amazon Lex uses to elicit the sub slot value from the user. This is similar to PromptSpecification for slots.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-subslotvalueelicitationsetting.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Lex;

             var subSlotValueElicitationSettingProperty = new SubSlotValueElicitationSettingProperty {
                 DefaultValueSpecification = new SlotDefaultValueSpecificationProperty {
                     DefaultValueList = new [] { new SlotDefaultValueProperty {
                         DefaultValue = "defaultValue"
                     } }
                 },
                 PromptSpecification = new PromptSpecificationProperty {
                     MaxRetries = 123,
                     MessageGroupsList = new [] { new MessageGroupProperty {
                         Message = new MessageProperty {
                             CustomPayload = new CustomPayloadProperty {
                                 Value = "value"
                             },
                             ImageResponseCard = new ImageResponseCardProperty {
                                 Title = "title",

                                 // the properties below are optional
                                 Buttons = new [] { new ButtonProperty {
                                     Text = "text",
                                     Value = "value"
                                 } },
                                 ImageUrl = "imageUrl",
                                 Subtitle = "subtitle"
                             },
                             PlainTextMessage = new PlainTextMessageProperty {
                                 Value = "value"
                             },
                             SsmlMessage = new SSMLMessageProperty {
                                 Value = "value"
                             }
                         },

                         // the properties below are optional
                         Variations = new [] { new MessageProperty {
                             CustomPayload = new CustomPayloadProperty {
                                 Value = "value"
                             },
                             ImageResponseCard = new ImageResponseCardProperty {
                                 Title = "title",

                                 // the properties below are optional
                                 Buttons = new [] { new ButtonProperty {
                                     Text = "text",
                                     Value = "value"
                                 } },
                                 ImageUrl = "imageUrl",
                                 Subtitle = "subtitle"
                             },
                             PlainTextMessage = new PlainTextMessageProperty {
                                 Value = "value"
                             },
                             SsmlMessage = new SSMLMessageProperty {
                                 Value = "value"
                             }
                         } }
                     } },

                     // the properties below are optional
                     AllowInterrupt = false,
                     MessageSelectionStrategy = "messageSelectionStrategy",
                     PromptAttemptsSpecification = new Dictionary<string, object> {
                         { "promptAttemptsSpecificationKey", new PromptAttemptSpecificationProperty {
                             AllowedInputTypes = new AllowedInputTypesProperty {
                                 AllowAudioInput = false,
                                 AllowDtmfInput = false
                             },

                             // the properties below are optional
                             AllowInterrupt = false,
                             AudioAndDtmfInputSpecification = new AudioAndDTMFInputSpecificationProperty {
                                 StartTimeoutMs = 123,

                                 // the properties below are optional
                                 AudioSpecification = new AudioSpecificationProperty {
                                     EndTimeoutMs = 123,
                                     MaxLengthMs = 123
                                 },
                                 DtmfSpecification = new DTMFSpecificationProperty {
                                     DeletionCharacter = "deletionCharacter",
                                     EndCharacter = "endCharacter",
                                     EndTimeoutMs = 123,
                                     MaxLength = 123
                                 }
                             },
                             TextInputSpecification = new TextInputSpecificationProperty {
                                 StartTimeoutMs = 123
                             }
                         } }
                     }
                 },
                 SampleUtterances = new [] { new SampleUtteranceProperty {
                     Utterance = "utterance"
                 } },
                 WaitAndContinueSpecification = new WaitAndContinueSpecificationProperty {
                     ContinueResponse = new ResponseSpecificationProperty {
                         MessageGroupsList = new [] { new MessageGroupProperty {
                             Message = new MessageProperty {
                                 CustomPayload = new CustomPayloadProperty {
                                     Value = "value"
                                 },
                                 ImageResponseCard = new ImageResponseCardProperty {
                                     Title = "title",

                                     // the properties below are optional
                                     Buttons = new [] { new ButtonProperty {
                                         Text = "text",
                                         Value = "value"
                                     } },
                                     ImageUrl = "imageUrl",
                                     Subtitle = "subtitle"
                                 },
                                 PlainTextMessage = new PlainTextMessageProperty {
                                     Value = "value"
                                 },
                                 SsmlMessage = new SSMLMessageProperty {
                                     Value = "value"
                                 }
                             },

                             // the properties below are optional
                             Variations = new [] { new MessageProperty {
                                 CustomPayload = new CustomPayloadProperty {
                                     Value = "value"
                                 },
                                 ImageResponseCard = new ImageResponseCardProperty {
                                     Title = "title",

                                     // the properties below are optional
                                     Buttons = new [] { new ButtonProperty {
                                         Text = "text",
                                         Value = "value"
                                     } },
                                     ImageUrl = "imageUrl",
                                     Subtitle = "subtitle"
                                 },
                                 PlainTextMessage = new PlainTextMessageProperty {
                                     Value = "value"
                                 },
                                 SsmlMessage = new SSMLMessageProperty {
                                     Value = "value"
                                 }
                             } }
                         } },

                         // the properties below are optional
                         AllowInterrupt = false
                     },
                     WaitingResponse = new ResponseSpecificationProperty {
                         MessageGroupsList = new [] { new MessageGroupProperty {
                             Message = new MessageProperty {
                                 CustomPayload = new CustomPayloadProperty {
                                     Value = "value"
                                 },
                                 ImageResponseCard = new ImageResponseCardProperty {
                                     Title = "title",

                                     // the properties below are optional
                                     Buttons = new [] { new ButtonProperty {
                                         Text = "text",
                                         Value = "value"
                                     } },
                                     ImageUrl = "imageUrl",
                                     Subtitle = "subtitle"
                                 },
                                 PlainTextMessage = new PlainTextMessageProperty {
                                     Value = "value"
                                 },
                                 SsmlMessage = new SSMLMessageProperty {
                                     Value = "value"
                                 }
                             },

                             // the properties below are optional
                             Variations = new [] { new MessageProperty {
                                 CustomPayload = new CustomPayloadProperty {
                                     Value = "value"
                                 },
                                 ImageResponseCard = new ImageResponseCardProperty {
                                     Title = "title",

                                     // the properties below are optional
                                     Buttons = new [] { new ButtonProperty {
                                         Text = "text",
                                         Value = "value"
                                     } },
                                     ImageUrl = "imageUrl",
                                     Subtitle = "subtitle"
                                 },
                                 PlainTextMessage = new PlainTextMessageProperty {
                                     Value = "value"
                                 },
                                 SsmlMessage = new SSMLMessageProperty {
                                     Value = "value"
                                 }
                             } }
                         } },

                         // the properties below are optional
                         AllowInterrupt = false
                     },

                     // the properties below are optional
                     IsActive = false,
                     StillWaitingResponse = new StillWaitingResponseSpecificationProperty {
                         FrequencyInSeconds = 123,
                         MessageGroupsList = new [] { new MessageGroupProperty {
                             Message = new MessageProperty {
                                 CustomPayload = new CustomPayloadProperty {
                                     Value = "value"
                                 },
                                 ImageResponseCard = new ImageResponseCardProperty {
                                     Title = "title",

                                     // the properties below are optional
                                     Buttons = new [] { new ButtonProperty {
                                         Text = "text",
                                         Value = "value"
                                     } },
                                     ImageUrl = "imageUrl",
                                     Subtitle = "subtitle"
                                 },
                                 PlainTextMessage = new PlainTextMessageProperty {
                                     Value = "value"
                                 },
                                 SsmlMessage = new SSMLMessageProperty {
                                     Value = "value"
                                 }
                             },

                             // the properties below are optional
                             Variations = new [] { new MessageProperty {
                                 CustomPayload = new CustomPayloadProperty {
                                     Value = "value"
                                 },
                                 ImageResponseCard = new ImageResponseCardProperty {
                                     Title = "title",

                                     // the properties below are optional
                                     Buttons = new [] { new ButtonProperty {
                                         Text = "text",
                                         Value = "value"
                                     } },
                                     ImageUrl = "imageUrl",
                                     Subtitle = "subtitle"
                                 },
                                 PlainTextMessage = new PlainTextMessageProperty {
                                     Value = "value"
                                 },
                                 SsmlMessage = new SSMLMessageProperty {
                                     Value = "value"
                                 }
                             } }
                         } },
                         TimeoutInSeconds = 123,

                         // the properties below are optional
                         AllowInterrupt = false
                     }
                 }
             };

Properties

DefaultValueSpecification

Subslot elicitation settings.

public object? DefaultValueSpecification { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-subslotvalueelicitationsetting.html#cfn-lex-bot-subslotvalueelicitationsetting-defaultvaluespecification

PromptSpecification

Subslot elicitation settings.

public object? PromptSpecification { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-subslotvalueelicitationsetting.html#cfn-lex-bot-subslotvalueelicitationsetting-promptspecification

SampleUtterances

If you know a specific pattern that users might respond to an Amazon Lex request for a sub slot value, you can provide those utterances to improve accuracy.

public object? SampleUtterances { get; set; }

Property Value

object

Remarks

This is optional. In most cases Amazon Lex is capable of understanding user utterances. This is similar to SampleUtterances for slots.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-subslotvalueelicitationsetting.html#cfn-lex-bot-subslotvalueelicitationsetting-sampleutterances

WaitAndContinueSpecification

Subslot elicitation settings.

public object? WaitAndContinueSpecification { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-subslotvalueelicitationsetting.html#cfn-lex-bot-subslotvalueelicitationsetting-waitandcontinuespecification

Implements

CfnBot.ISubSlotValueElicitationSettingProperty