AWS API Changes

2017/08/31 - Amazon Lex Model Building Service - 3 updated api methods

CreateSlotTypeVersion (updated)

Link ¶
Changes (response)

{'enumerationValues': {'synonyms': ['string']},
 'valueSelectionStrategy': 'ORIGINAL_VALUE | TOP_RESOLUTION'}

Creates a new version of a slot type based on the $LATEST version of the specified slot type. If the $LATEST version of this resource has not changed since the last version that you created, Amazon Lex doesn't create a new version. It returns the last version that you created.

Note

You can update only the $LATEST version of a slot type. You can't update the numbered versions that you create with the CreateSlotTypeVersion operation.

When you create a version of a slot type, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro .

This operation requires permissions for the lex:CreateSlotTypeVersion action.

See also: AWS API Documentation

Request Syntax

client.create_slot_type_version(
    name='string',
    checksum='string'
)

type name

string

param name

[REQUIRED]

The name of the slot type that you want to create a new version for. The name is case sensitive.

type checksum

string

param checksum

Checksum for the $LATEST version of the slot type that you want to publish. If you specify a checksum and the $LATEST version of the slot type has a different checksum, Amazon Lex returns a PreconditionFailedException exception and doesn't publish the new version. If you don't specify a checksum, Amazon Lex publishes the $LATEST version.

rtype

dict

returns

Response Syntax

{
    'name': 'string',
    'description': 'string',
    'enumerationValues': [
        {
            'value': 'string',
            'synonyms': [
                'string',
            ]
        },
    ],
    'lastUpdatedDate': datetime(2015, 1, 1),
    'createdDate': datetime(2015, 1, 1),
    'version': 'string',
    'checksum': 'string',
    'valueSelectionStrategy': 'ORIGINAL_VALUE'|'TOP_RESOLUTION'
}

Response Structure

(dict) --
- name (string) --
  
  The name of the slot type.
- description (string) --
  
  A description of the slot type.
- enumerationValues (list) --
  
  A list of EnumerationValue objects that defines the values that the slot type can take.
  - (dict) --
    
    Each slot type can have a set of values. Each enumeration value represents a value the slot type can take.
    
    For example, a pizza ordering bot could have a slot type that specifies the type of crust that the pizza should have. The slot type could include the values
    - thick
    - thin
    - stuffed
    - value (string) --
      
      The value of the slot type.
    - synonyms (list) --
      
      Additional values related to the slot type value.
      - (string) --
- lastUpdatedDate (datetime) --
  
  The date that the slot type was updated. When you create a resource, the creation date and last update date are the same.
- createdDate (datetime) --
  
  The date that the slot type was created.
- version (string) --
  
  The version assigned to the new slot type version.
- checksum (string) --
  
  Checksum of the $LATEST version of the slot type.
- valueSelectionStrategy (string) --
  
  The strategy that Amazon Lex uses to determine the value of the slot. For more information, see PutSlotType .

GetSlotType (updated)

Link ¶
Changes (response)

{'enumerationValues': {'synonyms': ['string']},
 'valueSelectionStrategy': 'ORIGINAL_VALUE | TOP_RESOLUTION'}

Returns information about a specific version of a slot type. In addition to specifying the slot type name, you must specify the slot type version.

This operation requires permissions for the lex:GetSlotType action.

See also: AWS API Documentation

Request Syntax

client.get_slot_type(
    name='string',
    version='string'
)

type name

string

param name

[REQUIRED]

The name of the slot type. The name is case sensitive.

type version

string

param version

[REQUIRED]

The version of the slot type.

rtype

dict

returns

Response Syntax

{
    'name': 'string',
    'description': 'string',
    'enumerationValues': [
        {
            'value': 'string',
            'synonyms': [
                'string',
            ]
        },
    ],
    'lastUpdatedDate': datetime(2015, 1, 1),
    'createdDate': datetime(2015, 1, 1),
    'version': 'string',
    'checksum': 'string',
    'valueSelectionStrategy': 'ORIGINAL_VALUE'|'TOP_RESOLUTION'
}

