Interface CfnBot.SlotTypeProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnBot.SlotTypeProperty.Jsii$Proxy
- Enclosing class:
CfnBot
@Stability(Stable)
public static interface CfnBot.SlotTypeProperty
extends software.amazon.jsii.JsiiSerializable
Describes a slot type.
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.*; SlotTypeProperty slotTypeProperty = SlotTypeProperty.builder() .name("name") // the properties below are optional .description("description") .externalSourceSetting(ExternalSourceSettingProperty.builder() .grammarSlotTypeSetting(GrammarSlotTypeSettingProperty.builder() .source(GrammarSlotTypeSourceProperty.builder() .s3BucketName("s3BucketName") .s3ObjectKey("s3ObjectKey") // the properties below are optional .kmsKeyArn("kmsKeyArn") .build()) .build()) .build()) .parentSlotTypeSignature("parentSlotTypeSignature") .slotTypeValues(List.of(SlotTypeValueProperty.builder() .sampleValue(SampleValueProperty.builder() .value("value") .build()) // the properties below are optional .synonyms(List.of(SampleValueProperty.builder() .value("value") .build())) .build())) .valueSelectionSetting(SlotValueSelectionSettingProperty.builder() .resolutionStrategy("resolutionStrategy") // the properties below are optional .advancedRecognitionSetting(AdvancedRecognitionSettingProperty.builder() .audioRecognitionStrategy("audioRecognitionStrategy") .build()) .regexFilter(SlotValueRegexFilterProperty.builder() .pattern("pattern") .build()) .build()) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnBot.SlotTypeProperty
static final class
An implementation forCfnBot.SlotTypeProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
A description of the slot type.default Object
Sets the type of external information used to create the slot type.getName()
The name of the slot type.default String
The built-in slot type used as a parent of this slot type.default Object
A list of SlotTypeValue objects that defines the values that the slot type can take.default Object
Determines the slot resolution strategy that Amazon Lex uses to return slot type values.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getName
The name of the slot type.A slot type name must be unique withing the account.
-
getDescription
A description of the slot type.Use the description to help identify the slot type in lists.
-
getExternalSourceSetting
Sets the type of external information used to create the slot type. -
getParentSlotTypeSignature
The built-in slot type used as a parent of this slot type.When you define a parent slot type, the new slot type has the configuration of the parent lot type.
Only
AMAZON.AlphaNumeric
is supported. -
getSlotTypeValues
A list of SlotTypeValue objects that defines the values that the slot type can take.Each value can have a list of synonyms, additional values that help train the machine learning model about the values that it resolves for the slot.
-
getValueSelectionSetting
Determines the slot resolution strategy that Amazon Lex uses to return slot type values.The field can be set to one of the following values:
ORIGINAL_VALUE
- Returns the value entered by the user, if the user value is similar to the slot value.TOP_RESOLUTION
- If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.
If you don't specify the
valueSelectionStrategy
, the default isORIGINAL_VALUE
. -
builder
- Returns:
- a
CfnBot.SlotTypeProperty.Builder
ofCfnBot.SlotTypeProperty
-