list-utterance-metrics

Описание

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

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

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

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

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

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

Синопсис

  list-utterance-metrics
--bot-id <value>
--start-date-time <value>
--end-date-time <value>
--metrics <value>
[--bin-by <value>]
[--group-by <value>]
[--attributes <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=string,statistic=string,order=string ...

Синтаксис JSON:

[
  {
    "name": "Count"|"Missed"|"Detected"|"UtteranceTimestamp",
    "statistic": "Sum"|"Avg"|"Max",
    "order": "Ascending"|"Descending"
  }
  ...
]

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

Сокращенная синтаксическая запись:

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

Синтаксис JSON:

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

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

Сокращенная синтаксическая запись:

name=string ...

Синтаксис JSON:

[
  {
    "name": "UtteranceText"|"UtteranceState"
  }
  ...
]

--attributes (список)

Сокращенная синтаксическая запись:

name=string ...

Синтаксис JSON:

[
  {
    "name": "LastUsedIntent"
  }
  ...
]

--filters (список)

Сокращенная синтаксическая запись:

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

Синтаксис JSON:

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

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

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

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

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. При отсутствии значения или значении 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)

nextToken -> (string)