обновить-настройки-предложений-по-запросам
Описание
Обновляет настройки предложений по запросам для индекса.
Amazon Kendra поддерживает частичные обновления, поэтому вам нужно указать только поля, которые вы хотите обновить.
Если в настоящее время выполняется обновление, необходимо дождаться завершения обновления перед выполнением другого обновления.
Обновления настроек предложений по запросам могут не вступить в силу сразу. Время, необходимое для вступления обновленных настроек в силу, зависит от произведенных обновлений и количества поисковых запросов в вашем индексе.
Вы по-прежнему можете включать/выключать предложения по запросам в любое время.
UpdateQuerySuggestionsConfig в настоящее время не поддерживается в регионе Amazon Web Services GovCloud (US-West).См. также: документацию по API AWS
Синтаксис
update-query-suggestions-config
--index-id <value>
[--mode <value>]
[--query-log-look-back-window-in-days <value>]
[--include-queries-without-user-information | --no-include-queries-without-user-information]
[--minimum-number-of-querying-users <value>]
[--minimum-query-count <value>]
[--attribute-suggestions-config <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 (строка)
--mode (строка)
Установите режим на ENABLED или LEARN_ONLY .
По умолчанию Amazon Kendra включает предложения по запросам. Режим LEARN_ONLY позволяет отключить предложения по запросам. Вы можете обновить это в любое время.
В режиме LEARN_ONLY Amazon Kendra продолжает учиться на новых запросах, чтобы предложения оставались актуальными, когда вы готовы снова переключиться на режим ВКЛЮЧЕНО.
Возможные значения:
ENABLEDLEARN_ONLY
--query-log-look-back-window-in-days (целое число)
Насколько актуальны ваши запросы в временном окне журнала запросов.
Временное окно — это количество дней от текущей даты до прошедших дней.
По умолчанию Amazon Kendra устанавливает это значение в 180.
--include-queries-without-user-information | --no-include-queries-without-user-information (булево значение)
TRUE, чтобы включить запросы без информации о пользователе (т. е. все запросы, независимо от пользователя), иначе FALSE, чтобы включить только запросы с информацией о пользователе.Если вы передаете Amazon Kendra информацию о пользователе вместе с запросами, вы можете установить этот флаг в FALSE и попросить Amazon Kendra рассматривать только запросы с информацией о пользователе.
Если вы установите FALSE, Amazon Kendra рассматривает только запросы, которые были просмотрены как минимум MinimumQueryCount раз у MinimumNumberOfQueryingUsers уникальных пользователей для предложений.
Если вы установите TRUE, Amazon Kendra игнорирует всю информацию о пользователе и учится на всех запросах.
--minimum-number-of-querying-users (целое число)
Минимальное количество уникальных пользователей, которые должны выполнить поиск по запросу, чтобы этот запрос мог быть предложен вашим пользователям.
Увеличение этого числа может уменьшить количество предложений. Однако это гарантирует, что запрос просматривается многими пользователями и действительно популярен для предложения пользователям.
Как настроить это значение, зависит от ваших конкретных потребностей.
--minimum-query-count (целое число)
Минимальное количество раз, когда запрос должен быть просмотрен, чтобы быть предложен вашим пользователям.
Уменьшение этого числа увеличивает количество предложений. Однако это влияет на качество предложений, так как устанавливает низкий порог для того, чтобы запрос считался популярным для предложения пользователям.
Как настроить это значение, зависит от ваших конкретных потребностей.
--attribute-suggestions-config (структура)
Настройка информации о полях/атрибутах документов, на основе которых вы хотите создавать предложения по запросам.
SuggestableConfigList -> (список)
Список полей/атрибутов, которые вы хотите установить в качестве предлагаемых для предложений по запросам.
(структура)
Предоставляет конфигурационную информацию для поля/атрибута документа, на основе которого вы хотите создавать предложения по запросам.
AttributeName -> (строка)
Suggestable -> (булево значение)
TRUE означает, что поле/атрибут документа предлагается, поэтому содержимое поля может использоваться для предложений по запросам.AttributeSuggestionsMode -> (строка)
ACTIVE или INACTIVE . Вы также должны установить SuggestionTypes как QUERY или DOCUMENT_ATTRIBUTES, а затем вызвать GetQuerySuggestions . Если Mode использовать историю запросов установлен на ENABLED при вызове UpdateQuerySuggestionsConfig и AttributeSuggestionsMode использовать поля/атрибуты установлен на ACTIVE, и вы не установили предпочтение SuggestionTypes до DOCUMENT_ATTRIBUTES, то Amazon Kendra использует историю запросов.Сокращенный синтаксис:
SuggestableConfigList=[{AttributeName=string,Suggestable=boolean},{AttributeName=string,Suggestable=boolean}],AttributeSuggestionsMode=string
Синтаксис JSON:
{
"SuggestableConfigList": [
{
"AttributeName": "string",
"Suggestable": true|false
}
...
],
"AttributeSuggestionsMode": "ACTIVE"|"INACTIVE"
}
--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-auto-prompt (булево значение)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (булево значение)
Отключить автоматическое запросы параметров ввода CLI.
Вывод
Нет
© Copyright 2025, Amazon Web Services. Created using Sphinx.