intent_paths

Creates, updates, deletes, gets or lists an intent_paths resource.

Overview

Name	intent_paths
Type	Resource
Id	aws.lexv2_models.intent_paths

Fields

The following fields are returned by SELECT queries:

list_intent_paths

Name	Datatype	Description
node_summaries	array	A list of objects, each of which contains information about a node in the intent path for which you requested metrics.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_intent_paths	select	bot_id, region		Retrieves summary statistics for a path of intents that users take over sessions with your bot. The following fields are required: startDateTime and endDateTime – Define a time range for which you want to retrieve results. intentPath – Define an order of intents for which you want to retrieve metrics. Separate intents in the path with a forward slash. For example, populate the intentPath field with /BookCar/BookHotel to see details about how many times users invoked the BookCar and BookHotel intents in that order. Use the optional filters field to filter the results.

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 identifier for the bot for which you want to retrieve intent path metrics.
region	string	AWS region (default: us-east-1)

SELECT examples

list_intent_paths

Retrieves summary statistics for a path of intents that users take over sessions with your bot. The following fields are required: startDateTime and endDateTime – Define a time range for which you want to retrieve results. intentPath – Define an order of intents for which you want to retrieve metrics. Separate intents in the path with a forward slash. For example, populate the intentPath field with /BookCar/BookHotel to see details about how many times users invoked the BookCar and BookHotel intents in that order. Use the optional filters field to filter the results.

SELECT
node_summaries
FROM aws.lexv2_models.intent_paths
WHERE bot_id = '{{ bot_id }}' -- required
AND region = '{{ region }}' -- required
;