Spec-Zone.ru › AWS CLI v2

[ aws . lexv2-models ]

list-session-metrics

Описание

Получает сводные метрики для пользовательских сеансов с вашим ботом. Требуются следующие поля:

  • metrics – Список объектов AnalyticsSessionMetric. В каждом объекте используйте поле name для указания метрики для расчёта, поле statistic для указания, следует ли рассчитывать Sum , Average или Max значение, и поле order для указания, следует ли сортировать результаты в порядке Ascending или Descending.
  • startDateTime и endDateTime – Определяют временной диапазон, для которого необходимо получить результаты.

Из необязательных полей вы можете организовать результаты следующим образом:

  • Используйте поле filters для фильтрации результатов, поле groupBy для указания категорий группировки результатов и поле binBy для указания интервалов времени группировки результатов.
  • Используйте поле maxResults для ограничения количества результатов в одном ответе и поле nextToken для получения следующей группы результатов, если ответ не возвращает весь набор результатов.

Обратите внимание, что поле order существует в обоих binBy и metrics. В настоящее время вы можете указать его в любом поле, но не в обоих.

См. также: AWS API Документация

Синтаксис

  list-session-metrics
--bot-id <value>
--start-date-time <value>
--end-date-time <value>
--metrics <value>
[--bin-by <value>]
[--group-by <value>]
[--filters <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--bot-id (строка)

Идентификатор бота, для которого вы хотите получить метрики сеансов.

--start-date-time (метка времени)

Дата и время начала диапазона, для которого вы хотите получить метрики сеансов.

--end-date-time (метка времени)

Дата и время окончания диапазона, для которого вы хотите получить метрики сеансов.

--metrics (список)

Список объектов, каждый из которых содержит метрику, которую вы хотите получить, статистику для этой метрики и способ организации результатов.

(структура)

Содержит метрику и сводную статистику, которые нужно вычислить, а также порядок сортировки результатов для сеансов пользователей с ботом.

name -> (строка)

Метрика, для которой нужно получить сводную статистику по сеансам.

  • Count – Количество сеансов.
  • Success – Количество успешных сеансов.
  • Failure – Количество неудачных сеансов.
  • Dropped – Количество сеансов, прерванных пользователем.
  • Duration – Длительность сеансов.
  • TurnsPerSession – Количество раундов в сеансах.
  • Concurrency – Количество сеансов, происходящих в один и тот же период времени.

statistic -> (строка)

Сводная статистика для вычисления.

  • Sum – Общее количество для категории, указанной в name.
  • Average – Общее количество, поделённое на количество сеансов в категории, указанной в name.
  • Max – Максимальное количество в категории, указанной в name.

order -> (строка)

Указывает, в порядке возрастания или убывания нужно сортировать результаты.

Краткий синтаксис:

name=string,statistic=string,order=string ...

Синтаксис JSON:

[
  {
    "name": "Count"|"Success"|"Failure"|"Dropped"|"Duration"|"TurnsPerConversation"|"Concurrency",
    "statistic": "Sum"|"Avg"|"Max",
    "order": "Ascending"|"Descending"
  }
  ...
]

--bin-by (список)

Список объектов, каждый из которых содержит параметры для организации результатов по времени.

(структура)

Содержит метрику времени, интервал и метод для группировки данных аналитики.

name -> (строка)

Указывает метрику времени для группировки данных аналитики.

interval -> (строка)

Указывает интервал времени для группировки данных аналитики.

order -> (строка)

Указывает, в порядке возрастания или убывания нужно группировать данные аналитики. Если это поле пустое, используется порядок по ключу группы по убыванию.

Краткий синтаксис:

name=string,interval=string,order=string ...

Синтаксис JSON:

[
  {
    "name": "ConversationStartTime"|"UtteranceTimestamp",
    "interval": "OneHour"|"OneDay",
    "order": "Ascending"|"Descending"
  }
  ...
]

--group-by (список)

Список объектов, каждый из которых определяет, как сгруппировать результаты. Можно группировать по следующим критериям:

  • ConversationEndState – Конечное состояние разговора. Возможные конечные состояния подробно описаны в разделе «Определения ключевых слов» руководства пользователя.
  • LocaleId – Уникальный идентификатор локали бота.

(структура)

Содержит категорию, по которой нужно сгруппировать сеансы.

name -> (строка)

Указывает, нужно ли группировать сеансы по их конечному состоянию или локали.

Краткий синтаксис:

name=string ...

Синтаксис JSON:

[
  {
    "name": "ConversationEndState"|"LocaleId"
  }
  ...
]

--filters (список)

Список объектов, каждый из которых описывает условие для фильтрации результатов.

(структура)

Содержит поля, описывающие условие для фильтрации сеансов. Выражение можно рассматривать как name operator values. Например:

  • LocaleId EQ en – Локаль равна “en”.
  • Duration GT 200 – Длительность больше 200 секунд.

Операторы, которые поддерживает каждый фильтр, перечислены ниже:

  • BotAlias – EQ.
  • BotVersion – EQ.
  • LocaleId – EQ.
  • Modality – EQ.
  • Channel – EQ.
  • Duration – EQ, GT, LT.
  • conversationEndState – EQ, CO.
  • SessionId – EQ.
  • OriginatingRequestId – EQ.
  • IntentPath – EQ.

name -> (строка)

Категория для фильтрации сеансов. Описания для каждого варианта:

  • BotAlias – Название псевдонима бота.
  • BotVersion – Версия бота.
  • LocaleId – Локаль бота.
  • Modality – Модальность сеанса с ботом (аудио, DTMF или текст).
  • Channel – Канал интеграции бота.
  • Duration – Длительность сеанса.
  • conversationEndState – Конечное состояние сеанса.
  • SessionId – Идентификатор сеанса с ботом.
  • OriginatingRequestId – Идентификатор первого запроса в сеансе.
  • IntentPath – Порядок интентов в сеансе.

operator -> (строка)

Операция для фильтрации категории. Возможные операции:

  • CO – Содержит
  • EQ – Равно
  • GT – Больше
  • LT – Меньше

Операторы, которые поддерживает каждый фильтр, перечислены ниже:

  • BotAlias – EQ.
  • BotVersion – EQ.
  • LocaleId – EQ.
  • Modality – EQ.
  • Channel – EQ.
  • EQ – Duration, EQ, GT.
  • Duration – LT, conversationEndState.
  • conversationEndState – EQ.
  • SessionId – EQ.
  • OriginatingRequestId – EQ.

values -> (список)

Массив, содержащий значения категории, к которым применять оператор для фильтрации результатов. Можно указать несколько значений, если оператор равен EQ или CO. Если вы предоставляете несколько значений, фильтр подбирает результаты, которые равны/содержат любое из значений. Например, если поля name, operator и values содержат Modality, EQ и [Speech, Text], операция фильтрует результаты, где модальность была либо Speech, либо Text.

(строка)

Краткий синтаксис:

name=string,operator=string,values=string,string ...

Синтаксис JSON:

[
  {
    "name": "BotAliasId"|"BotVersion"|"LocaleId"|"Modality"|"Channel"|"Duration"|"ConversationEndState"|"SessionId"|"OriginatingRequestId"|"IntentPath",
    "operator": "EQ"|"GT"|"LT",
    "values": ["string", ...]
  }
  ...
]

--max-results (целое число)

Максимальное количество результатов, возвращаемых на каждой странице. Если результатов меньше, чем максимальный размер страницы, возвращается только фактическое количество результатов.

--next-token (строка)

Если операция ListSessionMetrics возвращает больше результатов, чем указано в параметре maxResults, в ответе возвращается маркер.

Используйте возвращённый маркер в параметре nextToken запроса ListSessionMetrics, чтобы получить следующую страницу результатов. Для получения всех результатов вызывайте операцию ListSessionMetrics до тех пор, пока в ответе nextToken не будет null.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка имеет формат, предоставленный --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределяют значения из JSON. Невозможно передавать произвольные двоичные данные с помощью JSON-значения, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено значение null или input, выводится пример JSON-ввода, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, будет выведен пример ввода YAML, который можно использовать с --cli-input-yaml. Если предоставлено output, проверяются вводимые команды и возвращается пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (boolean)

Включить отладку логов.

--endpoint-url (string)

Переопределить URL по умолчанию команды на указанный URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один запрос для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определенный профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки конфигурации/окружения.

--version (string)

Показать версию этого инструмента.

--color (string)

Включить/отключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Файл сертификата CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/окружения.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое сопоставляется с двоичным блоком fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного формата cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматическое запросы параметров ввода CLI.

Вывод

botId -> (string)

Идентификатор бота, для которого были получены метрики сеансов.

results -> (list)

Результаты для метрик сеансов.

(структура)

Объект, содержащий результаты запрошенных метрик сеансов и бины и/или группы, если применимо.

binKeys -> (list)

Список объектов, содержащих критерии, запрошенные для разбиения результатов по группам и значения бинов.

(структура)

Объект, содержащий критерий для группировки результатов и значение, определяющее эту группу.

name -> (string)

Критерий для группировки результатов.

value -> (long)

Значение критерия, определяющее группу.

groupByKeys -> (list)

Список объектов, содержащих критерии, запрошенные для группировки результатов, и значения групп.

(структура)

Содержит категорию, по которой были сгруппированы аналитические данные сеанса, и элемент этой категории.

name -> (string)

Категория, по которой были сгруппированы аналитические данные сеанса.

value -> (string)

Элемент категории, по которой были сгруппированы аналитические данные сеанса.

metricsResults -> (list)

Список объектов, каждый из которых содержит метрику, которую вы хотите отобразить, статистику для метрики, которую вы хотите получить, и метод организации результатов.

(структура)

Объект, содержащий результаты запрошенной метрики сеанса.

name -> (string)

Запрошенная метрика.

  • Count – Количество сеансов.
  • Success – Количество успешных сеансов.
  • Failure – Количество неудачных сеансов.
  • Dropped – Количество сеансов, которые пользователь прервал.
  • Duration – Длительность сеансов.
  • TurnPersession – Количество ходов в сеансах.
  • Concurrency – Количество сеансов, происходящих в одном временном интервале.

statistic -> (string)

Запрошенная итоговая статистика.

  • Sum – Общее количество для категории, указанной в name.
  • Average – Общее количество, делённое на количество сеансов в категории, указанной в name.
  • Max – Максимальное количество в категории, указанной в name.

value -> (double)

Значение итоговой статистики для запрошенной метрики.

nextToken -> (string)

Если ответ от операции ListSessionMetrics содержит больше результатов, чем указано в параметре maxResults, в ответе возвращается маркер.

Используйте возвращённый маркер в параметре nextToken запроса ListSessionMetrics, чтобы получить следующую страницу результатов. Для получения полного набора результатов вызывайте операцию ListSessionMetrics, пока в ответе не вернётся null в параметре nextToken.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API