aggregated_utterances
Creates, updates, deletes, gets or lists an aggregated_utterances resource.
Overview
| Name | aggregated_utterances |
| Type | Resource |
| Id | aws.lexv2_models.aggregated_utterances |
Fields
The following fields are returned by SELECT queries:
- list_aggregated_utterances
| Name | Datatype | Description |
|---|---|---|
aggregated_utterances_summaries | array | Summaries of the aggregated utterance data. Each response contains information about the number of times that the utterance was seen during the time period, whether it was detected or missed, and when it was seen during the time period. |
aggregation_duration | object | Provides parameters for setting the time window and duration for aggregating utterance data. |
aggregation_last_refreshed_date_time | string (date-time) | The last date and time that the aggregated data was collected. The time period depends on the length of the aggregation window. Hours - for 1 hour time window, every half hour; otherwise every hour. Days - every 6 hours Weeks - for a one week time window, every 12 hours; otherwise, every day |
aggregation_window_end_time | string (date-time) | The date and time that the aggregation window ends. Only data collected between the start time and the end time are returned in the results. |
aggregation_window_start_time | string (date-time) | The date and time that the aggregation window begins. Only data collected after this time is returned in the results. |
bot_alias_id | string | The identifier of the bot alias that contains the utterances. If you specified the bot version, the bot alias ID isn't returned. (pattern: <code>^(\bTSTALIASID\b|[0-9a-zA-Z]+)$</code>) |
bot_id | string | The identifier of the bot that contains the utterances. (pattern: <code>^[0-9a-zA-Z]+$</code>) |
bot_version | string | The identifier of the bot version that contains the utterances. If you specified the bot alias, the bot version isn't returned. (pattern: <code>^(DRAFT|[0-9]+)$</code>) |
locale_id | string | The identifier of the language and locale that the utterances are in. |
next_token | string | A token that indicates whether there are more results to return in a response to the ListAggregatedUtterances operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListAggregatedUtterances operation request to get the next page of results. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_aggregated_utterances | select | bot_id, region | Provides a list of utterances that users have sent to the bot. Utterances are aggregated by the text of the utterance. For example, all instances where customers used the phrase "I want to order pizza" are aggregated into the same line in the response. You can see both detected utterances and missed utterances. A detected utterance is where the bot properly recognized the utterance and activated the associated intent. A missed utterance was not recognized by the bot and didn't activate an intent. Utterances can be aggregated for a bot alias or for a bot version, but not both at the same time. Utterances statistics are not generated under the following conditions: The childDirected field was set to true when the bot was created. You are using slot obfuscation with one or more slots. You opted out of participating in improving Amazon Lex. |
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_id | string | The unique identifier of the bot associated with this request. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- list_aggregated_utterances
Provides a list of utterances that users have sent to the bot. Utterances are aggregated by the text of the utterance. For example, all instances where customers used the phrase "I want to order pizza" are aggregated into the same line in the response. You can see both detected utterances and missed utterances. A detected utterance is where the bot properly recognized the utterance and activated the associated intent. A missed utterance was not recognized by the bot and didn't activate an intent. Utterances can be aggregated for a bot alias or for a bot version, but not both at the same time. Utterances statistics are not generated under the following conditions: The childDirected field was set to true when the bot was created. You are using slot obfuscation with one or more slots. You opted out of participating in improving Amazon Lex.
SELECT
aggregated_utterances_summaries,
aggregation_duration,
aggregation_last_refreshed_date_time,
aggregation_window_end_time,
aggregation_window_start_time,
bot_alias_id,
bot_id,
bot_version,
locale_id,
next_token
FROM aws.lexv2_models.aggregated_utterances
WHERE bot_id = '{{ bot_id }}' -- required
AND region = '{{ region }}' -- required
;