utterances_views
Creates, updates, deletes, gets or lists a utterances_views resource.
Overview
| Name | utterances_views |
| Type | Resource |
| Id | aws.lex_models.utterances_views |
Fields
The following fields are returned by SELECT queries:
- get_utterances_view
| Name | Datatype | Description |
|---|---|---|
bot_name | string | The name of the bot for which utterance information was returned. (pattern: <code>^([A-Za-z]_?)+$</code>) |
utterances | array | An array of UtteranceList objects, each containing a list of UtteranceData objects describing the utterances that were processed by your bot. The response contains a maximum of 100 UtteranceData objects for each version. Amazon Lex returns the most frequent utterances received by the bot in the last 15 days. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_utterances_view | select | botname, bot_versions, status_type, region | 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. Utterance statistics are generated once a day. Data is available for the last 15 days. You can request information for up to 5 versions of your bot in each request. Amazon Lex returns the most frequent utterances received by the bot in the last 15 days. The response contains information about a maximum of 100 utterances for each version. If you set childDirected field to true when you created your bot, if you are using slot obfuscation with one or more slots, or if you opted out of participating in improving Amazon Lex, utterances are not available. This operation requires permissions for the lex:GetUtterancesView action. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
bot_versions | array | An array of bot versions for which utterance information should be returned. The limit is 5 versions per request. |
botname | string | The name of the bot for which utterance information should be returned. |
region | string | AWS region (default: us-east-1) |
status_type | string | To return utterances that were recognized and handled, use Detected. To return utterances that were not recognized, use Missed. |
SELECT examples
- get_utterances_view
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. Utterance statistics are generated once a day. Data is available for the last 15 days. You can request information for up to 5 versions of your bot in each request. Amazon Lex returns the most frequent utterances received by the bot in the last 15 days. The response contains information about a maximum of 100 utterances for each version. If you set childDirected field to true when you created your bot, if you are using slot obfuscation with one or more slots, or if you opted out of participating in improving Amazon Lex, utterances are not available. This operation requires permissions for the lex:GetUtterancesView action.
SELECT
bot_name,
utterances
FROM aws.lex_models.utterances_views
WHERE botname = '{{ botname }}' -- required
AND bot_versions = '{{ bot_versions }}' -- required
AND status_type = '{{ status_type }}' -- required
AND region = '{{ region }}' -- required
;