lexmodelsv2_list_session_metrics: Retrieves summary metrics for the user sessions with your bot
In paws.machine.learning: 'Amazon Web Services' Machine Learning Services

lexmodelsv2_list_session_metrics

R Documentation

Retrieves summary metrics for the user sessions with your bot

Description

Retrieves summary metrics for the user sessions with your bot. The following fields are required:

See https://www.paws-r-sdk.com/docs/lexmodelsv2_list_session_metrics/ for full documentation.

Usage

lexmodelsv2_list_session_metrics(
  botId,
  startDateTime,
  endDateTime,
  metrics,
  binBy = NULL,
  groupBy = NULL,
  filters = NULL,
  maxResults = NULL,
  nextToken = NULL
)

Arguments

`botId`	[required] The identifier for the bot for which you want to retrieve session metrics.
`startDateTime`	[required] The date and time that marks the beginning of the range of time for which you want to see session metrics.
`endDateTime`	[required] The date and time that marks the end of the range of time for which you want to see session metrics.
`metrics`	[required] A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
`binBy`	A list of objects, each of which contains specifications for organizing the results by time.
`groupBy`	A list of objects, each of which specifies how to group the results. You can group by the following criteria: `ConversationEndState` – The final state of the conversation. The possible end states are detailed in Key definitions in the user guide. `LocaleId` – The unique identifier of the bot locale.
`filters`	A list of objects, each of which describes a condition by which you want to filter the results.
`maxResults`	The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
`nextToken`	If the response from the ListSessionMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use the returned token in the nextToken parameter of a ListSessionMetrics request to return the next page of results. For a complete set of results, call the ListSessionMetrics operation until the nextToken returned in the response is null.