Spec-Zone.ru › AWS CLI v2

[ aws . kendra ]

обновить-выделенные-результаты-набора

Описание

Обновляет набор выделенных результатов. Выделенные результаты отображаются выше всех остальных результатов для определенных запросов. Вы сопоставляете конкретные запросы с конкретными документами для их выделения в результатах поиска. Если запрос содержит точное совпадение с запросом, то один или несколько конкретных документов выделяются в результатах поиска.

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

Синтаксис

  update-featured-results-set
--index-id <value>
--featured-results-set-id <value>
[--featured-results-set-name <value>]
[--description <value>]
[--status <value>]
[--query-texts <value>]
[--featured-documents <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 (строка)

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

--featured-results-set-id (строка)

Идентификатор набора выделенных результатов, который вы хотите обновить.

--featured-results-set-name (строка)

Новое имя набора выделенных результатов.

--description (строка)

Новое описание набора выделенных результатов.

--status (строка)

Вы можете установить статус на ACTIVE или INACTIVE. Когда значение равно ACTIVE, выделенные результаты готовы к использованию. Вы по-прежнему можете настроить параметры перед установкой статуса на ACTIVE. Запросы, которые вы указываете для выделенных результатов, должны быть уникальными для каждого набора выделенных результатов для каждого индекса, независимо от того, установлен ли статус на ACTIVE или INACTIVE.

Возможные значения:

  • ACTIVE
  • INACTIVE

--query-texts (список)

Список запросов для выделения результатов. Дополнительную информацию о списке запросов см. в разделе FeaturedResultsSet.

(строка)

Синтаксис:

"string" "string" ...

--featured-documents (список)

Список идентификаторов документов для документов, которые вы хотите выделить в верхней части страницы результатов поиска. Дополнительную информацию о списке выделенных документов см. в разделе FeaturedResultsSet.

(структура)

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

Id -> (строка)

Идентификатор документа, который необходимо выделить в результатах поиска. Вы можете использовать API запросов для поиска определенных документов с включенными в результаты элементами их идентификаторов документов, или вы можете использовать консоль.

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

Id=string ...

Синтаксис JSON:

[
  {
    "Id": "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.

Вывод

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

Информация о наборе выделенных результатов. Это включает идентификатор набора выделенных результатов, активен ли набор выделенных результатов или неактивен, когда набор выделенных результатов был последний раз обновлен и многое другое.

FeaturedResultsSetId -> (строка)

Идентификатор набора выделенных результатов.

FeaturedResultsSetName -> (строка)

Имя набора выделенных результатов.

Description -> (строка)

Описание набора выделенных результатов.

Status -> (строка)

Текущий статус набора выделенных результатов. Когда значение равно ACTIVE, выделенные результаты готовы к использованию. Вы по-прежнему можете настроить параметры перед установкой статуса на ACTIVE. Вы можете установить статус на ACTIVE или INACTIVE с помощью API UpdateFeaturedResultsSet. Запросы, которые вы указываете для выделенных результатов, должны быть уникальными для каждого набора выделенных результатов для каждого индекса, независимо от того, установлен ли статус на ACTIVE или INACTIVE.

QueryTexts -> (список)

Список запросов для выделения результатов.

Конкретные запросы сопоставляются с конкретными документами для их выделения в результатах. Если запрос содержит точное совпадение, то один или несколько конкретных документов выделяются в результатах. Точное совпадение относится к полному запросу. Например, если вы указали только «Kendra», запросы, такие как «Как Kendra семантически ранжирует результаты?», не отобразят выделенные результаты. Выделенные результаты предназначены для конкретных запросов, а не для слишком общих запросов.

(строка)

FeaturedDocuments -> (список)

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

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

Конкретные запросы сопоставляются с конкретными документами для их выделения в результатах. Если запрос содержит точное совпадение, то один или несколько конкретных документов выделяются в результатах. Точное совпадение относится к полному запросу. Например, если вы указали только «Kendra», запросы, такие как «Как Kendra семантически ранжирует результаты?», не отобразят выделенные результаты. Выделенные результаты предназначены для конкретных запросов, а не для слишком общих запросов.

(структура)

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

Id -> (строка)

Идентификатор документа, который необходимо выделить в результатах поиска. Вы можете использовать API запросов для поиска определенных документов с включенными в результаты элементами их идентификаторов документов, или вы можете использовать консоль.

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

Маркер времени Unix, когда набор выделенных результатов был последний раз обновлен.

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

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

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

Spec-Zone.ru

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