LexModelsV2Client

Properties

Link copied to clipboard
abstract override val config: LexModelsV2Client.Config

LexModelsV2Client's configuration

Functions

Link copied to clipboard

Create a batch of custom vocabulary items for a given bot locale's custom vocabulary.

Link copied to clipboard

Delete a batch of custom vocabulary items for a given bot locale's custom vocabulary.

Link copied to clipboard

Update a batch of custom vocabulary items for a given bot locale's custom vocabulary.

Link copied to clipboard

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.

Link copied to clipboard
abstract suspend fun createBot(input: CreateBotRequest): CreateBotResponse

Creates an Amazon Lex conversational bot.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Action to create a replication of the source bot in the secondary region.

Link copied to clipboard

Creates an immutable version of the bot. When you create the first version of a bot, Amazon Lex sets the version number to 1. Subsequent bot versions increase in an increment of 1. The version number will always represent the total number of versions created of the bot, not the current number of versions. If a bot version is deleted, that bot version number will not be reused.

Link copied to clipboard

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.

Link copied to clipboard

Creates an intent.

Link copied to clipboard

Creates a new resource policy with the specified policy statements.

Link copied to clipboard

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.

Link copied to clipboard
abstract suspend fun createSlot(input: CreateSlotRequest): CreateSlotResponse

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.

Link copied to clipboard

Creates a custom slot type

Link copied to clipboard

Create a report that describes the differences between the bot and the test set.

Link copied to clipboard
abstract suspend fun createUploadUrl(input: CreateUploadUrlRequest = CreateUploadUrlRequest { }): CreateUploadUrlResponse

Gets a pre-signed S3 write URL that you use to upload the zip archive when importing a bot or a bot locale.

Link copied to clipboard
abstract suspend fun deleteBot(input: DeleteBotRequest): DeleteBotResponse

Deletes all versions of a bot, including the Draft version. To delete a specific version, use the DeleteBotVersion operation.

Link copied to clipboard

Deletes the specified bot alias.

Link copied to clipboard

Removes a locale from a bot.

Link copied to clipboard

The action to delete the replicated bot in the secondary region.

Link copied to clipboard

Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation.

Link copied to clipboard

Removes a custom vocabulary from the specified locale in the specified bot.

Link copied to clipboard

Removes a previous export and the associated files stored in an S3 bucket.

Link copied to clipboard

Removes a previous import and the associated file stored in an S3 bucket.

Link copied to clipboard

Removes the specified intent.

Link copied to clipboard

Removes an existing policy from a bot or bot alias. If the resource doesn't have a policy attached, Amazon Lex returns an exception.

Link copied to clipboard

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.

Link copied to clipboard
abstract suspend fun deleteSlot(input: DeleteSlotRequest): DeleteSlotResponse

Deletes the specified slot from an intent.

Link copied to clipboard

Deletes a slot type from a bot locale.

Link copied to clipboard

The action to delete the selected test set.

Link copied to clipboard

Deletes stored utterances.

Link copied to clipboard
abstract suspend fun describeBot(input: DescribeBotRequest): DescribeBotResponse

Provides metadata information about a bot.

Link copied to clipboard

Get information about a specific bot alias.

Link copied to clipboard

Describes the settings that a bot has for a specific locale.

Link copied to clipboard

Provides metadata information about a bot recommendation. This information will enable you to get a description on the request inputs, to download associated transcripts after processing is complete, and to download intents and slot-types generated by the bot recommendation.

Link copied to clipboard

Monitors the bot replication status through the UI console.

Link copied to clipboard

Returns information about a request to generate a bot through natural language description, made through the StartBotResource API. Use the generatedBotLocaleUrl to retrieve the Amazon S3 object containing the bot locale configuration. You can then modify and import this configuration.

Link copied to clipboard

Provides metadata about a version of a bot.

Link copied to clipboard

Provides metadata information about a custom vocabulary.

Link copied to clipboard

Gets information about a specific export.

Link copied to clipboard

Gets information about a specific import.

Link copied to clipboard

Returns metadata about an intent.

Link copied to clipboard

Gets the resource policy and policy revision for a bot or bot alias.

Link copied to clipboard

Gets metadata information about a slot.

Link copied to clipboard

Gets metadata information about a slot type.

Link copied to clipboard

Gets metadata information about the test execution.

Link copied to clipboard

Gets metadata information about the test set.

Link copied to clipboard

Gets metadata information about the test set discrepancy report.

Link copied to clipboard

Gets metadata information about the test set generation.

Link copied to clipboard

Generates sample utterances for an intent.

Link copied to clipboard

The pre-signed Amazon S3 URL to download the test execution result artifacts.

Link copied to clipboard

Provides a list of utterances that users have sent to the bot.