Response Structure

(dict) --
- name (string) --
  
  The name of the slot type.
- description (string) --
  
  A description of the slot type.
- enumerationValues (list) --
  
  A list of EnumerationValue objects that defines the values that the slot type can take.
  - (dict) --
    
    Each slot type can have a set of values. Each enumeration value represents a value the slot type can take.
    
    For example, a pizza ordering bot could have a slot type that specifies the type of crust that the pizza should have. The slot type could include the values
    - thick
    - thin
    - stuffed
    - value (string) --
      
      The value of the slot type.
    - synonyms (list) --
      
      Additional values related to the slot type value.
      - (string) --
- lastUpdatedDate (datetime) --
  
  The date that the slot type was updated. When you create a resource, the creation date and last update date are the same.
- createdDate (datetime) --
  
  The date that the slot type was created.
- version (string) --
  
  The version of the slot type.
- checksum (string) --
  
  Checksum of the $LATEST version of the slot type.
- valueSelectionStrategy (string) --
  
  The strategy that Amazon Lex uses to determine the value of the slot. For more information, see PutSlotType .

PutSlotType (updated)

Link ¶
Changes (both)

{'enumerationValues': {'synonyms': ['string']},
 'valueSelectionStrategy': 'ORIGINAL_VALUE | TOP_RESOLUTION'}

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.

This operation requires permissions for the lex:PutSlotType action.

See also: AWS API Documentation

Request Syntax

client.put_slot_type(
    name='string',
    description='string',
    enumerationValues=[
        {
            'value': 'string',
            'synonyms': [
                'string',
            ]
        },
    ],
    checksum='string',
    valueSelectionStrategy='ORIGINAL_VALUE'|'TOP_RESOLUTION'
)

type name

string

param name

[REQUIRED]

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 .

type description

string

param description

A description of the slot type.

type enumerationValues

list

param 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.

(dict) --

Each slot type can have a set of values. Each enumeration value represents a value the slot type can take.

For example, a pizza ordering bot could have a slot type that specifies the type of crust that the pizza should have. The slot type could include the values
- thick
- thin
- stuffed
- value (string) -- [REQUIRED]
  
  The value of the slot type.
- synonyms (list) --
  
  Additional values related to the slot type value.
  - (string) --

type checksum

string

param 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.

type valueSelectionStrategy

string

param valueSelectionStrategy

Determines the 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.
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 is not provided, the default is ORIGINAL_VALUE .

rtype

dict

returns

Response Syntax

{
    'name': 'string',
    'description': 'string',
    'enumerationValues': [
        {
            'value': 'string',
            'synonyms': [
                'string',
            ]
        },
    ],
    'lastUpdatedDate': datetime(2015, 1, 1),
    'createdDate': datetime(2015, 1, 1),
    'version': 'string',
    'checksum': 'string',
    'valueSelectionStrategy': 'ORIGINAL_VALUE'|'TOP_RESOLUTION'
}

Response Structure

(dict) --
- name (string) --
  
  The name of the slot type.
- description (string) --
  
  A description of the slot type.
- enumerationValues (list) --
  
  A list of EnumerationValue objects that defines the values that the slot type can take.
  - (dict) --
    
    Each slot type can have a set of values. Each enumeration value represents a value the slot type can take.
    
    For example, a pizza ordering bot could have a slot type that specifies the type of crust that the pizza should have. The slot type could include the values
    - thick
    - thin
    - stuffed
    - value (string) --
      
      The value of the slot type.
    - synonyms (list) --
      
      Additional values related to the slot type value.
      - (string) --
- lastUpdatedDate (datetime) --
  
  The date that the slot type was updated. When you create a slot type, the creation date and last update date are the same.
- createdDate (datetime) --
  
  The date that the slot type was created.
- version (string) --
  
  The version of the slot type. For a new slot type, the version is always $LATEST .
- checksum (string) --
  
  Checksum of the $LATEST version of the slot type.
- valueSelectionStrategy (string) --
  
  The strategy that Amazon Lex uses to determine the value of the slot. For more information, see PutSlotType .