Spec-Zone.ru › AWS CLI v2

[ aws . lexv2-модели ]

list-aggregated-utterances

Описание

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

Фразы агрегируются по тексту фразы. Например, все случаи, когда клиенты использовали фразу «Я хочу заказать пиццу», агрегируются в одну строку в ответе.

Вы можете видеть как распознанные фразы, так и пропущенные. Распознанная фраза — это та, которую бот правильно распознал и активировал соответствующее намерение. Пропущенная фраза — это фраза, которая не была распознана ботом и не активировала намерение.

Фразы могут быть агрегированы для алиаса бота или для версии бота, но не для обоих одновременно.

Статистика фраз не генерируется в следующих случаях:

  • Поле childDirected было установлено в значение true при создании бота.
  • Вы используете обфускацию слотов с одним или несколькими слотами.
  • Вы отказались от участия в улучшении Amazon Lex.

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

Синтаксис

  list-aggregated-utterances
--bot-id <value>
[--bot-alias-id <value>]
[--bot-version <value>]
--locale-id <value>
--aggregation-duration <value>
[--sort-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 (строка)

Уникальный идентификатор бота, связанного с этим запросом.

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

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

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

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

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

Идентификатор языка и региона, в котором были собраны фразы. Дополнительную информацию см. в разделе Поддерживаемые языки.

--aggregation-duration (структура)

Временной интервал для агрегирования информации о фразах. Вы можете указать интервал от одного часа до двух недель.

relativeAggregationDuration -> (структура)

Желаемый временной интервал для агрегирования фраз.

timeDimension -> (строка)

Тип временного периода, который представляет поле timeValue.

timeValue -> (целое число)

Период временного интервала для сбора статистики. Допустимое значение зависит от настройки поля timeDimension.

  • Hours - 1/3/6/12/24
  • Days - 3
  • Weeks - 1/2

Сокращенный синтаксис:

relativeAggregationDuration={timeDimension=string,timeValue=integer}

Синтаксис JSON:

{
  "relativeAggregationDuration": {
    "timeDimension": "Hours"|"Days"|"Weeks",
    "timeValue": integer
  }
}

--sort-by (структура)

Указывает параметры сортировки списка фраз. Вы можете сортировать по количеству совпадений, количеству пропущенных фраз или количеству уникальных сеансов, в которых появлялась фраза.

attribute -> (строка)

Атрибут фразы для сортировки.

order -> (строка)

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

Сокращенный синтаксис:

attribute=string,order=string

Синтаксис JSON:

{
  "attribute": "HitCount"|"MissedCount",
  "order": "Ascending"|"Descending"
}

--filters (список)

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

(структура)

Фильтры ответы, возвращаемые операцией ListAggregatedUtterances.

name -> (строка)

Имя поля для фильтрации списка фраз.

values -> (список)

Значение для фильтрации списка ботов.

(строка)

operator -> (строка)

Оператор для фильтра. Укажите EQ, когда операция ListAggregatedUtterances должна возвращать только фразы, равные указанному значению. Укажите CO, когда операция ListAggregatedUtterances должна возвращать фразы, содержащие указанное значение.

Сокращенный синтаксис:

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

Синтаксис JSON:

[
  {
    "name": "Utterance",
    "values": ["string", ...],
    "operator": "CO"|"EQ"
  }
  ...
]

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

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

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

Если ответ операции ListAggregatedUtterances содержит больше результатов, чем указано в параметре maxResults, то в ответе возвращается маркер. Используйте этот маркер в параметре nextToken, чтобы получить следующую страницу результатов.

--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 (логическое значение)

Включить отладочную запись.

--endpoint-url (строка)

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

--no-verify-ssl (логическое значение)

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

--no-paginate (логическое значение)

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

--output (строка)

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

  • json
  • text
  • таблица
  • yaml
  • yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • включено
  • выключено
  • автоматически

--no-sign-request (логическое значение)

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

--ca-bundle (строка)

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

--cli-read-timeout (целое число)

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

--cli-connect-timeout (целое число)

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

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — 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 (логическое значение)

Отключить вывод страниц cli.

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

botId -> (строка)

Идентификатор бота, содержащего высказывания.

botAliasId -> (строка)

Идентификатор псевдонима бота, содержащего высказывания. Если вы указали версию бота, идентификатор псевдонима бота не возвращается.

botVersion -> (строка)

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

localeId -> (строка)

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

aggregationDuration -> (структура)

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

relativeAggregationDuration -> (структура)

Желаемый временной интервал для агрегирования высказываний.

timeDimension -> (строка)

Тип временного периода, представленного в поле timeValue.

timeValue -> (целое число)

Период временного интервала для сбора статистики. Допустимое значение зависит от настройки поля timeDimension.

  • Hours - 1/3/6/12/24
  • Days - 3
  • Weeks - 1/2

aggregationWindowStartTime -> (метка времени)

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

aggregationWindowEndTime -> (метка времени)

Дата и время окончания интервала агрегации. В результатах возвращаются только данные, собранные между начальным и конечным временем.

aggregationLastRefreshedDateTime -> (метка времени)

Последняя дата и время сбора агрегированных данных. Период времени зависит от длины интервала агрегации.

  • Часы - для 1-часового интервала, каждые полчаса; в противном случае каждый час.
  • Дни - каждые 6 часов
  • Недели - для еженедельного интервала, каждые 12 часов; в противном случае каждый день

aggregatedUtterancesSummaries -> (список)

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

(структура)

Предоставляет сводную информацию об агрегированных высказываниях. Операция ListAggregatedUtterances объединяет все экземпляры одного и того же высказывания в одну сводную агрегированную сводку.

utterance -> (строка)

Текст высказывания. Если высказывание использовалось с операцией RecognizeUtterance, текст представляет собой транскрипцию аудио-высказывания.

hitCount -> (целое число)

Количество раз, когда высказывание было распознано Amazon Lex в течение данного периода времени. При распознавании высказывания активируется намерение или слот.

missedCount -> (целое число)

Количество раз, когда высказывание было пропущено Amazon Lex. Высказывание пропускается, когда оно не активирует намерение или слот.

utteranceFirstRecordedInAggregationDuration -> (метка времени)

Дата и время первого записи высказывания в временной интервал агрегации. Высказывание могло быть отправлено в Amazon Lex до этого времени, но учитываются только высказывания в указанном временном интервале.

utteranceLastRecordedInAggregationDuration -> (метка времени)

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

containsDataFromDeletedResources -> (логическое значение)

Агрегированные данные высказываний могут содержать высказывания из версий вашего бота, которые были удалены. Если агрегированные данные содержат такие данные, это поле устанавливается в значение true.

nextToken -> (строка)

Токен, указывающий, есть ли еще результаты для возвращения в ответе на операцию ListAggregatedUtterances. Если поле nextToken присутствует, вы отправляете его содержимое в качестве параметра nextToken запроса операции ListAggregatedUtterances для получения следующей страницы результатов.

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

Spec-Zone.ru

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