LexModelsV2
import { LexModelsV2 } from "https://aws-api.deno.dev/v0.2/services/lexmodelsv2.ts?docs=full";
§Constructors
§Methods
Builds a bot, its intents, and its slot types into a specific locale. A bot can be built into multiple locales. At runtime the locale is used to choose a specific build of the bot.
Creates an alias for the specified version of a bot. Use an alias to enable you to change the version of a bot without updating applications that use the bot.
For example, you can create an alias called "PROD" that your applications use to call the Amazon Lex bot.
Creates a locale in the bot. The locale contains the intents and slot types that the bot uses in conversations with users in the specified language and locale. You must add a locale to a bot before you can add intents and slot types to the bot.
Creates a new version of the bot based on the DRAFT
version.
If the DRAFT
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.
When you create the first version of a bot, Amazon Lex sets the version to 1. Subsequent versions increment by 1.
Creates a zip archive containing the contents of a bot or a bot locale. The archive contains a directory structure that contains JSON files that define the bot.
You can create an archive that contains the complete definition of a bot, or you can specify that the archive contain only the definition of a single bot locale.
For more information about exporting bots, and about the structure of the export archive, see Importing and exporting bots
Creates an intent.
To define the interaction between the user and your bot, you define one or more intents.
For example, for a pizza ordering bot you would create an OrderPizza
intent.
When you create an intent, you must provide a name. You can optionally provide the following:
- Sample utterances. For example, "I want to order a pizza" and "Can I order a pizza." You can't provide utterances for built-in intents.
- Information to be gathered. You specify slots for the information that you bot requests from the user. You can specify standard slot types, such as date and time, or custom slot types for your application.
- How the intent is fulfilled. You can provide a Lambda function or configure the intent to return the intent information to your client application. If you use a Lambda function, Amazon Lex invokes the function when all of the intent information is available.
- A confirmation prompt to send to the user to confirm an intent. For example, "Shall I order your pizza?"
- A conclusion statement to send to the user after the intent is fulfilled. For example, "I ordered your pizza."
- A follow-up prompt that asks the user for additional activity. For example, "Do you want a drink with your pizza?"
Creates a new resource policy with the specified policy statements.
Adds a new resource policy statement to a bot or bot alias. If a resource policy exists, the statement is added to the current resource policy. If a policy doesn't exist, a new policy is created.
You can't create a resource policy statement that allows cross-account access.
Creates a slot in an intent.
A slot is a variable needed to fulfill an intent.
For example, an OrderPizza
intent might need slots for size, crust, and number of pizzas.
For each slot, you define one or more utterances that Amazon Lex uses to elicit a response from the user.
Creates a custom slot type
To create a custom slot type, specify a name for the slot type and a set of enumeration values, the values that a slot of this type can assume.
Gets a pre-signed S3 write URL that you use to upload the zip archive when importing a bot or a bot locale.
Deletes all versions of a bot, including the Draft
version.
To delete a specific version, use the DeleteBotVersion
operation.
When you delete a bot, all of the resources contained in the bot are also deleted. Deleting a bot removes all locales, intents, slot, and slot types defined for the bot.
If a bot has an alias, the DeleteBot
operation returns a ResourceInUseException
exception.
If you want to delete the bot and the alias, set the skipResourceInUseCheck
parameter to true
.
Deletes the specified bot alias.
Removes a locale from a bot.
When you delete a locale, all intents, slots, and slot types defined for the locale are also deleted.
Deletes a specific version of a bot. To delete all version of a bot, use the "DeleteBot" operation.
Removes a previous export and the associated files stored in an S3 bucket.
Removes a previous import and the associated file stored in an S3 bucket.
Removes the specified intent.
Deleting an intent also deletes the slots associated with the intent.
Removes an existing policy from a bot or bot alias. If the resource doesn't have a policy attached, Amazon Lex returns an exception.
Deletes a policy statement from a resource policy. If you delete the last statement from a policy, the policy is deleted. If you specify a statement ID that doesn't exist in the policy, or if the bot or bot alias doesn't have a policy attached, Amazon Lex returns an exception.
Deletes a slot type from a bot locale.
If a slot is using the slot type, Amazon Lex throws a ResourceInUseException
exception.
To avoid the exception, set the skipResourceInUseCheck
parameter to true
.
Get information about a specific bot alias.
Describes the settings that a bot has for a specific locale.
Provides metadata about a version of a bot.
Gets information about a specific export.
Gets information about a specific import.
Returns metadata about an intent.
Gets the resource policy and policy revision for a bot or bot alias.
Gets metadata information about a slot.
Gets metadata information about a slot type.
Gets a list of aliases for the specified bot.
Gets a list of locales for the specified bot.
Gets information about all of the versions of a bot.
The ListBotVersions
operation returns a summary of each version of a bot.
For example, if a bot has three numbered versions, the ListBotVersions
operation returns for summaries, one for each numbered version and one for the DRAFT
version.
The ListBotVersions
operation always returns at least one version, the DRAFT
version.
Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.
To use a built-in intent as a the base for your own intent, include the built-in intent signature in the parentIntentSignature
parameter when you call the CreateIntent
operation.
For more information,
see "CreateIntent".
Gets a list of built-in slot types that meet the specified criteria.
Lists the exports for a bot or bot locale. Exports are kept in the list for 7 days.
Lists the imports for a bot or bot locale. Imports are kept in the list for 7 days.
Gets a list of slot types that match the specified criteria.
Gets a list of tags associated with a resource. Only bots, bot aliases, and bot channels can have tags associated with them.
Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.
Updates the configuration of an existing bot alias.
Updates the settings that a bot has for a specific locale.
Updates the password used to protect an export zip archive.
The password is not required. If you don't supply a password, Amazon Lex generates a zip file that is not protected by a password. This is the archive that is available at the pre-signed S3 URL provided by the operation.
Updates the settings for an intent.
Replaces the existing resource policy for a bot or bot alias with a new one. If the policy doesn't exist, Amazon Lex returns an exception.
Updates the configuration of an existing slot type.
Wait until a bot alias is available Checks state up to 35 times, 10 seconds apart (about 6 minutes max wait time).
Wait until a bot is available Checks state up to 35 times, 10 seconds apart (about 6 minutes max wait time).
Wait until a bot has been exported Checks state up to 35 times, 10 seconds apart (about 6 minutes max wait time).
Wait until a bot has been imported Checks state up to 35 times, 10 seconds apart (about 6 minutes max wait time).
Wait until a bot locale is built Checks state up to 35 times, 10 seconds apart (about 6 minutes max wait time).
Wait unit a bot locale is created Checks state up to 35 times, 10 seconds apart (about 6 minutes max wait time).
Wait until a bot locale build is ready for express testing Checks state up to 35 times, 10 seconds apart (about 6 minutes max wait time).
Wait until a bot version is available Checks state up to 35 times, 10 seconds apart (about 6 minutes max wait time).