Link copied to clipboard

Gets a list of aliases for the specified bot.

Link copied to clipboard

The action to list the replicated bots created from the source bot alias.

Link copied to clipboard

Gets a list of locales for the specified bot.

Link copied to clipboard

Get a list of bot recommendations that meet the specified criteria.

Link copied to clipboard

The action to list the replicated bots.

Link copied to clipboard

Lists the generation requests made for a bot locale.

Link copied to clipboard
abstract suspend fun listBots(input: ListBotsRequest = ListBotsRequest { }): ListBotsResponse

Gets a list of available bots.

Link copied to clipboard

Contains information about all the versions replication statuses applicable for Global Resiliency.

Link copied to clipboard

Gets information about all of the versions of a bot.

Link copied to clipboard

Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.

Link copied to clipboard

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

Link copied to clipboard

Paginated list of custom vocabulary items for a given bot locale's custom vocabulary.

Link copied to clipboard
abstract suspend fun listExports(input: ListExportsRequest = ListExportsRequest { }): ListExportsResponse

Lists the exports for a bot, bot locale, or custom vocabulary. Exports are kept in the list for 7 days.

Link copied to clipboard
abstract suspend fun listImports(input: ListImportsRequest = ListImportsRequest { }): ListImportsResponse

Lists the imports for a bot, bot locale, or custom vocabulary. Imports are kept in the list for 7 days.

Link copied to clipboard

Retrieves summary metrics for the intents in your bot. The following fields are required:

Link copied to clipboard

Retrieves summary statistics for a path of intents that users take over sessions with your bot. The following fields are required:

Link copied to clipboard
abstract suspend fun listIntents(input: ListIntentsRequest): ListIntentsResponse

Get a list of intents that meet the specified criteria.

Link copied to clipboard

Retrieves summary metrics for the stages within intents in your bot. The following fields are required:

Link copied to clipboard

Gets a list of recommended intents provided by the bot recommendation that you can use in your bot. Intents in the response are ordered by relevance.

Link copied to clipboard

Retrieves a list of metadata for individual user sessions with your bot. The startDateTime and endDateTime fields are required. These fields define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways:

Link copied to clipboard

Retrieves summary metrics for the user sessions with your bot. The following fields are required:

Link copied to clipboard
abstract suspend fun listSlots(input: ListSlotsRequest): ListSlotsResponse

Gets a list of slots that match the specified criteria.

Link copied to clipboard

Gets a list of slot types that match the specified criteria.

Link copied to clipboard

Gets a list of tags associated with a resource. Only bots, bot aliases, and bot channels can have tags associated with them.

Link copied to clipboard

Gets a list of test execution result items.

Link copied to clipboard
abstract suspend fun listTestExecutions(input: ListTestExecutionsRequest = ListTestExecutionsRequest { }): ListTestExecutionsResponse

The list of test set executions.

Link copied to clipboard

The list of test set records.

Link copied to clipboard
abstract suspend fun listTestSets(input: ListTestSetsRequest = ListTestSetsRequest { }): ListTestSetsResponse

The list of the test sets

Link copied to clipboard

To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics. See Viewing utterance statistics for the IAM policy to apply to the IAM role.

Link copied to clipboard

To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics. See Viewing utterance statistics for the IAM policy to apply to the IAM role.

Link copied to clipboard

Search for associated transcripts that meet the specified criteria.

Link copied to clipboard

Use this to provide your transcript data, and to start the bot recommendation process.

Link copied to clipboard

Starts a request for the descriptive bot builder to generate a bot locale configuration based on the prompt you provide it. After you make this call, use the DescribeBotResourceGeneration operation to check on the status of the generation and for the generatedBotLocaleUrl when the generation is complete. Use that value to retrieve the Amazon S3 object containing the bot locale configuration. You can then modify and import this configuration.

Link copied to clipboard
abstract suspend fun startImport(input: StartImportRequest): StartImportResponse

Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket.

Link copied to clipboard

The action to start test set execution.

Link copied to clipboard

The action to start the generation of test set.

Link copied to clipboard

Stop an already running Bot Recommendation request.

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.

Link copied to clipboard

Removes tags from a bot, bot alias, or bot channel.

Link copied to clipboard
abstract suspend fun updateBot(input: UpdateBotRequest): UpdateBotResponse

Updates the configuration of an existing bot.

Link copied to clipboard

Updates the configuration of an existing bot alias.

Link copied to clipboard

Updates the settings that a bot has for a specific locale.

Link copied to clipboard

Updates an existing bot recommendation request.

Link copied to clipboard

Updates the password used to protect an export zip archive.

Link copied to clipboard

Updates the settings for an intent.

Link copied to clipboard

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.

