Package software.amazon.awssdk.services.lexmodelbuilding.model

Interface PutSlotTypeRequest.Builder

    • Method Detail

      • name

        PutSlotTypeRequest.Builder name​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        PutSlotTypeRequest.Builder description​(String description)

        A description of the slot type.

        Parameters:
        description - A description of the slot type.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enumerationValues

        PutSlotTypeRequest.Builder enumerationValues​(Collection<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.

        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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enumerationValues

        PutSlotTypeRequest.Builder enumerationValues​(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.

        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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enumerationValues

        PutSlotTypeRequest.Builder enumerationValues​(Consumer<EnumerationValue.Builder>... 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.

        This is a convenience method that creates an instance of the EnumerationValue.Builder avoiding the need to create one manually via EnumerationValue.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #enumerationValues(List).

        Parameters:
        enumerationValues - a consumer that will call methods on EnumerationValue.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #enumerationValues(java.util.Collection)

      • checksum

        PutSlotTypeRequest.Builder checksum​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • valueSelectionStrategy

        PutSlotTypeRequest.Builder valueSelectionStrategy​(String 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SlotValueSelectionStrategy, SlotValueSelectionStrategy

      • valueSelectionStrategy

        PutSlotTypeRequest.Builder valueSelectionStrategy​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SlotValueSelectionStrategy, SlotValueSelectionStrategy

      • createVersion

        PutSlotTypeRequest.Builder createVersion​(Boolean 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • parentSlotTypeSignature

        PutSlotTypeRequest.Builder parentSlotTypeSignature​(String 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • slotTypeConfigurations

        PutSlotTypeRequest.Builder slotTypeConfigurations​(Collection<SlotTypeConfiguration> slotTypeConfigurations)

        Configuration information that extends the parent built-in slot type. The configuration is added to the settings for the parent slot type.

        Parameters:
        slotTypeConfigurations - Configuration information that extends the parent built-in slot type. The configuration is added to the settings for the parent slot type.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • slotTypeConfigurations

        PutSlotTypeRequest.Builder slotTypeConfigurations​(SlotTypeConfiguration... slotTypeConfigurations)

        Configuration information that extends the parent built-in slot type. The configuration is added to the settings for the parent slot type.

        Parameters:
        slotTypeConfigurations - Configuration information that extends the parent built-in slot type. The configuration is added to the settings for the parent slot type.
        Returns:
        Returns a reference to this object so that method calls can be chained together.