describe-query-suggestions-config
Описание
Получает информацию о настройках подсказок запросов для индекса.
Это используется для проверки текущих настроек, примененных к подсказкам запросов.
DescribeQuerySuggestionsConfig в настоящее время не поддерживается в регионе Amazon Web Services GovCloud (US-West).См. также: Документация API AWS
Синтаксис
describe-query-suggestions-config
--index-id <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]
Параметры
--index-id (строка)
--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 версии 1, а двоичные значения должны передаваться буквально. При предоставлении содержимого файла, сопоставляющегося с двоичным блоком, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настроек cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (логическое значение)
Отключить пейджер CLI для вывода.
--cli-auto-prompt (логическое значение)
Автоматически запросить параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запрос параметров ввода CLI.
Вывод
Режим -> (строка)
Указывается, находится ли в данный момент режим подсказок запросов в режиме ENABLED или режиме LEARN_ONLY.
По умолчанию Amazon Kendra включает подсказки запросов. ``LEARN_ONLY`` отключает подсказки запросов для ваших пользователей. Вы можете изменить режим с помощью API UpdateQuerySuggestionsConfig.
Статус -> (строка)
Указывает, находится ли в данный момент статус настроек подсказок запросов в режиме ACTIVE или UPDATING.
Активный означает, что текущие настройки применяются, а Обновление означает, что ваши измененные настройки в процессе применения.
QueryLogLookBackWindowInDays -> (целое число)
IncludeQueriesWithoutUserInformation -> (логическое значение)
TRUE для использования всех запросов, в противном случае использовать только запросы, содержащие информацию о пользователе, для генерации подсказок запросов.MinimumNumberOfQueryingUsers -> (целое число)
MinimumQueryCount -> (целое число)
LastSuggestionsBuildTime -> (метка времени)
Unix-метка времени, когда подсказки запросов для индекса были последний раз обновлены.
Amazon Kendra автоматически обновляет подсказки каждые 24 часа после изменения настройки или после применения списка блокировок.
LastClearTime -> (метка времени)
Unix-метка времени, когда подсказки запросов для индекса были последний раз очищены.
После очистки подсказок Amazon Kendra изучает новые подсказки на основе новых запросов, добавленных в журнал запросов с момента очистки подсказок. Amazon Kendra рассматривает только повторные появления запроса с момента очистки подсказок.
TotalSuggestionsCount -> (целое число)
Текущее общее количество подсказок запросов для индекса.
Это число может измениться при обновлении настроек подсказок запросов, если вы отфильтруете определенные запросы из подсказок с помощью списка блокировок и по мере накопления в журнале запросов дополнительных запросов, на основе которых Amazon Kendra может изучать.
Если количество значительно меньше ожидаемого, это может быть связано с тем, что Amazon Kendra нуждается в большем количестве запросов в истории запросов для изучения или ваши текущие настройки подсказок запросов слишком строгие.
AttributeSuggestionsConfig -> (структура)
Настройки для полей/атрибутов документов, на основе которых вы хотите создавать подсказки запросов.
SuggestableConfigList -> (список)
Список полей/атрибутов, которые вы хотите установить как подсказываемые для подсказок запросов.
(структура)
Предоставляет информацию о настройках поля/атрибута документа, на основе которого вы хотите создавать подсказки запросов.
AttributeName -> (строка)
Suggestable -> (логическое значение)
TRUE означает, что поле/атрибут документа подсказываемый, так что содержимое поля может использоваться для подсказок запросов.AttributeSuggestionsMode -> (строка)
ACTIVE, либо на INACTIVE. Если Mode для истории запросов установлен на ENABLED при вызове UpdateQuerySuggestionsConfig и AttributeSuggestionsMode для использования полей/атрибутов установлен на ACTIVE, и вы не установили свой параметр SuggestionTypes на DOCUMENT_ATTRIBUTES, то Amazon Kendra использует историю запросов.
© Copyright 2025, Amazon Web Services. Created using Sphinx.