Spec-Zone.ru › AWS CLI v2

[ aws . lexv2-models ]

list-intent-paths

Описание

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

  • startDateTime и endDateTime – Определяют временной диапазон, для которого требуется получить результаты.
  • intentPath – Определяет порядок намерений, для которых требуется получить метрики. Разделяйте намерения в пути с помощью косой черты. Например, заполните поле intentPath значением /BookCar/BookHotel, чтобы увидеть подробности о том, сколько раз пользователи вызывали намерения BookCar и BookHotel в указанном порядке.

Используйте необязательное поле filters для фильтрации результатов.

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

Синтаксис

  list-intent-paths
--bot-id <value>
--start-date-time <value>
--end-date-time <value>
--intent-path <value>
[--filters <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 (метка времени)

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

--intent-path (строка)

Путь намерений, для которого требуется получить метрики. Используйте косую черту для разделения намерений в пути. Например:

  • /BookCar
  • /BookCar/BookHotel
  • /BookHotel/BookCar

--filters (список)

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

(структура)

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

  • LocaleId EQ en – Язык «en».
  • BotVersion EQ 2 – Версия бота равна двум.

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

  • BotAlias – EQ.
  • BotVersion – EQ.
  • LocaleId – EQ.
  • Modality – EQ.
  • Channel – EQ.

name -> (строка)

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

  • BotAlias – Имя алиаса бота.
  • BotVersion – Версия бота.
  • LocaleId – Язык бота.
  • Modality – Модальность сессии с ботом (аудио, DTMF или текст).
  • Channel – Канал интеграции бота.

operator -> (строка)

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

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

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

  • BotAlias – EQ.
  • BotVersion – EQ.
  • LocaleId – EQ.
  • Modality – EQ.
  • Channel – 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",
    "operator": "EQ"|"GT"|"LT",
    "values": ["string", ...]
  }
  ...
]

--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
  • текст
  • таблица
  • 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-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

nodeSummaries -> (список)

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

(структура)

Объект, содержащий информацию о запрошенном пути.

intentName -> (строка)

Имя намерения в конце запрошенного пути.

intentPath -> (строка)

Путь.

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

Общее число сессий, которые следуют по указанному пути к заданному намерению.

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

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

nodeType -> (строка)

Указывает, является ли узел концом пути (Exit ) или нет (Inner ).

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

Spec-Zone.ru

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