Package software.amazon.awscdk.services.lex

Interface CfnBot.SubSlotValueElicitationSettingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBot.SubSlotValueElicitationSettingProperty.Jsii$Proxy

Enclosing class:

CfnBot

@Stability(Stable)
public static interface CfnBot.SubSlotValueElicitationSettingProperty
extends software.amazon.jsii.JsiiSerializable

Subslot elicitation settings.

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:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnBot.SubSlotValueElicitationSettingProperty.Builder	A builder for CfnBot.SubSlotValueElicitationSettingProperty
static final class	CfnBot.SubSlotValueElicitationSettingProperty.Jsii$Proxy	An implementation for CfnBot.SubSlotValueElicitationSettingProperty

Method Summary

Modifier and Type	Method	Description
static CfnBot.SubSlotValueElicitationSettingProperty.Builder	builder()
default Object	getDefaultValueSpecification()
default Object	getPromptSpecification()
default Object	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.
default Object	getWaitAndContinueSpecification()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDefaultValueSpecification

@Stability(Stable)
@Nullable
default Object getDefaultValueSpecification()

See Also:

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

getPromptSpecification

@Stability(Stable)
@Nullable
default Object getPromptSpecification()

See Also:

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

getSampleUtterances

@Stability(Stable)
@Nullable
default Object 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 SampleUtterances for slots.

See Also:

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

getWaitAndContinueSpecification

@Stability(Stable)
@Nullable
default Object getWaitAndContinueSpecification()

See Also:

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

builder

@Stability(Stable)
static CfnBot.SubSlotValueElicitationSettingProperty.Builder builder()

Returns:

a CfnBot.SubSlotValueElicitationSettingProperty.Builder of CfnBot.SubSlotValueElicitationSettingProperty