Link copied to clipboard
abstract suspend fun updateSlot(input: UpdateSlotRequest): UpdateSlotResponse

Updates the settings for a slot.

Link copied to clipboard

Updates the configuration of an existing slot type.

Link copied to clipboard

The action to update the test set.

Inherited functions

Link copied to clipboard

Create a batch of custom vocabulary items for a given bot locale's custom vocabulary.

Link copied to clipboard

Delete a batch of custom vocabulary items for a given bot locale's custom vocabulary.

Link copied to clipboard

Update a batch of custom vocabulary items for a given bot locale's custom vocabulary.

Link copied to clipboard

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.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
inline suspend fun LexModelsV2Client.createBot(crossinline block: CreateBotRequest.Builder.() -> Unit): CreateBotResponse

Creates an Amazon Lex conversational bot.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Action to create a replication of the source bot in the secondary region.

Link copied to clipboard

Creates an immutable version of the bot. When you create the first version of a bot, Amazon Lex sets the version number to 1. Subsequent bot versions increase in an increment of 1. The version number will always represent the total number of versions created of the bot, not the current number of versions. If a bot version is deleted, that bot version number will not be reused.

Link copied to clipboard

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.

Link copied to clipboard

Creates an intent.

Link copied to clipboard

Creates a new resource policy with the specified policy statements.

Link copied to clipboard

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.

Link copied to clipboard
inline suspend fun LexModelsV2Client.createSlot(crossinline block: CreateSlotRequest.Builder.() -> Unit): CreateSlotResponse

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.

Link copied to clipboard

Creates a custom slot type

Link copied to clipboard

Create a report that describes the differences between the bot and the test set.

Link copied to clipboard

Gets a pre-signed S3 write URL that you use to upload the zip archive when importing a bot or a bot locale.

Link copied to clipboard
inline suspend fun LexModelsV2Client.deleteBot(crossinline block: DeleteBotRequest.Builder.() -> Unit): DeleteBotResponse

Deletes all versions of a bot, including the Draft version. To delete a specific version, use the DeleteBotVersion operation.

Link copied to clipboard

Deletes the specified bot alias.

Link copied to clipboard

Removes a locale from a bot.

Link copied to clipboard

The action to delete the replicated bot in the secondary region.

Link copied to clipboard

Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation.

Link copied to clipboard

Removes a custom vocabulary from the specified locale in the specified bot.

Link copied to clipboard

Removes a previous export and the associated files stored in an S3 bucket.

Link copied to clipboard

Removes a previous import and the associated file stored in an S3 bucket.

Link copied to clipboard

Removes the specified intent.

Link copied to clipboard

Removes an existing policy from a bot or bot alias. If the resource doesn't have a policy attached, Amazon Lex returns an exception.

Link copied to clipboard

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.

Link copied to clipboard
inline suspend fun LexModelsV2Client.deleteSlot(crossinline block: DeleteSlotRequest.Builder.() -> Unit): DeleteSlotResponse

Deletes the specified slot from an intent.

Link copied to clipboard

Deletes a slot type from a bot locale.

Link copied to clipboard

The action to delete the selected test set.

Link copied to clipboard

Deletes stored utterances.

Link copied to clipboard

Provides metadata information about a bot.

Link copied to clipboard

Get information about a specific bot alias.

Link copied to clipboard

Describes the settings that a bot has for a specific locale.

Link copied to clipboard

Provides metadata information about a bot recommendation. This information will enable you to get a description on the request inputs, to download associated transcripts after processing is complete, and to download intents and slot-types generated by the bot recommendation.

Link copied to clipboard

Monitors the bot replication status through the UI console.

Link copied to clipboard

Returns information about a request to generate a bot through natural language description, made through the StartBotResource API. Use the generatedBotLocaleUrl to retrieve the Amazon S3 object containing the bot locale configuration. You can then modify and import this configuration.

Link copied to clipboard

Provides metadata about a version of a bot.

Link copied to clipboard

Provides metadata information about a custom vocabulary.

Link copied to clipboard

Gets information about a specific export.

Link copied to clipboard

Gets information about a specific import.

Link copied to clipboard

Returns metadata about an intent.

Link copied to clipboard

Gets the resource policy and policy revision for a bot or bot alias.

Link copied to clipboard

Gets metadata information about a slot.

Link copied to clipboard

Gets metadata information about a slot type.

Link copied to clipboard

Gets metadata information about the test execution.

Link copied to clipboard

Gets metadata information about the test set.

Link copied to clipboard

Gets metadata information about the test set discrepancy report.

Link copied to clipboard

Gets metadata information about the test set generation.

Link copied to clipboard

Generates sample utterances for an intent.

Link copied to clipboard

The pre-signed Amazon S3 URL to download the test execution result artifacts.

