software.amazon.awscdk.services.lex

Interface CfnBot.SlotValueElicitationSettingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBot.SlotValueElicitationSettingProperty.Jsii$Proxy

Enclosing class:

CfnBot

@Stability(value=Stable)
public static interface CfnBot.SlotValueElicitationSettingProperty
extends software.amazon.jsii.JsiiSerializable

Settings that you can use for eliciting a slot value.

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.*;
 SlotValueElicitationSettingProperty slotValueElicitationSettingProperty = SlotValueElicitationSettingProperty.builder()
         .slotConstraint("slotConstraint")
         // the properties below are optional
         .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")
                 .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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnBot.SlotValueElicitationSettingProperty.Builder	builder()
default Object	getDefaultValueSpecification() A list of default values for a slot.
default Object	getPromptSpecification() The prompt that Amazon Lex uses to elicit the slot value from the user.
default Object	getSampleUtterances() If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy.
String	getSlotConstraint() Specifies whether the slot is required or optional.
default Object	getWaitAndContinueSpecification() Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getSlotConstraint

@Stability(value=Stable)
 @NotNull
String getSlotConstraint()

Specifies whether the slot is required or optional.

getDefaultValueSpecification

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

A list of default values for a 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.

getPromptSpecification

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

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

getSampleUtterances

@Stability(value=Stable)
 @Nullable
default Object getSampleUtterances()

If you know a specific pattern that 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.

getWaitAndContinueSpecification

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

Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.

builder

@Stability(value=Stable)
static CfnBot.SlotValueElicitationSettingProperty.Builder builder()

Returns:

a CfnBot.SlotValueElicitationSettingProperty.Builder of CfnBot.SlotValueElicitationSettingProperty