Amazon Lex Model Building Service

2018/02/14 - Amazon Lex Model Building Service - 2 new 9 updated api methods

Changes  Amazon Lex now provides the ability to export and import your Amazon Lex chatbot definition as a JSON file.

GetImport (new) Link ¶

Gets information about an import job started with the StartImport operation.

See also: AWS API Documentation

Request Syntax

client.get_import(
    importId='string'
)
type importId

string

param importId

[REQUIRED]

The identifier of the import job information to return.

rtype

dict

returns

Response Syntax

{
    'name': 'string',
    'resourceType': 'BOT'|'INTENT'|'SLOT_TYPE',
    'mergeStrategy': 'OVERWRITE_LATEST'|'FAIL_ON_CONFLICT',
    'importId': 'string',
    'importStatus': 'IN_PROGRESS'|'COMPLETE'|'FAILED',
    'failureReason': [
        'string',
    ],
    'createdDate': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • name (string) --

      The name given to the import job.

    • resourceType (string) --

      The type of resource imported.

    • mergeStrategy (string) --

      The action taken when there was a conflict between an existing resource and a resource in the import file.

    • importId (string) --

      The identifier for the specific import job.

    • importStatus (string) --

      The status of the import job. If the status is FAILED , you can get the reason for the failure from the failureReason field.

    • failureReason (list) --

      A string that describes why an import job failed to complete.

      • (string) --

    • createdDate (datetime) --

      A timestamp for the date and time that the import job was created.

StartImport (new) Link ¶

Starts a job to import a resource to Amazon Lex.

See also: AWS API Documentation

Request Syntax

client.start_import(
    payload=b'bytes',
    resourceType='BOT'|'INTENT'|'SLOT_TYPE',
    mergeStrategy='OVERWRITE_LATEST'|'FAIL_ON_CONFLICT'
)
type payload

bytes

param payload

[REQUIRED]

A zip archive in binary format. The archive should contain one file, a JSON file containing the resource to import. The resource should match the type specified in the resourceType field.

type resourceType

string

param resourceType

[REQUIRED]

Specifies the type of resource to export. Each resource also exports any resources that it depends on.

  • A bot exports dependent intents.

  • An intent exports dependent slot types.

type mergeStrategy

string

param mergeStrategy

[REQUIRED]

Specifies the action that the StartImport operation should take when there is an existing resource with the same name.

  • FAIL_ON_CONFLICT - The import operation is stopped on the first conflict between a resource in the import file and an existing resource. The name of the resource causing the conflict is in the failureReason field of the response to the GetImport operation. OVERWRITE_LATEST - The import operation proceeds even if there is a conflict with an existing resource. The $LASTEST version of the existing resource is overwritten with the data from the import file.

rtype

dict

returns

Response Syntax

{
    'name': 'string',
    'resourceType': 'BOT'|'INTENT'|'SLOT_TYPE',
    'mergeStrategy': 'OVERWRITE_LATEST'|'FAIL_ON_CONFLICT',
    'importId': 'string',
    'importStatus': 'IN_PROGRESS'|'COMPLETE'|'FAILED',
    'createdDate': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • name (string) --

      The name given to the import job.

    • resourceType (string) --

      The type of resource to import.

    • mergeStrategy (string) --

      The action to take when there is a merge conflict.

    • importId (string) --

      The identifier for the specific import job.

    • importStatus (string) --

      The status of the import job. If the status is FAILED , you can get the reason for the failure using the GetImport operation.

    • createdDate (datetime) --

      A timestamp for the date and time that the import job was requested.

CreateBotVersion (updated) Link ¶
Changes (response)
{'locale': ['de-DE', 'en-GB']}

Creates a new version of the bot based on the $LATEST version. If the $LATEST version of this resource hasn't changed since you created the last version, Amazon Lex doesn't create a new version. It returns the last created version.

Note

You can update only the $LATEST version of the bot. You can't update the numbered versions that you create with the CreateBotVersion operation.

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

This operation requires permission for the lex:CreateBotVersion action.

See also: AWS API Documentation

Request Syntax

client.create_bot_version(
    name='string',
    checksum='string'
)
type name

string

param name

[REQUIRED]

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

type checksum

string

param checksum

Identifies a specific revision of the $LATEST version of the bot. If you specify a checksum and the $LATEST version of the bot has a different checksum, a PreconditionFailedException exception is returned and Amazon Lex doesn't publish a new version. If you don't specify a checksum, Amazon Lex publishes the $LATEST version.

rtype

dict

returns

Response Syntax

{
    'name': 'string',
    'description': 'string',
    'intents': [
        {
            'intentName': 'string',
            'intentVersion': 'string'
        },
    ],
    'clarificationPrompt': {
        'messages': [
            {
                'contentType': 'PlainText'|'SSML'|'CustomPayload',
                'content': 'string',
                'groupNumber': 123
            },
        ],
        'maxAttempts': 123,
        'responseCard': 'string'
    },
    'abortStatement': {
        'messages': [
            {
                'contentType': 'PlainText'|'SSML'|'CustomPayload',
                'content': 'string',
                'groupNumber': 123
            },
        ],
        'responseCard': 'string'
    },
    'status': 'BUILDING'|'READY'|'FAILED'|'NOT_BUILT',
    'failureReason': 'string',
    'lastUpdatedDate': datetime(2015, 1, 1),
    'createdDate': datetime(2015, 1, 1),
    'idleSessionTTLInSeconds': 123,
    'voiceId': 'string',
    'checksum': 'string',
    'version': 'string',
    'locale': 'en-US'|'en-GB'|'de-DE',
    'childDirected': True|False
}

Response Structure

  • (dict) --

    • name (string) --

      The name of the bot.

    • description (string) --

      A description of the bot.

    • intents (list) --

      An array of Intent objects. For more information, see PutBot .

      • (dict) --

        Identifies the specific version of an intent.

        • intentName (string) --

          The name of the intent.

        • intentVersion (string) --

          The version of the intent.

    • clarificationPrompt (dict) --

      The message that Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot .

      • messages (list) --

        An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

        • (dict) --

          The message object that provides the message text and its type.

          • contentType (string) --

            The content type of the message string.

          • content (string) --

            The text of the message.

          • groupNumber (integer) --

            Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

      • maxAttempts (integer) --

        The number of times to prompt the user for information.

      • responseCard (string) --

        A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card .

    • abortStatement (dict) --

      The message that Amazon Lex uses to abort a conversation. For more information, see PutBot .

      • messages (list) --

        A collection of message objects.

        • (dict) --

          The message object that provides the message text and its type.

          • contentType (string) --

            The content type of the message string.

          • content (string) --

            The text of the message.

          • groupNumber (integer) --

            Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

      • responseCard (string) --

        At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

    • status (string) --

      When you send a request to create or update a bot, Amazon Lex sets the status response element to BUILDING . After Amazon Lex builds the bot, it sets status to READY . If Amazon Lex can't build the bot, it sets status to FAILED . Amazon Lex returns the reason for the failure in the failureReason response element.

    • failureReason (string) --

      If status is FAILED , Amazon Lex provides the reason that it failed to build the bot.

    • lastUpdatedDate (datetime) --

      The date when the $LATEST version of this bot was updated.

    • createdDate (datetime) --

      The date when the bot version was created.

    • idleSessionTTLInSeconds (integer) --

      The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot .

    • voiceId (string) --

      The Amazon Polly voice ID that Amazon Lex uses for voice interactions with the user.

    • checksum (string) --

      Checksum identifying the version of the bot that was created.

    • version (string) --

      The version of the bot.

    • locale (string) --

      Specifies the target locale for the bot.

    • childDirected (boolean) --

      For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.

      If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.

GetBot (updated) Link ¶
Changes (response)
{'locale': ['de-DE', 'en-GB']}

Returns metadata information for a specific bot. You must provide the bot name and the bot version or alias.

This operation requires permissions for the lex:GetBot action.

See also: AWS API Documentation

Request Syntax

client.get_bot(
    name='string',
    versionOrAlias='string'
)
type name

string

param name

[REQUIRED]

The name of the bot. The name is case sensitive.

type versionOrAlias

string

param versionOrAlias

[REQUIRED]

The version or alias of the bot.

rtype

dict

returns

Response Syntax

{
    'name': 'string',
    'description': 'string',
    'intents': [
        {
            'intentName': 'string',
            'intentVersion': 'string'
        },
    ],
    'clarificationPrompt': {
        'messages': [
            {
                'contentType': 'PlainText'|'SSML'|'CustomPayload',
                'content': 'string',
                'groupNumber': 123
            },
        ],
        'maxAttempts': 123,
        'responseCard': 'string'
    },
    'abortStatement': {
        'messages': [
            {
                'contentType': 'PlainText'|'SSML'|'CustomPayload',
                'content': 'string',
                'groupNumber': 123
            },
        ],
        'responseCard': 'string'
    },
    'status': 'BUILDING'|'READY'|'FAILED'|'NOT_BUILT',
    'failureReason': 'string',
    'lastUpdatedDate': datetime(2015, 1, 1),
    'createdDate': datetime(2015, 1, 1),
    'idleSessionTTLInSeconds': 123,
    'voiceId': 'string',
    'checksum': 'string',
    'version': 'string',
    'locale': 'en-US'|'en-GB'|'de-DE',
    'childDirected': True|False
}

Response Structure

  • (dict) --

    • name (string) --

      The name of the bot.

    • description (string) --

      A description of the bot.

    • intents (list) --

      An array of intent objects. For more information, see PutBot .

      • (dict) --

        Identifies the specific version of an intent.

        • intentName (string) --

          The name of the intent.

        • intentVersion (string) --

          The version of the intent.

    • clarificationPrompt (dict) --

      The message Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot .

      • messages (list) --

        An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

        • (dict) --

          The message object that provides the message text and its type.

          • contentType (string) --

            The content type of the message string.

          • content (string) --

            The text of the message.

          • groupNumber (integer) --

            Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

      • maxAttempts (integer) --

        The number of times to prompt the user for information.

      • responseCard (string) --

        A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card .

    • abortStatement (dict) --

      The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, see PutBot .

      • messages (list) --

        A collection of message objects.

        • (dict) --

          The message object that provides the message text and its type.

          • contentType (string) --

            The content type of the message string.

          • content (string) --

            The text of the message.

          • groupNumber (integer) --

            Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

      • responseCard (string) --

        At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

    • status (string) --

      The status of the bot. If the bot is ready to run, the status is READY . If there was a problem with building the bot, the status is FAILED and the failureReason explains why the bot did not build. If the bot was saved but not built, the status is NOT BUILT .

    • failureReason (string) --

      If status is FAILED , Amazon Lex explains why it failed to build the bot.

    • lastUpdatedDate (datetime) --

      The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.

    • createdDate (datetime) --

      The date that the bot was created.

    • idleSessionTTLInSeconds (integer) --

      The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot .

    • voiceId (string) --

      The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot .

    • checksum (string) --

      Checksum of the bot used to identify a specific revision of the bot's $LATEST version.

    • version (string) --

      The version of the bot. For a new bot, the version is always $LATEST .

    • locale (string) --

      The target locale for the bot.

    • childDirected (boolean) --

      For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.

      If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.

GetBuiltinIntent (updated) Link ¶
Changes (response)
{'supportedLocales': ['de-DE', 'en-GB']}

Returns information about a built-in intent.

This operation requires permission for the lex:GetBuiltinIntent action.

See also: AWS API Documentation

Request Syntax

client.get_builtin_intent(
    signature='string'
)
type signature

string

param signature

[REQUIRED]

The unique identifier for a built-in intent. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit .

rtype

dict

returns

Response Syntax

{
    'signature': 'string',
    'supportedLocales': [
        'en-US'|'en-GB'|'de-DE',
    ],
    'slots': [
        {
            'name': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • signature (string) --

      The unique identifier for a built-in intent.

    • supportedLocales (list) --

      A list of locales that the intent supports.

      • (string) --

    • slots (list) --

      An array of BuiltinIntentSlot objects, one entry for each slot type in the intent.

      • (dict) --

        Provides information about a slot used in a built-in intent.

        • name (string) --

          A list of the slots defined for the intent.

GetBuiltinIntents (updated) Link ¶
Changes (request, response)
Request
{'locale': ['de-DE', 'en-GB']}
Response
{'intents': {'supportedLocales': ['de-DE', 'en-GB']}}

Gets a list of built-in intents that meet the specified criteria.

This operation requires permission for the lex:GetBuiltinIntents action.

See also: AWS API Documentation

Request Syntax

client.get_builtin_intents(
    locale='en-US'|'en-GB'|'de-DE',
    signatureContains='string',
    nextToken='string',
    maxResults=123
)
type locale

string

param locale

A list of locales that the intent supports.

type signatureContains

string

param signatureContains

Substring to match in built-in intent signatures. An intent will be returned if any part of its signature matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit .

type nextToken

string

param nextToken

A pagination token that fetches the next page of intents. If this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, use the pagination token in the next request.

type maxResults

integer

param maxResults

The maximum number of intents to return in the response. The default is 10.

rtype

dict

returns

Response Syntax

{
    'intents': [
        {
            'signature': 'string',
            'supportedLocales': [
                'en-US'|'en-GB'|'de-DE',
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • intents (list) --

      An array of builtinIntentMetadata objects, one for each intent in the response.

      • (dict) --

        Provides metadata for a built-in intent.

        • signature (string) --

          A unique identifier for the built-in intent. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit .

        • supportedLocales (list) --

          A list of identifiers for the locales that the intent supports.

          • (string) --

    • nextToken (string) --

      A pagination token that fetches the next page of intents. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, specify the pagination token in the next request.

GetBuiltinSlotTypes (updated) Link ¶
Changes (request, response)
Request
{'locale': ['de-DE', 'en-GB']}
Response
{'slotTypes': {'supportedLocales': ['de-DE', 'en-GB']}}

Gets a list of built-in slot types that meet the specified criteria.

For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit .

This operation requires permission for the lex:GetBuiltInSlotTypes action.

See also: AWS API Documentation

Request Syntax

client.get_builtin_slot_types(
    locale='en-US'|'en-GB'|'de-DE',
    signatureContains='string',
    nextToken='string',
    maxResults=123
)
type locale

string

param locale

A list of locales that the slot type supports.

type signatureContains

string

param signatureContains

Substring to match in built-in slot type signatures. A slot type will be returned if any part of its signature matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."

type nextToken

string

param nextToken

A pagination token that fetches the next page of slot types. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of slot types, specify the pagination token in the next request.

type maxResults

integer

param maxResults

The maximum number of slot types to return in the response. The default is 10.

rtype

dict

returns

Response Syntax

{
    'slotTypes': [
        {
            'signature': 'string',
            'supportedLocales': [
                'en-US'|'en-GB'|'de-DE',
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • slotTypes (list) --

      An array of BuiltInSlotTypeMetadata objects, one entry for each slot type returned.

      • (dict) --

        Provides information about a built in slot type.

        • signature (string) --

          A unique identifier for the built-in slot type. To find the signature for a slot type, see Slot Type Reference in the Alexa Skills Kit .

        • supportedLocales (list) --

          A list of target locales for the slot.

          • (string) --

    • nextToken (string) --

      If the response is truncated, the response includes a pagination token that you can use in your next request to fetch the next page of slot types.

GetExport (updated) Link ¶
Changes (both)
{'exportType': ['LEX'], 'resourceType': ['INTENT', 'SLOT_TYPE']}

Exports the contents of a Amazon Lex resource in a specified format.

See also: AWS API Documentation

Request Syntax

client.get_export(
    name='string',
    version='string',
    resourceType='BOT'|'INTENT'|'SLOT_TYPE',
    exportType='ALEXA_SKILLS_KIT'|'LEX'
)
type name

string

param name

[REQUIRED]

The name of the bot to export.

type version

string

param version

[REQUIRED]

The version of the bot to export.

type resourceType

string

param resourceType

[REQUIRED]

The type of resource to export.

type exportType

string

param exportType

[REQUIRED]

The format of the exported data.

rtype

dict

returns

Response Syntax

{
    'name': 'string',
    'version': 'string',
    'resourceType': 'BOT'|'INTENT'|'SLOT_TYPE',
    'exportType': 'ALEXA_SKILLS_KIT'|'LEX',
    'exportStatus': 'IN_PROGRESS'|'READY'|'FAILED',
    'failureReason': 'string',
    'url': 'string'
}

Response Structure

  • (dict) --

    • name (string) --

      The name of the bot being exported.

    • version (string) --

      The version of the bot being exported.

    • resourceType (string) --

      The type of the exported resource.

    • exportType (string) --

      The format of the exported data.

    • exportStatus (string) --

      The status of the export.

      • IN_PROGRESS - The export is in progress.

      • READY - The export is complete.

      • FAILED - The export could not be completed.

    • failureReason (string) --

      If status is FAILED , Amazon Lex provides the reason that it failed to export the resource.

    • url (string) --

      An S3 pre-signed URL that provides the location of the exported resource. The exported resource is a ZIP archive that contains the exported resource in JSON format. The structure of the archive may change. Your code should not rely on the archive structure.

PutBot (updated) Link ¶
Changes (both)
{'createVersion': 'boolean', 'locale': ['de-DE', 'en-GB']}

Creates an Amazon Lex conversational bot or replaces an existing bot. When you create or update a bot you are only required to specify a name, a locale, and whether the bot is directed toward children under age 13. You can use this to add intents later, or to remove intents from an existing bot. When you create a bot with the minimum information, the bot is created or updated but Amazon Lex returns the response FAILED . You can build the bot after you add one or more intents. For more information about Amazon Lex bots, see how-it-works .

If you specify the name of an existing bot, the fields in the request replace the existing values in the $LATEST version of the bot. Amazon Lex removes any fields that you don't provide values for in the request, except for the idleTTLInSeconds and privacySettings fields, which are set to their default values. If you don't specify values for required fields, Amazon Lex throws an exception.

This operation requires permissions for the lex:PutBot action. For more information, see auth-and-access-control .

See also: AWS API Documentation

Request Syntax

client.put_bot(
    name='string',
    description='string',
    intents=[
        {
            'intentName': 'string',
            'intentVersion': 'string'
        },
    ],
    clarificationPrompt={
        'messages': [
            {
                'contentType': 'PlainText'|'SSML'|'CustomPayload',
                'content': 'string',
                'groupNumber': 123
            },
        ],
        'maxAttempts': 123,
        'responseCard': 'string'
    },
    abortStatement={
        'messages': [
            {
                'contentType': 'PlainText'|'SSML'|'CustomPayload',
                'content': 'string',
                'groupNumber': 123
            },
        ],
        'responseCard': 'string'
    },
    idleSessionTTLInSeconds=123,
    voiceId='string',
    checksum='string',
    processBehavior='SAVE'|'BUILD',
    locale='en-US'|'en-GB'|'de-DE',
    childDirected=True|False,
    createVersion=True|False
)
type name

string

param name

[REQUIRED]

The name of the bot. The name is not case sensitive.

type description

string

param description

A description of the bot.

type intents

list

param intents

An array of Intent objects. Each intent represents a command that a user can express. For example, a pizza ordering bot might support an OrderPizza intent. For more information, see how-it-works .

  • (dict) --

    Identifies the specific version of an intent.

    • intentName (string) -- [REQUIRED]

      The name of the intent.

    • intentVersion (string) -- [REQUIRED]

      The version of the intent.

type clarificationPrompt

dict

param clarificationPrompt

When Amazon Lex doesn't understand the user's intent, it uses this message to get clarification. To specify how many times Amazon Lex should repeate the clarification prompt, use the maxAttempts field. If Amazon Lex still doesn't understand, it sends the message in the abortStatement field.

When you create a clarification prompt, make sure that it suggests the correct response from the user. for example, for a bot that orders pizza and drinks, you might create this clarification prompt: "What would you like to do? You can say 'Order a pizza' or 'Order a drink.'"

  • messages (list) -- [REQUIRED]

    An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

    • (dict) --

      The message object that provides the message text and its type.

      • contentType (string) -- [REQUIRED]

        The content type of the message string.

      • content (string) -- [REQUIRED]

        The text of the message.

      • groupNumber (integer) --

        Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

  • maxAttempts (integer) -- [REQUIRED]

    The number of times to prompt the user for information.

  • responseCard (string) --

    A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card .

type abortStatement

dict

param abortStatement

When Amazon Lex can't understand the user's input in context, it tries to elicit the information a few times. After that, Amazon Lex sends the message defined in abortStatement to the user, and then aborts the conversation. To set the number of retries, use the valueElicitationPrompt field for the slot type.

For example, in a pizza ordering bot, Amazon Lex might ask a user "What type of crust would you like?" If the user's response is not one of the expected responses (for example, "thin crust, "deep dish," etc.), Amazon Lex tries to elicit a correct response a few more times.

For example, in a pizza ordering application, OrderPizza might be one of the intents. This intent might require the CrustType slot. You specify the valueElicitationPrompt field when you create the CrustType slot.

  • messages (list) -- [REQUIRED]

    A collection of message objects.

    • (dict) --

      The message object that provides the message text and its type.

      • contentType (string) -- [REQUIRED]

        The content type of the message string.

      • content (string) -- [REQUIRED]

        The text of the message.

      • groupNumber (integer) --

        Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

  • responseCard (string) --

    At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

type idleSessionTTLInSeconds

integer

param idleSessionTTLInSeconds

The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.

A user interaction session remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.

For example, suppose that a user chooses the OrderPizza intent, but gets sidetracked halfway through placing an order. If the user doesn't complete the order within the specified time, Amazon Lex discards the slot information that it gathered, and the user must start over.

If you don't include the idleSessionTTLInSeconds element in a PutBot operation request, Amazon Lex uses the default value. This is also true if the request replaces an existing bot.

The default is 300 seconds (5 minutes).

type voiceId

string

param voiceId

The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user. The locale configured for the voice must match the locale of the bot. For more information, see Available Voices in the Amazon Polly Developer Guide .

type checksum

string

param checksum

Identifies a specific revision of the $LATEST version.

When you create a new bot, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.

When you want to update a bot, 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 processBehavior

string

param processBehavior

If you set the processBehavior element to BUILD , Amazon Lex builds the bot so that it can be run. If you set the element to SAVE Amazon Lex saves the bot, but doesn't build it.

If you don't specify this value, the default value is BUILD .

type locale

string

param locale

[REQUIRED]

Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot.

The default is en-US .

type childDirected

boolean

param childDirected

[REQUIRED]

For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.

If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.

type createVersion

boolean

param createVersion

rtype

dict

returns

Response Syntax

{
    'name': 'string',
    'description': 'string',
    'intents': [
        {
            'intentName': 'string',
            'intentVersion': 'string'
        },
    ],
    'clarificationPrompt': {
        'messages': [
            {
                'contentType': 'PlainText'|'SSML'|'CustomPayload',
                'content': 'string',
                'groupNumber': 123
            },
        ],
        'maxAttempts': 123,
        'responseCard': 'string'
    },
    'abortStatement': {
        'messages': [
            {
                'contentType': 'PlainText'|'SSML'|'CustomPayload',
                'content': 'string',
                'groupNumber': 123
            },
        ],
        'responseCard': 'string'
    },
    'status': 'BUILDING'|'READY'|'FAILED'|'NOT_BUILT',
    'failureReason': 'string',
    'lastUpdatedDate': datetime(2015, 1, 1),
    'createdDate': datetime(2015, 1, 1),
    'idleSessionTTLInSeconds': 123,
    'voiceId': 'string',
    'checksum': 'string',
    'version': 'string',
    'locale': 'en-US'|'en-GB'|'de-DE',
    'childDirected': True|False,
    'createVersion': True|False
}

Response Structure

  • (dict) --

    • name (string) --

      The name of the bot.

    • description (string) --

      A description of the bot.

    • intents (list) --

      An array of Intent objects. For more information, see PutBot .

      • (dict) --

        Identifies the specific version of an intent.

        • intentName (string) --

          The name of the intent.

        • intentVersion (string) --

          The version of the intent.

    • clarificationPrompt (dict) --

      The prompts that Amazon Lex uses when it doesn't understand the user's intent. For more information, see PutBot .

      • messages (list) --

        An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

        • (dict) --

          The message object that provides the message text and its type.

          • contentType (string) --

            The content type of the message string.

          • content (string) --

            The text of the message.

          • groupNumber (integer) --

            Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

      • maxAttempts (integer) --

        The number of times to prompt the user for information.

      • responseCard (string) --

        A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card .

    • abortStatement (dict) --

      The message that Amazon Lex uses to abort a conversation. For more information, see PutBot .

      • messages (list) --

        A collection of message objects.

        • (dict) --

          The message object that provides the message text and its type.

          • contentType (string) --

            The content type of the message string.

          • content (string) --

            The text of the message.

          • groupNumber (integer) --

            Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

      • responseCard (string) --

        At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

    • status (string) --

      When you send a request to create a bot with processBehavior set to BUILD , Amazon Lex sets the status response element to BUILDING . After Amazon Lex builds the bot, it sets status to READY . If Amazon Lex can't build the bot, Amazon Lex sets status to FAILED . Amazon Lex returns the reason for the failure in the failureReason response element.

      When you set processBehavior to SAVE , Amazon Lex sets the status code to NOT BUILT .

    • failureReason (string) --

      If status is FAILED , Amazon Lex provides the reason that it failed to build the bot.

    • lastUpdatedDate (datetime) --

      The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.

    • createdDate (datetime) --

      The date that the bot was created.

    • idleSessionTTLInSeconds (integer) --

      The maximum length of time that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot .

    • voiceId (string) --

      The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot .

    • checksum (string) --

      Checksum of the bot that you created.

    • version (string) --

      The version of the bot. For a new bot, the version is always $LATEST .

    • locale (string) --

      The target locale for the bot.

    • childDirected (boolean) --

      For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.

      If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.

    • createVersion (boolean) --

PutIntent (updated) Link ¶
Changes (both)
{'createVersion': 'boolean'}

Creates an intent or replaces an existing intent.

To define the interaction between the user and your bot, you use one or more intents. For a pizza ordering bot, for example, you would create an OrderPizza intent.

To create an intent or replace an existing intent, you must provide the following:

  • Intent name. For example, OrderPizza .

  • Sample utterances. For example, "Can I order a pizza, please." and "I want to order a pizza."

  • Information to be gathered. You specify slot types for the information that your bot will request from the user. You can specify standard slot types, such as a date or a time, or custom slot types such as the size and crust of a pizza.

  • How the intent will be fulfilled. You can provide a Lambda function or configure the intent to return the intent information to the client application. If you use a Lambda function, when all of the intent information is available, Amazon Lex invokes your Lambda function. If you configure your intent to return the intent information to the client application.

You can specify other optional information in the request, such as:

  • A confirmation prompt to ask the user to confirm an intent. For example, "Shall I order your pizza?"

  • A conclusion statement to send to the user after the intent has been fulfilled. For example, "I placed your pizza order."

  • A follow-up prompt that asks the user for additional activity. For example, asking "Do you want to order a drink with your pizza?"

If you specify an existing intent name to update the intent, Amazon Lex replaces the values in the $LATEST version of the intent with the values in the request. Amazon Lex removes fields that you don't provide in the request. If you don't specify the required fields, Amazon Lex throws an exception. When you update the $LATEST version of an intent, the status field of any bot that uses the $LATEST version of the intent is set to NOT_BUILT .

For more information, see how-it-works .

This operation requires permissions for the lex:PutIntent action.

See also: AWS API Documentation

Request Syntax

client.put_intent(
    name='string',
    description='string',
    slots=[
        {
            'name': 'string',
            'description': 'string',
            'slotConstraint': 'Required'|'Optional',
            'slotType': 'string',
            'slotTypeVersion': 'string',
            'valueElicitationPrompt': {
                'messages': [
                    {
                        'contentType': 'PlainText'|'SSML'|'CustomPayload',
                        'content': 'string',
                        'groupNumber': 123
                    },
                ],
                'maxAttempts': 123,
                'responseCard': 'string'
            },
            'priority': 123,
            'sampleUtterances': [
                'string',
            ],
            'responseCard': 'string'
        },
    ],
    sampleUtterances=[
        'string',
    ],
    confirmationPrompt={
        'messages': [
            {
                'contentType': 'PlainText'|'SSML'|'CustomPayload',
                'content': 'string',
                'groupNumber': 123
            },
        ],
        'maxAttempts': 123,
        'responseCard': 'string'
    },
    rejectionStatement={
        'messages': [
            {
                'contentType': 'PlainText'|'SSML'|'CustomPayload',
                'content': 'string',
                'groupNumber': 123
            },
        ],
        'responseCard': 'string'
    },
    followUpPrompt={
        'prompt': {
            'messages': [
                {
                    'contentType': 'PlainText'|'SSML'|'CustomPayload',
                    'content': 'string',
                    'groupNumber': 123
                },
            ],
            'maxAttempts': 123,
            'responseCard': 'string'
        },
        'rejectionStatement': {
            'messages': [
                {
                    'contentType': 'PlainText'|'SSML'|'CustomPayload',
                    'content': 'string',
                    'groupNumber': 123
                },
            ],
            'responseCard': 'string'
        }
    },
    conclusionStatement={
        'messages': [
            {
                'contentType': 'PlainText'|'SSML'|'CustomPayload',
                'content': 'string',
                'groupNumber': 123
            },
        ],
        'responseCard': 'string'
    },
    dialogCodeHook={
        'uri': 'string',
        'messageVersion': 'string'
    },
    fulfillmentActivity={
        'type': 'ReturnIntent'|'CodeHook',
        'codeHook': {
            'uri': 'string',
            'messageVersion': 'string'
        }
    },
    parentIntentSignature='string',
    checksum='string',
    createVersion=True|False
)
type name

string

param name

[REQUIRED]

The name of the intent. The name is not case sensitive.

The name can't match a built-in intent name, or a built-in intent name with "AMAZON." removed. For example, because there is a built-in intent called AMAZON.HelpIntent , you can't create a custom intent called HelpIntent .

For a list of built-in intents, see Standard Built-in Intents in the Alexa Skills Kit .

type description

string

param description

A description of the intent.

type slots

list

param slots

An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user using prompts defined in the slots. For more information, see how-it-works .

  • (dict) --

    Identifies the version of a specific slot.

    • name (string) -- [REQUIRED]

      The name of the slot.

    • description (string) --

      A description of the slot.

    • slotConstraint (string) -- [REQUIRED]

      Specifies whether the slot is required or optional.

    • slotType (string) --

      The type of the slot, either a custom slot type that you defined or one of the built-in slot types.

    • slotTypeVersion (string) --

      The version of the slot type.

    • valueElicitationPrompt (dict) --

      The prompt that Amazon Lex uses to elicit the slot value from the user.

      • messages (list) -- [REQUIRED]

        An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

        • (dict) --

          The message object that provides the message text and its type.

          • contentType (string) -- [REQUIRED]

            The content type of the message string.

          • content (string) -- [REQUIRED]

            The text of the message.

          • groupNumber (integer) --

            Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

      • maxAttempts (integer) -- [REQUIRED]

        The number of times to prompt the user for information.

      • responseCard (string) --

        A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card .

    • priority (integer) --

      Directs Lex the order in which to elicit this slot value from the user. For example, if the intent has two slots with priorities 1 and 2, AWS Lex first elicits a value for the slot with priority 1.

      If multiple slots share the same priority, the order in which Lex elicits values is arbitrary.

    • sampleUtterances (list) --

      If you know a specific pattern with which users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.

      • (string) --

    • responseCard (string) --

      A set of possible responses for the slot type used by text-based clients. A user chooses an option from the response card, instead of using text to reply.

type sampleUtterances

list

param sampleUtterances

An array of utterances (strings) that a user might say to signal the intent. For example, "I want {PizzaSize} pizza", "Order {Quantity} {PizzaSize} pizzas".

In each utterance, a slot name is enclosed in curly braces.

  • (string) --

type confirmationPrompt

dict

param confirmationPrompt

Prompts the user to confirm the intent. This question should have a yes or no answer.

Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

Note

You you must provide both the rejectionStatement and the confirmationPrompt , or neither.

  • messages (list) -- [REQUIRED]

    An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

    • (dict) --

      The message object that provides the message text and its type.

      • contentType (string) -- [REQUIRED]

        The content type of the message string.

      • content (string) -- [REQUIRED]

        The text of the message.

      • groupNumber (integer) --

        Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

  • maxAttempts (integer) -- [REQUIRED]

    The number of times to prompt the user for information.

  • responseCard (string) --

    A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card .

type rejectionStatement

dict

param rejectionStatement

When the user answers "no" to the question defined in confirmationPrompt , Amazon Lex responds with this statement to acknowledge that the intent was canceled.

Note

You must provide both the rejectionStatement and the confirmationPrompt , or neither.

  • messages (list) -- [REQUIRED]

    A collection of message objects.

    • (dict) --

      The message object that provides the message text and its type.

      • contentType (string) -- [REQUIRED]

        The content type of the message string.

      • content (string) -- [REQUIRED]

        The text of the message.

      • groupNumber (integer) --

        Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

  • responseCard (string) --

    At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

type followUpPrompt

dict

param followUpPrompt

Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent. For example, after the OrderPizza intent is fulfilled, you might prompt the user to order a drink.

The action that Amazon Lex takes depends on the user's response, as follows:

  • If the user says "Yes" it responds with the clarification prompt that is configured for the bot.

  • if the user says "Yes" and continues with an utterance that triggers an intent it starts a conversation for the intent.

  • If the user says "No" it responds with the rejection statement configured for the the follow-up prompt.

  • If it doesn't recognize the utterance it repeats the follow-up prompt again.

The followUpPrompt field and the conclusionStatement field are mutually exclusive. You can specify only one.

  • prompt (dict) -- [REQUIRED]

    Prompts for information from the user.

    • messages (list) -- [REQUIRED]

      An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

      • (dict) --

        The message object that provides the message text and its type.

        • contentType (string) -- [REQUIRED]

          The content type of the message string.

        • content (string) -- [REQUIRED]

          The text of the message.

        • groupNumber (integer) --

          Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

    • maxAttempts (integer) -- [REQUIRED]

      The number of times to prompt the user for information.

    • responseCard (string) --

      A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card .

  • rejectionStatement (dict) -- [REQUIRED]

    If the user answers "no" to the question defined in the prompt field, Amazon Lex responds with this statement to acknowledge that the intent was canceled.

    • messages (list) -- [REQUIRED]

      A collection of message objects.

      • (dict) --

        The message object that provides the message text and its type.

        • contentType (string) -- [REQUIRED]

          The content type of the message string.

        • content (string) -- [REQUIRED]

          The text of the message.

        • groupNumber (integer) --

          Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

    • responseCard (string) --

      At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

type conclusionStatement

dict

param conclusionStatement

The statement that you want Amazon Lex to convey to the user after the intent is successfully fulfilled by the Lambda function.

This element is relevant only if you provide a Lambda function in the fulfillmentActivity . If you return the intent to the client application, you can't specify this element.

Note

The followUpPrompt and conclusionStatement are mutually exclusive. You can specify only one.

  • messages (list) -- [REQUIRED]

    A collection of message objects.

    • (dict) --

      The message object that provides the message text and its type.

      • contentType (string) -- [REQUIRED]

        The content type of the message string.

      • content (string) -- [REQUIRED]

        The text of the message.

      • groupNumber (integer) --

        Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

  • responseCard (string) --

    At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

type dialogCodeHook

dict

param dialogCodeHook

Specifies a Lambda function to invoke for each user input. You can invoke this Lambda function to personalize user interaction.

For example, suppose your bot determines that the user is John. Your Lambda function might retrieve John's information from a backend database and prepopulate some of the values. For example, if you find that John is gluten intolerant, you might set the corresponding intent slot, GlutenIntolerant , to true. You might find John's phone number and set the corresponding session attribute.

  • uri (string) -- [REQUIRED]

    The Amazon Resource Name (ARN) of the Lambda function.

  • messageVersion (string) -- [REQUIRED]

    The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda .

type fulfillmentActivity

dict

param fulfillmentActivity

Required. Describes how the intent is fulfilled. For example, after a user provides all of the information for a pizza order, fulfillmentActivity defines how the bot places an order with a local pizza store.

You might configure Amazon Lex to return all of the intent information to the client application, or direct it to invoke a Lambda function that can process the intent (for example, place an order with a pizzeria).

  • type (string) -- [REQUIRED]

    How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the client application.

  • codeHook (dict) --

    A description of the Lambda function that is run to fulfill the intent.

    • uri (string) -- [REQUIRED]

      The Amazon Resource Name (ARN) of the Lambda function.

    • messageVersion (string) -- [REQUIRED]

      The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda .

type parentIntentSignature

string

param parentIntentSignature

A unique identifier for the built-in intent to base this intent on. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit .

type checksum

string

param checksum

Identifies a specific revision of the $LATEST version.

When you create a new intent, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.

When you want to update a intent, 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 createVersion

boolean

param createVersion

rtype

dict

returns

Response Syntax

{
    'name': 'string',
    'description': 'string',
    'slots': [
        {
            'name': 'string',
            'description': 'string',
            'slotConstraint': 'Required'|'Optional',
            'slotType': 'string',
            'slotTypeVersion': 'string',
            'valueElicitationPrompt': {
                'messages': [
                    {
                        'contentType': 'PlainText'|'SSML'|'CustomPayload',
                        'content': 'string',
                        'groupNumber': 123
                    },
                ],
                'maxAttempts': 123,
                'responseCard': 'string'
            },
            'priority': 123,
            'sampleUtterances': [
                'string',
            ],
            'responseCard': 'string'
        },
    ],
    'sampleUtterances': [
        'string',
    ],
    'confirmationPrompt': {
        'messages': [
            {
                'contentType': 'PlainText'|'SSML'|'CustomPayload',
                'content': 'string',
                'groupNumber': 123
            },
        ],
        'maxAttempts': 123,
        'responseCard': 'string'
    },
    'rejectionStatement': {
        'messages': [
            {
                'contentType': 'PlainText'|'SSML'|'CustomPayload',
                'content': 'string',
                'groupNumber': 123
            },
        ],
        'responseCard': 'string'
    },
    'followUpPrompt': {
        'prompt': {
            'messages': [
                {
                    'contentType': 'PlainText'|'SSML'|'CustomPayload',
                    'content': 'string',
                    'groupNumber': 123
                },
            ],
            'maxAttempts': 123,
            'responseCard': 'string'
        },
        'rejectionStatement': {
            'messages': [
                {
                    'contentType': 'PlainText'|'SSML'|'CustomPayload',
                    'content': 'string',
                    'groupNumber': 123
                },
            ],
            'responseCard': 'string'
        }
    },
    'conclusionStatement': {
        'messages': [
            {
                'contentType': 'PlainText'|'SSML'|'CustomPayload',
                'content': 'string',
                'groupNumber': 123
            },
        ],
        'responseCard': 'string'
    },
    'dialogCodeHook': {
        'uri': 'string',
        'messageVersion': 'string'
    },
    'fulfillmentActivity': {
        'type': 'ReturnIntent'|'CodeHook',
        'codeHook': {
            'uri': 'string',
            'messageVersion': 'string'
        }
    },
    'parentIntentSignature': 'string',
    'lastUpdatedDate': datetime(2015, 1, 1),
    'createdDate': datetime(2015, 1, 1),
    'version': 'string',
    'checksum': 'string',
    'createVersion': True|False
}

Response Structure

  • (dict) --

    • name (string) --

      The name of the intent.

    • description (string) --

      A description of the intent.

    • slots (list) --

      An array of intent slots that are configured for the intent.

      • (dict) --

        Identifies the version of a specific slot.

        • name (string) --

          The name of the slot.

        • description (string) --

          A description of the slot.

        • slotConstraint (string) --

          Specifies whether the slot is required or optional.

        • slotType (string) --

          The type of the slot, either a custom slot type that you defined or one of the built-in slot types.

        • slotTypeVersion (string) --

          The version of the slot type.

        • valueElicitationPrompt (dict) --

          The prompt that Amazon Lex uses to elicit the slot value from the user.

          • messages (list) --

            An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

            • (dict) --

              The message object that provides the message text and its type.

              • contentType (string) --

                The content type of the message string.

              • content (string) --

                The text of the message.

              • groupNumber (integer) --

                Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

          • maxAttempts (integer) --

            The number of times to prompt the user for information.

          • responseCard (string) --

            A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card .

        • priority (integer) --

          Directs Lex the order in which to elicit this slot value from the user. For example, if the intent has two slots with priorities 1 and 2, AWS Lex first elicits a value for the slot with priority 1.

          If multiple slots share the same priority, the order in which Lex elicits values is arbitrary.

        • sampleUtterances (list) --

          If you know a specific pattern with which users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.

          • (string) --

        • responseCard (string) --

          A set of possible responses for the slot type used by text-based clients. A user chooses an option from the response card, instead of using text to reply.

    • sampleUtterances (list) --

      An array of sample utterances that are configured for the intent.

      • (string) --

    • confirmationPrompt (dict) --

      If defined in the intent, Amazon Lex prompts the user to confirm the intent before fulfilling it.

      • messages (list) --

        An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

        • (dict) --

          The message object that provides the message text and its type.

          • contentType (string) --

            The content type of the message string.

          • content (string) --

            The text of the message.

          • groupNumber (integer) --

            Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

      • maxAttempts (integer) --

        The number of times to prompt the user for information.

      • responseCard (string) --

        A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card .

    • rejectionStatement (dict) --

      If the user answers "no" to the question defined in confirmationPrompt Amazon Lex responds with this statement to acknowledge that the intent was canceled.

      • messages (list) --

        A collection of message objects.

        • (dict) --

          The message object that provides the message text and its type.

          • contentType (string) --

            The content type of the message string.

          • content (string) --

            The text of the message.

          • groupNumber (integer) --

            Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

      • responseCard (string) --

        At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

    • followUpPrompt (dict) --

      If defined in the intent, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled.

      • prompt (dict) --

        Prompts for information from the user.

        • messages (list) --

          An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

          • (dict) --

            The message object that provides the message text and its type.

            • contentType (string) --

              The content type of the message string.

            • content (string) --

              The text of the message.

            • groupNumber (integer) --

              Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

        • maxAttempts (integer) --

          The number of times to prompt the user for information.

        • responseCard (string) --

          A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card .

      • rejectionStatement (dict) --

        If the user answers "no" to the question defined in the prompt field, Amazon Lex responds with this statement to acknowledge that the intent was canceled.

        • messages (list) --

          A collection of message objects.

          • (dict) --

            The message object that provides the message text and its type.

            • contentType (string) --

              The content type of the message string.

            • content (string) --

              The text of the message.

            • groupNumber (integer) --

              Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

        • responseCard (string) --

          At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

    • conclusionStatement (dict) --

      After the Lambda function specified in the``fulfillmentActivity`` intent fulfills the intent, Amazon Lex conveys this statement to the user.

      • messages (list) --

        A collection of message objects.

        • (dict) --

          The message object that provides the message text and its type.

          • contentType (string) --

            The content type of the message string.

          • content (string) --

            The text of the message.

          • groupNumber (integer) --

            Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

      • responseCard (string) --

        At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

    • dialogCodeHook (dict) --

      If defined in the intent, Amazon Lex invokes this Lambda function for each user input.

      • uri (string) --

        The Amazon Resource Name (ARN) of the Lambda function.

      • messageVersion (string) --

        The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda .

    • fulfillmentActivity (dict) --

      If defined in the intent, Amazon Lex invokes this Lambda function to fulfill the intent after the user provides all of the information required by the intent.

      • type (string) --

        How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the client application.

      • codeHook (dict) --

        A description of the Lambda function that is run to fulfill the intent.

        • uri (string) --

          The Amazon Resource Name (ARN) of the Lambda function.

        • messageVersion (string) --

          The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda .

    • parentIntentSignature (string) --

      A unique identifier for the built-in intent that this intent is based on.

    • lastUpdatedDate (datetime) --

      The date that the intent was updated. When you create a resource, the creation date and last update dates are the same.

    • createdDate (datetime) --

      The date that the intent was created.

    • version (string) --

      The version of the intent. For a new intent, the version is always $LATEST .

    • checksum (string) --

      Checksum of the $LATEST version of the intent created or updated.

    • createVersion (boolean) --

PutSlotType (updated) Link ¶
Changes (both)
{'createVersion': 'boolean'}

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.

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',
    createVersion=True|False
)
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 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 .

type createVersion

boolean

param createVersion

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',
    'createVersion': True|False
}

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 slot resolution strategy that Amazon Lex uses to determine the value of the slot. For more information, see PutSlotType .

    • createVersion (boolean) --