Interface CfnBot.SubSlotValueElicitationSettingProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnBot.SubSlotValueElicitationSettingProperty.Jsii$Proxy
- Enclosing class:
CfnBot
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.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.lex.*;
SubSlotValueElicitationSettingProperty subSlotValueElicitationSettingProperty = SubSlotValueElicitationSettingProperty.builder()
.defaultValueSpecification(SlotDefaultValueSpecificationProperty.builder()
.defaultValueList(List.of(SlotDefaultValueProperty.builder()
.defaultValue("defaultValue")
.build()))
.build())
.promptSpecification(PromptSpecificationProperty.builder()
.maxRetries(123)
.messageGroupsList(List.of(MessageGroupProperty.builder()
.message(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build())
// the properties below are optional
.variations(List.of(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build()))
.build()))
// the properties below are optional
.allowInterrupt(false)
.messageSelectionStrategy("messageSelectionStrategy")
.promptAttemptsSpecification(Map.of(
"promptAttemptsSpecificationKey", PromptAttemptSpecificationProperty.builder()
.allowedInputTypes(AllowedInputTypesProperty.builder()
.allowAudioInput(false)
.allowDtmfInput(false)
.build())
// the properties below are optional
.allowInterrupt(false)
.audioAndDtmfInputSpecification(AudioAndDTMFInputSpecificationProperty.builder()
.startTimeoutMs(123)
// the properties below are optional
.audioSpecification(AudioSpecificationProperty.builder()
.endTimeoutMs(123)
.maxLengthMs(123)
.build())
.dtmfSpecification(DTMFSpecificationProperty.builder()
.deletionCharacter("deletionCharacter")
.endCharacter("endCharacter")
.endTimeoutMs(123)
.maxLength(123)
.build())
.build())
.textInputSpecification(TextInputSpecificationProperty.builder()
.startTimeoutMs(123)
.build())
.build()))
.build())
.sampleUtterances(List.of(SampleUtteranceProperty.builder()
.utterance("utterance")
.build()))
.waitAndContinueSpecification(WaitAndContinueSpecificationProperty.builder()
.continueResponse(ResponseSpecificationProperty.builder()
.messageGroupsList(List.of(MessageGroupProperty.builder()
.message(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build())
// the properties below are optional
.variations(List.of(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build()))
.build()))
// the properties below are optional
.allowInterrupt(false)
.build())
.waitingResponse(ResponseSpecificationProperty.builder()
.messageGroupsList(List.of(MessageGroupProperty.builder()
.message(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build())
// the properties below are optional
.variations(List.of(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build()))
.build()))
// the properties below are optional
.allowInterrupt(false)
.build())
// the properties below are optional
.isActive(false)
.stillWaitingResponse(StillWaitingResponseSpecificationProperty.builder()
.frequencyInSeconds(123)
.messageGroupsList(List.of(MessageGroupProperty.builder()
.message(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build())
// the properties below are optional
.variations(List.of(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build()))
.build()))
.timeoutInSeconds(123)
// the properties below are optional
.allowInterrupt(false)
.build())
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnBot.SubSlotValueElicitationSettingPropertystatic final classAn implementation forCfnBot.SubSlotValueElicitationSettingProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectReturns union: eitherIResolvableorCfnBot.SlotDefaultValueSpecificationPropertydefault ObjectReturns union: eitherIResolvableorCfnBot.PromptSpecificationPropertydefault ObjectIf 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.default ObjectReturns union: eitherIResolvableorCfnBot.WaitAndContinueSpecificationPropertyMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDefaultValueSpecification
Returns union: eitherIResolvableorCfnBot.SlotDefaultValueSpecificationProperty- See Also:
-
getPromptSpecification
Returns union: eitherIResolvableorCfnBot.PromptSpecificationProperty- See Also:
-
getSampleUtterances
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.This is optional. In most cases Amazon Lex is capable of understanding user utterances. This is similar to
SampleUtterancesfor slots.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnBot.SampleUtteranceProperty>- See Also:
-
getWaitAndContinueSpecification
Returns union: eitherIResolvableorCfnBot.WaitAndContinueSpecificationProperty- See Also:
-
builder
-