Link copied to clipboard

Provides a list of utterances that users have sent to the bot.

Link copied to clipboard

Gets a list of aliases for the specified bot.

Link copied to clipboard

The action to list the replicated bots created from the source bot alias.

Link copied to clipboard

Gets a list of locales for the specified bot.

Link copied to clipboard

Get a list of bot recommendations that meet the specified criteria.

Link copied to clipboard

The action to list the replicated bots.

Link copied to clipboard

Lists the generation requests made for a bot locale.

Link copied to clipboard
inline suspend fun LexModelsV2Client.listBots(crossinline block: ListBotsRequest.Builder.() -> Unit): ListBotsResponse

Gets a list of available bots.

Link copied to clipboard
Link copied to clipboard

Contains information about all the versions replication statuses applicable for Global Resiliency.

Link copied to clipboard

Gets information about all of the versions of a bot.

Link copied to clipboard

Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.

Link copied to clipboard

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

Link copied to clipboard

Paginated list of custom vocabulary items for a given bot locale's custom vocabulary.

Link copied to clipboard

Lists the exports for a bot, bot locale, or custom vocabulary. Exports are kept in the list for 7 days.

Link copied to clipboard
Link copied to clipboard

Lists the imports for a bot, bot locale, or custom vocabulary. Imports are kept in the list for 7 days.

Link copied to clipboard
Link copied to clipboard

Retrieves summary metrics for the intents in your bot. The following fields are required:

Link copied to clipboard

Retrieves summary statistics for a path of intents that users take over sessions with your bot. The following fields are required:

Link copied to clipboard

Get a list of intents that meet the specified criteria.

Link copied to clipboard

Retrieves summary metrics for the stages within intents in your bot. The following fields are required:

Link copied to clipboard

Gets a list of recommended intents provided by the bot recommendation that you can use in your bot. Intents in the response are ordered by relevance.

Link copied to clipboard

Retrieves a list of metadata for individual user sessions with your bot. The startDateTime and endDateTime fields are required. These fields define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways:

Link copied to clipboard

Retrieves summary metrics for the user sessions with your bot. The following fields are required:

Link copied to clipboard
inline suspend fun LexModelsV2Client.listSlots(crossinline block: ListSlotsRequest.Builder.() -> Unit): ListSlotsResponse

Gets a list of slots that match the specified criteria.

Link copied to clipboard

Gets a list of slot types that match the specified criteria.

Link copied to clipboard

Gets a list of tags associated with a resource. Only bots, bot aliases, and bot channels can have tags associated with them.

Link copied to clipboard

Gets a list of test execution result items.

Link copied to clipboard

The list of test set executions.

Link copied to clipboard

The list of test set records.

Link copied to clipboard

The list of the test sets

Link copied to clipboard

To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics. See Viewing utterance statistics for the IAM policy to apply to the IAM role.

Link copied to clipboard

To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics. See Viewing utterance statistics for the IAM policy to apply to the IAM role.

Link copied to clipboard

Search for associated transcripts that meet the specified criteria.

Link copied to clipboard

Use this to provide your transcript data, and to start the bot recommendation process.

Link copied to clipboard

Starts a request for the descriptive bot builder to generate a bot locale configuration based on the prompt you provide it. After you make this call, use the DescribeBotResourceGeneration operation to check on the status of the generation and for the generatedBotLocaleUrl when the generation is complete. Use that value to retrieve the Amazon S3 object containing the bot locale configuration. You can then modify and import this configuration.

Link copied to clipboard

Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket.

Link copied to clipboard

The action to start test set execution.

Link copied to clipboard

The action to start the generation of test set.

Link copied to clipboard

Stop an already running Bot Recommendation request.

Link copied to clipboard

Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.

Link copied to clipboard

Removes tags from a bot, bot alias, or bot channel.

Link copied to clipboard
inline suspend fun LexModelsV2Client.updateBot(crossinline block: UpdateBotRequest.Builder.() -> Unit): UpdateBotResponse

Updates the configuration of an existing bot.

Link copied to clipboard

Updates the configuration of an existing bot alias.

Link copied to clipboard

Updates the settings that a bot has for a specific locale.

Link copied to clipboard

Updates an existing bot recommendation request.

Link copied to clipboard

Updates the password used to protect an export zip archive.

Link copied to clipboard

Updates the settings for an intent.

Link copied to clipboard

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.

Link copied to clipboard
inline suspend fun LexModelsV2Client.updateSlot(crossinline block: UpdateSlotRequest.Builder.() -> Unit): UpdateSlotResponse

Updates the settings for a slot.

Link copied to clipboard

Updates the configuration of an existing slot type.

Link copied to clipboard

The action to update the test set.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.