putSlotType method
- required String name,
- String? checksum,
- bool? createVersion,
- String? description,
- List<
EnumerationValue> ? enumerationValues, - String? parentSlotTypeSignature,
- List<
SlotTypeConfiguration> ? slotTypeConfigurations, - SlotValueSelectionStrategy? valueSelectionStrategy,
Creates a custom slot type or replaces an existing custom slot type.
To create a custom slot type, specify a name for the slot type and a set of enumeration values, which are the values that a slot of this type can assume. For more information, see how-it-works.
If you specify the name of an existing slot type, the fields in the
request replace the existing values in the $LATEST
version of
the slot type. Amazon Lex removes the fields that you don't provide in the
request. If you don't specify required fields, Amazon Lex throws an
exception. When you update the $LATEST
version of a slot
type, if a bot uses the $LATEST
version of an intent that
contains the slot type, the bot's status
field is set to
NOT_BUILT
.
This operation requires permissions for the lex:PutSlotType
action.
May throw ConflictException. May throw LimitExceededException. May throw InternalFailureException. May throw BadRequestException. May throw PreconditionFailedException.
Parameter 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.
Parameter 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.
Parameter createVersion
:
When set to true
a new numbered version of the slot type is
created. This is the same as calling the
CreateSlotTypeVersion
operation. If you do not specify
createVersion
, the default is false
.
Parameter description
:
A description of the slot type.
Parameter 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.
A regular expression slot type doesn't require enumeration values. All other slot types require a list of enumeration values.
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.
Parameter parentSlotTypeSignature
:
The built-in slot type used as the parent of the slot type. When you
define a parent slot type, the new slot type has all of the same
configuration as the parent.
Only AMAZON.AlphaNumeric
is supported.
Parameter slotTypeConfigurations
:
Configuration information that extends the parent built-in slot type. The
configuration is added to the settings for the parent slot type.
Parameter 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.
valueSelectionStrategy
, the default
is ORIGINAL_VALUE
.
Implementation
Future<PutSlotTypeResponse> putSlotType({
required String name,
String? checksum,
bool? createVersion,
String? description,
List<EnumerationValue>? enumerationValues,
String? parentSlotTypeSignature,
List<SlotTypeConfiguration>? slotTypeConfigurations,
SlotValueSelectionStrategy? valueSelectionStrategy,
}) async {
ArgumentError.checkNotNull(name, 'name');
_s.validateStringLength(
'name',
name,
1,
100,
isRequired: true,
);
_s.validateStringLength(
'description',
description,
0,
200,
);
_s.validateStringLength(
'parentSlotTypeSignature',
parentSlotTypeSignature,
1,
100,
);
final $payload = <String, dynamic>{
if (checksum != null) 'checksum': checksum,
if (createVersion != null) 'createVersion': createVersion,
if (description != null) 'description': description,
if (enumerationValues != null) 'enumerationValues': enumerationValues,
if (parentSlotTypeSignature != null)
'parentSlotTypeSignature': parentSlotTypeSignature,
if (slotTypeConfigurations != null)
'slotTypeConfigurations': slotTypeConfigurations,
if (valueSelectionStrategy != null)
'valueSelectionStrategy': valueSelectionStrategy.toValue(),
};
final response = await _protocol.send(
payload: $payload,
method: 'PUT',
requestUri: '/slottypes/${Uri.encodeComponent(name)}/versions/%24LATEST',
exceptionFnMap: _exceptionFns,
);
return PutSlotTypeResponse.fromJson(response);
}