@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonLexModelBuilding extends Object implements AmazonLexModelBuilding
AmazonLexModelBuilding
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
CreateBotVersionResult |
createBotVersion(CreateBotVersionRequest request)
Creates a new version of the bot based on the
$LATEST version. |
CreateIntentVersionResult |
createIntentVersion(CreateIntentVersionRequest request)
Creates a new version of an intent based on the
$LATEST version of the intent. |
CreateSlotTypeVersionResult |
createSlotTypeVersion(CreateSlotTypeVersionRequest request)
Creates a new version of a slot type based on the
$LATEST version of the specified slot type. |
DeleteBotResult |
deleteBot(DeleteBotRequest request)
Deletes all versions of the bot, including the
$LATEST version. |
DeleteBotAliasResult |
deleteBotAlias(DeleteBotAliasRequest request)
Deletes an alias for the specified bot.
|
DeleteBotChannelAssociationResult |
deleteBotChannelAssociation(DeleteBotChannelAssociationRequest request)
Deletes the association between an Amazon Lex bot and a messaging platform.
|
DeleteBotVersionResult |
deleteBotVersion(DeleteBotVersionRequest request)
Deletes a specific version of a bot.
|
DeleteIntentResult |
deleteIntent(DeleteIntentRequest request)
Deletes all versions of the intent, including the
$LATEST version. |
DeleteIntentVersionResult |
deleteIntentVersion(DeleteIntentVersionRequest request)
Deletes a specific version of an intent.
|
DeleteSlotTypeResult |
deleteSlotType(DeleteSlotTypeRequest request)
Deletes all versions of the slot type, including the
$LATEST version. |
DeleteSlotTypeVersionResult |
deleteSlotTypeVersion(DeleteSlotTypeVersionRequest request)
Deletes a specific version of a slot type.
|
DeleteUtterancesResult |
deleteUtterances(DeleteUtterancesRequest request)
Deletes stored utterances.
|
GetBotResult |
getBot(GetBotRequest request)
Returns metadata information for a specific bot.
|
GetBotAliasResult |
getBotAlias(GetBotAliasRequest request)
Returns information about an Amazon Lex bot alias.
|
GetBotAliasesResult |
getBotAliases(GetBotAliasesRequest request)
Returns a list of aliases for a specified Amazon Lex bot.
|
GetBotChannelAssociationResult |
getBotChannelAssociation(GetBotChannelAssociationRequest request)
Returns information about the association between an Amazon Lex bot and a messaging platform.
|
GetBotChannelAssociationsResult |
getBotChannelAssociations(GetBotChannelAssociationsRequest request)
Returns a list of all of the channels associated with the specified bot.
|
GetBotsResult |
getBots(GetBotsRequest request)
Returns bot information as follows:
|
GetBotVersionsResult |
getBotVersions(GetBotVersionsRequest request)
Gets information about all of the versions of a bot.
|
GetBuiltinIntentResult |
getBuiltinIntent(GetBuiltinIntentRequest request)
Returns information about a built-in intent.
|
GetBuiltinIntentsResult |
getBuiltinIntents(GetBuiltinIntentsRequest request)
Gets a list of built-in intents that meet the specified criteria.
|
GetBuiltinSlotTypesResult |
getBuiltinSlotTypes(GetBuiltinSlotTypesRequest request)
Gets a list of built-in slot types that meet the specified criteria.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetExportResult |
getExport(GetExportRequest request)
Exports the contents of a Amazon Lex resource in a specified format.
|
GetIntentResult |
getIntent(GetIntentRequest request)
Returns information about an intent.
|
GetIntentsResult |
getIntents(GetIntentsRequest request)
Returns intent information as follows:
|
GetIntentVersionsResult |
getIntentVersions(GetIntentVersionsRequest request)
Gets information about all of the versions of an intent.
|
GetSlotTypeResult |
getSlotType(GetSlotTypeRequest request)
Returns information about a specific version of a slot type.
|
GetSlotTypesResult |
getSlotTypes(GetSlotTypesRequest request)
Returns slot type information as follows:
|
GetSlotTypeVersionsResult |
getSlotTypeVersions(GetSlotTypeVersionsRequest request)
Gets information about all versions of a slot type.
|
GetUtterancesViewResult |
getUtterancesView(GetUtterancesViewRequest request)
Use the
GetUtterancesView operation to get information about the utterances that your users have
made to your bot. |
PutBotResult |
putBot(PutBotRequest request)
Creates an Amazon Lex conversational bot or replaces an existing bot.
|
PutBotAliasResult |
putBotAlias(PutBotAliasRequest request)
Creates an alias for the specified version of the bot or replaces an alias for the specified bot.
|
PutIntentResult |
putIntent(PutIntentRequest request)
Creates an intent or replaces an existing intent.
|
PutSlotTypeResult |
putSlotType(PutSlotTypeRequest request)
Creates a custom slot type or replaces an existing custom slot type.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
public CreateBotVersionResult createBotVersion(CreateBotVersionRequest request)
AmazonLexModelBuilding
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.
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.
createBotVersion
in interface AmazonLexModelBuilding
public CreateIntentVersionResult createIntentVersion(CreateIntentVersionRequest request)
AmazonLexModelBuilding
Creates a new version of an intent based on the $LATEST
version of the intent. If the
$LATEST
version of this intent hasn't changed since you last updated it, Amazon Lex doesn't create a
new version. It returns the last version you created.
You can update only the $LATEST
version of the intent. You can't update the numbered versions that
you create with the CreateIntentVersion
operation.
When you create a version of an intent, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro.
This operation requires permissions to perform the lex:CreateIntentVersion
action.
createIntentVersion
in interface AmazonLexModelBuilding
public CreateSlotTypeVersionResult createSlotTypeVersion(CreateSlotTypeVersionRequest request)
AmazonLexModelBuilding
Creates a new version of a slot type based on the $LATEST
version of the specified slot type. If the
$LATEST
version of this resource has not changed since the last version that you created, Amazon Lex
doesn't create a new version. It returns the last version that you created.
You can update only the $LATEST
version of a slot type. You can't update the numbered versions that
you create with the CreateSlotTypeVersion
operation.
When you create a version of a slot type, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro.
This operation requires permissions for the lex:CreateSlotTypeVersion
action.
createSlotTypeVersion
in interface AmazonLexModelBuilding
public DeleteBotResult deleteBot(DeleteBotRequest request)
AmazonLexModelBuilding
Deletes all versions of the bot, including the $LATEST
version. To delete a specific version of the
bot, use the DeleteBotVersion operation.
If a bot has an alias, you can't delete it. Instead, the DeleteBot
operation returns a
ResourceInUseException
exception that includes a reference to the alias that refers to the bot. To
remove the reference to the bot, delete the alias. If you get the same exception again, delete the referring
alias until the DeleteBot
operation is successful.
This operation requires permissions for the lex:DeleteBot
action.
deleteBot
in interface AmazonLexModelBuilding
public DeleteBotAliasResult deleteBotAlias(DeleteBotAliasRequest request)
AmazonLexModelBuilding
Deletes an alias for the specified bot.
You can't delete an alias that is used in the association between a bot and a messaging channel. If an alias is
used in a channel association, the DeleteBot
operation returns a ResourceInUseException
exception that includes a reference to the channel association that refers to the bot. You can remove the
reference to the alias by deleting the channel association. If you get the same exception again, delete the
referring association until the DeleteBotAlias
operation is successful.
deleteBotAlias
in interface AmazonLexModelBuilding
public DeleteBotChannelAssociationResult deleteBotChannelAssociation(DeleteBotChannelAssociationRequest request)
AmazonLexModelBuilding
Deletes the association between an Amazon Lex bot and a messaging platform.
This operation requires permission for the lex:DeleteBotChannelAssociation
action.
deleteBotChannelAssociation
in interface AmazonLexModelBuilding
public DeleteBotVersionResult deleteBotVersion(DeleteBotVersionRequest request)
AmazonLexModelBuilding
Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation.
This operation requires permissions for the lex:DeleteBotVersion
action.
deleteBotVersion
in interface AmazonLexModelBuilding
public DeleteIntentResult deleteIntent(DeleteIntentRequest request)
AmazonLexModelBuilding
Deletes all versions of the intent, including the $LATEST
version. To delete a specific version of
the intent, use the DeleteIntentVersion operation.
You can delete a version of an intent only if it is not referenced. To delete an intent that is referred to in one or more bots (see how-it-works), you must remove those references first.
If you get the ResourceInUseException
exception, it provides an example reference that shows where
the intent is referenced. To remove the reference to the intent, either update the bot or delete it. If you get
the same exception when you attempt to delete the intent again, repeat until the intent has no references and the
call to DeleteIntent
is successful.
This operation requires permission for the lex:DeleteIntent
action.
deleteIntent
in interface AmazonLexModelBuilding
public DeleteIntentVersionResult deleteIntentVersion(DeleteIntentVersionRequest request)
AmazonLexModelBuilding
Deletes a specific version of an intent. To delete all versions of a intent, use the DeleteIntent operation.
This operation requires permissions for the lex:DeleteIntentVersion
action.
deleteIntentVersion
in interface AmazonLexModelBuilding
public DeleteSlotTypeResult deleteSlotType(DeleteSlotTypeRequest request)
AmazonLexModelBuilding
Deletes all versions of the slot type, including the $LATEST
version. To delete a specific version
of the slot type, use the DeleteSlotTypeVersion operation.
You can delete a version of a slot type only if it is not referenced. To delete a slot type that is referred to in one or more intents, you must remove those references first.
If you get the ResourceInUseException
exception, the exception provides an example reference that
shows the intent where the slot type is referenced. To remove the reference to the slot type, either update the
intent or delete it. If you get the same exception when you attempt to delete the slot type again, repeat until
the slot type has no references and the DeleteSlotType
call is successful.
This operation requires permission for the lex:DeleteSlotType
action.
deleteSlotType
in interface AmazonLexModelBuilding
public DeleteSlotTypeVersionResult deleteSlotTypeVersion(DeleteSlotTypeVersionRequest request)
AmazonLexModelBuilding
Deletes a specific version of a slot type. To delete all versions of a slot type, use the DeleteSlotType operation.
This operation requires permissions for the lex:DeleteSlotTypeVersion
action.
deleteSlotTypeVersion
in interface AmazonLexModelBuilding
public DeleteUtterancesResult deleteUtterances(DeleteUtterancesRequest request)
AmazonLexModelBuilding
Deletes stored utterances.
Amazon Lex stores the utterances that users send to your bot unless the childDirected
field in the
bot is set to true
. Utterances are stored for 15 days for use with the GetUtterancesView
operation, and then stored indefinately for use in improving the ability of your bot to respond to user input.
Use the DeleteStoredUtterances
operation to manually delete stored utterances for a specific user.
This operation requires permissions for the lex:DeleteUtterances
action.
deleteUtterances
in interface AmazonLexModelBuilding
public GetBotResult getBot(GetBotRequest request)
AmazonLexModelBuilding
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.
getBot
in interface AmazonLexModelBuilding
public GetBotAliasResult getBotAlias(GetBotAliasRequest request)
AmazonLexModelBuilding
Returns information about an Amazon Lex bot alias. For more information about aliases, see versioning-aliases.
This operation requires permissions for the lex:GetBotAlias
action.
getBotAlias
in interface AmazonLexModelBuilding
public GetBotAliasesResult getBotAliases(GetBotAliasesRequest request)
AmazonLexModelBuilding
Returns a list of aliases for a specified Amazon Lex bot.
This operation requires permissions for the lex:GetBotAliases
action.
getBotAliases
in interface AmazonLexModelBuilding
public GetBotChannelAssociationResult getBotChannelAssociation(GetBotChannelAssociationRequest request)
AmazonLexModelBuilding
Returns information about the association between an Amazon Lex bot and a messaging platform.
This operation requires permissions for the lex:GetBotChannelAssociation
action.
getBotChannelAssociation
in interface AmazonLexModelBuilding
public GetBotChannelAssociationsResult getBotChannelAssociations(GetBotChannelAssociationsRequest request)
AmazonLexModelBuilding
Returns a list of all of the channels associated with the specified bot.
The GetBotChannelAssociations
operation requires permissions for the
lex:GetBotChannelAssociations
action.
getBotChannelAssociations
in interface AmazonLexModelBuilding
public GetBotVersionsResult getBotVersions(GetBotVersionsRequest request)
AmazonLexModelBuilding
Gets information about all of the versions of a bot.
The GetBotVersions
operation returns a BotMetadata
object for each version of a bot.
For example, if a bot has three numbered versions, the GetBotVersions
operation returns four
BotMetadata
objects in the response, one for each numbered version and one for the
$LATEST
version.
The GetBotVersions
operation always returns at least one version, the $LATEST
version.
This operation requires permissions for the lex:GetBotVersions
action.
getBotVersions
in interface AmazonLexModelBuilding
public GetBotsResult getBots(GetBotsRequest request)
AmazonLexModelBuilding
Returns bot information as follows:
If you provide the nameContains
field, the response includes information for the
$LATEST
version of all bots whose name contains the specified string.
If you don't specify the nameContains
field, the operation returns information about the
$LATEST
version of all of your bots.
This operation requires permission for the lex:GetBots
action.
getBots
in interface AmazonLexModelBuilding
public GetBuiltinIntentResult getBuiltinIntent(GetBuiltinIntentRequest request)
AmazonLexModelBuilding
Returns information about a built-in intent.
This operation requires permission for the lex:GetBuiltinIntent
action.
getBuiltinIntent
in interface AmazonLexModelBuilding
public GetBuiltinIntentsResult getBuiltinIntents(GetBuiltinIntentsRequest request)
AmazonLexModelBuilding
Gets a list of built-in intents that meet the specified criteria.
This operation requires permission for the lex:GetBuiltinIntents
action.
getBuiltinIntents
in interface AmazonLexModelBuilding
public GetBuiltinSlotTypesResult getBuiltinSlotTypes(GetBuiltinSlotTypesRequest request)
AmazonLexModelBuilding
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.
getBuiltinSlotTypes
in interface AmazonLexModelBuilding
public GetExportResult getExport(GetExportRequest request)
AmazonLexModelBuilding
Exports the contents of a Amazon Lex resource in a specified format.
getExport
in interface AmazonLexModelBuilding
public GetIntentResult getIntent(GetIntentRequest request)
AmazonLexModelBuilding
Returns information about an intent. In addition to the intent name, you must specify the intent version.
This operation requires permissions to perform the lex:GetIntent
action.
getIntent
in interface AmazonLexModelBuilding
public GetIntentVersionsResult getIntentVersions(GetIntentVersionsRequest request)
AmazonLexModelBuilding
Gets information about all of the versions of an intent.
The GetIntentVersions
operation returns an IntentMetadata
object for each version of an
intent. For example, if an intent has three numbered versions, the GetIntentVersions
operation
returns four IntentMetadata
objects in the response, one for each numbered version and one for the
$LATEST
version.
The GetIntentVersions
operation always returns at least one version, the $LATEST
version.
This operation requires permissions for the lex:GetIntentVersions
action.
getIntentVersions
in interface AmazonLexModelBuilding
public GetIntentsResult getIntents(GetIntentsRequest request)
AmazonLexModelBuilding
Returns intent information as follows:
If you specify the nameContains
field, returns the $LATEST
version of all intents that
contain the specified string.
If you don't specify the nameContains
field, returns information about the $LATEST
version of all intents.
The operation requires permission for the lex:GetIntents
action.
getIntents
in interface AmazonLexModelBuilding
public GetSlotTypeResult getSlotType(GetSlotTypeRequest request)
AmazonLexModelBuilding
Returns information about a specific version of a slot type. In addition to specifying the slot type name, you must specify the slot type version.
This operation requires permissions for the lex:GetSlotType
action.
getSlotType
in interface AmazonLexModelBuilding
public GetSlotTypeVersionsResult getSlotTypeVersions(GetSlotTypeVersionsRequest request)
AmazonLexModelBuilding
Gets information about all versions of a slot type.
The GetSlotTypeVersions
operation returns a SlotTypeMetadata
object for each version of
a slot type. For example, if a slot type has three numbered versions, the GetSlotTypeVersions
operation returns four SlotTypeMetadata
objects in the response, one for each numbered version and
one for the $LATEST
version.
The GetSlotTypeVersions
operation always returns at least one version, the $LATEST
version.
This operation requires permissions for the lex:GetSlotTypeVersions
action.
getSlotTypeVersions
in interface AmazonLexModelBuilding
public GetSlotTypesResult getSlotTypes(GetSlotTypesRequest request)
AmazonLexModelBuilding
Returns slot type information as follows:
If you specify the nameContains
field, returns the $LATEST
version of all slot types
that contain the specified string.
If you don't specify the nameContains
field, returns information about the $LATEST
version of all slot types.
The operation requires permission for the lex:GetSlotTypes
action.
getSlotTypes
in interface AmazonLexModelBuilding
public GetUtterancesViewResult getUtterancesView(GetUtterancesViewRequest request)
AmazonLexModelBuilding
Use the GetUtterancesView
operation to get information about the utterances that your users have
made to your bot. You can use this list to tune the utterances that your bot responds to.
For example, say that you have created a bot to order flowers. After your users have used your bot for a while,
use the GetUtterancesView
operation to see the requests that they have made and whether they have
been successful. You might find that the utterance "I want flowers" is not being recognized. You could add this
utterance to the OrderFlowers
intent so that your bot recognizes that utterance.
After you publish a new version of a bot, you can get information about the old version and the new so that you can compare the performance across the two versions.
Data is available for the last 15 days. You can request information for up to 5 versions in each request. The response contains information about a maximum of 100 utterances for each version.
If the bot's childDirected
field is set to true
, utterances for the bot are not stored
and cannot be retrieved with the GetUtterancesView
operation. For more information, see
PutBot.
This operation requires permissions for the lex:GetUtterancesView
action.
getUtterancesView
in interface AmazonLexModelBuilding
public PutBotResult putBot(PutBotRequest request)
AmazonLexModelBuilding
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. You can use this to add intents later, or to remove intents from an existing
bot. When you create a bot with a name only, 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.
putBot
in interface AmazonLexModelBuilding
public PutBotAliasResult putBotAlias(PutBotAliasRequest request)
AmazonLexModelBuilding
Creates an alias for the specified version of the bot or replaces an alias for the specified bot. To change the version of the bot that the alias points to, replace the alias. For more information about aliases, see versioning-aliases.
This operation requires permissions for the lex:PutBotAlias
action.
putBotAlias
in interface AmazonLexModelBuilding
public PutIntentResult putIntent(PutIntentRequest request)
AmazonLexModelBuilding
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 slot type 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.
For more information, see how-it-works.
This operation requires permissions for the lex:PutIntent
action.
putIntent
in interface AmazonLexModelBuilding
public PutSlotTypeResult putSlotType(PutSlotTypeRequest request)
AmazonLexModelBuilding
Creates a custom slot type or replaces an existing custom slot type.
To create a custom slot type, specify a name for the slot type and a set of enumeration values, which are the values that a slot of this type can assume. For more information, see how-it-works.
If you specify the name of an existing slot type, the fields in the request replace the existing values in the
$LATEST
version of the slot type. Amazon Lex removes the fields that you don't provide in the
request. If you don't specify required fields, Amazon Lex throws an exception.
This operation requires permissions for the lex:PutSlotType
action.
putSlotType
in interface AmazonLexModelBuilding
public void shutdown()
AmazonLexModelBuilding
shutdown
in interface AmazonLexModelBuilding
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonLexModelBuilding
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AmazonLexModelBuilding
request
- The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.