Skip to content

List Intent Paths

lexmodelsv2_list_intent_paths R Documentation

Retrieves summary statistics for a path of intents that users take over sessions with your bot

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.

Usage

lexmodelsv2_list_intent_paths(botId, startDateTime, endDateTime,
  intentPath, filters)

Arguments

botId

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

startDateTime

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

endDateTime

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

intentPath

[required] 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

filters

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

Value

A list with the following syntax: 

list(
  nodeSummaries = list(
    list(
      intentName = "string",
      intentPath = "string",
      intentCount = 123,
      intentLevel = 123,
      nodeType = "Inner"|"Exit"
    )
  )
)

Request syntax

svc$list_intent_paths(
  botId = "string",
  startDateTime = as.POSIXct(
    "2015-01-01"
  ),
  endDateTime = as.POSIXct(
    "2015-01-01"
  ),
  intentPath = "string",
  filters = list(
    list(
      name = "BotAliasId"|"BotVersion"|"LocaleId"|"Modality"|"Channel",
      operator = "EQ"|"GT"|"LT",
      values = list(
        "string"
      )
    )
  )
)