@Generated(value="software.amazon.awssdk:codegen") public final class PutSlotTypeRequest extends LexModelBuildingRequest implements ToCopyableBuilder<PutSlotTypeRequest.Builder,PutSlotTypeRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
PutSlotTypeRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static PutSlotTypeRequest.Builder |
builder() |
String |
checksum()
Identifies a specific revision of the
$LATEST version. |
String |
description()
A description of the slot type.
|
List<EnumerationValue> |
enumerationValues()
A list of
EnumerationValue objects that defines the values that the slot type can take. |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
name()
The name of the slot type.
|
static Class<? extends PutSlotTypeRequest.Builder> |
serializableBuilderClass() |
PutSlotTypeRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
SlotValueSelectionStrategy |
valueSelectionStrategy()
Determines the slot resolution strategy that Amazon Lex uses to return slot type values.
|
String |
valueSelectionStrategyAsString()
Determines the slot resolution strategy that Amazon Lex uses to return slot type values.
|
overrideConfiguration
copy
public String name()
The name of the slot type. The name is not case sensitive.
The name can't match a built-in slot type name, or a built-in slot type name with "AMAZON." removed. For example,
because there is a built-in slot type called AMAZON.DATE
, you can't create a custom slot type called
DATE
.
For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit.
The name can't match a built-in slot type name, or a built-in slot type name with "AMAZON." removed. For
example, because there is a built-in slot type called AMAZON.DATE
, you can't create a custom
slot type called DATE
.
For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit.
public String description()
A description of the slot type.
public List<EnumerationValue> enumerationValues()
A list of EnumerationValue
objects that defines the values that the slot type can take. Each value
can have a list of synonyms
, which are additional values that help train the machine learning model
about the values that it resolves for a slot.
When Amazon Lex resolves a slot value, it generates a resolution list that contains up to five possible values
for the slot. If you are using a Lambda function, this resolution list is passed to the function. If you are not
using a Lambda function you can choose to return the value that the user entered or the first value in the
resolution list as the slot value. The valueSelectionStrategy
field indicates the option to use.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
EnumerationValue
objects that defines the values that the slot type can take. Each
value can have a list of synonyms
, which are additional values that help train the machine
learning model about the values that it resolves for a slot.
When Amazon Lex resolves a slot value, it generates a resolution list that contains up to five possible
values for the slot. If you are using a Lambda function, this resolution list is passed to the function.
If you are not using a Lambda function you can choose to return the value that the user entered or the
first value in the resolution list as the slot value. The valueSelectionStrategy
field
indicates the option to use.
public String checksum()
Identifies a specific revision of the $LATEST
version.
When you create a new slot type, leave the checksum
field blank. If you specify a checksum you get a
BadRequestException
exception.
When you want to update a slot type, set the checksum
field to the checksum of the most recent
revision of the $LATEST
version. If you don't specify the checksum
field, or if the
checksum does not match the $LATEST
version, you get a PreconditionFailedException
exception.
$LATEST
version.
When you create a new slot type, leave the checksum
field blank. If you specify a checksum
you get a BadRequestException
exception.
When you want to update a slot type, set the checksum
field to the checksum of the most
recent revision of the $LATEST
version. If you don't specify the checksum
field, or if the checksum does not match the $LATEST
version, you get a
PreconditionFailedException
exception.
public SlotValueSelectionStrategy valueSelectionStrategy()
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 is ORIGINAL_VALUE
.
If the service returns an enum value that is not available in the current SDK version,
valueSelectionStrategy
will return SlotValueSelectionStrategy.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from valueSelectionStrategyAsString()
.
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 is ORIGINAL_VALUE
.
SlotValueSelectionStrategy
public String valueSelectionStrategyAsString()
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 is ORIGINAL_VALUE
.
If the service returns an enum value that is not available in the current SDK version,
valueSelectionStrategy
will return SlotValueSelectionStrategy.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from valueSelectionStrategyAsString()
.
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 is ORIGINAL_VALUE
.
SlotValueSelectionStrategy
public PutSlotTypeRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<PutSlotTypeRequest.Builder,PutSlotTypeRequest>
toBuilder
in class LexModelBuildingRequest
public static PutSlotTypeRequest.Builder builder()
public static Class<? extends PutSlotTypeRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.