Skip to content
AWS for Query.Farm

aws.lexv2_models.list_intent_paths

Example SQL Queries

SELECT * FROM
aws.lexv2_models.list_intent_paths
WHERE
"bot_id" = 'VALUE'
AND "start_date_time" = 'VALUE'
AND "end_date_time" = 'VALUE'
AND "intent_path" = 'VALUE';

Description

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.

Table Definition

Column NameColumn Data Type
bot_id Required Input Column

The identifier for the bot for which you want to retrieve intent path metrics.

VARCHAR
end_date_time Required Input Column

The date and time that marks the end of the range of time for which you want to see intent path metrics.

TIMESTAMP_S
intent_path Required Input Column

The intent path for which you want to retrieve metrics. Use a forward slash to separate intents in the path. For example:

  • /BookCar

  • /BookCar/BookHotel

  • /BookHotel/BookCar

VARCHAR
start_date_time Required Input Column

The date and time that marks the beginning of the range of time for which you want to see intent path metrics.

TIMESTAMP_S
filters Input Column

A list of objects, each describes a condition by which you want to filter the results.

STRUCT(
    "name" VARCHAR,
    "operator" VARCHAR,
    "values" VARCHAR[]
)[]
Show child fields
filters[]
Show child fields
filters[].name

The category by which to filter the intent paths. The descriptions for each option are as follows:

  • BotAlias – The name of the bot alias.

  • BotVersion – The version of the bot.

  • LocaleId – The locale of the bot.

  • Modality – The modality of the session with the bot (audio, DTMF, or text).

  • Channel – The channel that the bot is integrated with.

filters[].operator

The operation by which to filter the category. The following operations are possible:

  • CO – Contains

  • EQ – Equals

  • GT – Greater than

  • LT – Less than

The operators that each filter supports are listed below:

  • BotAlias – EQ.

  • BotVersion – EQ.

  • LocaleId – EQ.

  • Modality – EQ.

  • Channel – EQ.

filters[].values[]
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

node_summaries

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

STRUCT(
    "intent_name" VARCHAR,
    "intent_path" VARCHAR,
    "intent_count" BIGINT,
    "intent_level" BIGINT,
    "node_type" VARCHAR
)[]
Show child fields
node_summaries[]
Show child fields
node_summaries[].intent_count

The total number of sessions that follow the given path to the given intent.

node_summaries[].intent_level

The number of intents up to and including the requested path.

node_summaries[].intent_name

The name of the intent at the end of the requested path.

node_summaries[].intent_path

The path.

node_summaries[].node_type

Specifies whether the node is the end of a path (Exit) or not (Inner).