Spec-Zone.ru › AWS CLI v2

[ aws . kendra ]

создание набора рекомендуемых результатов

Описание

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

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

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

Синтаксис

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

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

--description (строка)

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

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

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

--status (строка)

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

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

  • ACTIVE
  • INACTIVE

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

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

(строка)

Синтаксис:

"string" "string" ...

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

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

(структура)

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

Id -> (строка)

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

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

Id=string ...

Синтаксис JSON:

[
  {
    "Id": "string"
  }
  ...
]

--tags (список)

Список пар ключ-значение, которые идентифицируют или категоризируют набор рекомендуемых результатов. Вы также можете использовать теги для управления доступом к набору рекомендуемых результатов. Ключи и значения тегов могут состоять из букв, цифр, пробелов Unicode и любых следующих символов: _ . : / = + - @.

(структура)

Пара ключ-значение, которая идентифицирует или категоризирует индекс, часто задаваемые вопросы, источник данных или другой ресурс. Ключ и значение тега могут состоять из букв, цифр, пробелов Unicode и любых следующих символов: _ . : / = + - @.

Ключ -> (строка)

Ключ тега. Ключи не чувствительны к регистру и должны быть уникальными для индекса, FAQ, источника данных или другого ресурса.

Значение -> (строка)

Значение, связанное с тегом. Значение может быть пустой строкой, но не может быть null.

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

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

Использовать определённый профиль из файла аутентификации.

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--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 (булево)

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

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

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

Вывод

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

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

FeaturedResultsSetId -> (строка)

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

FeaturedResultsSetName -> (строка)

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

Описание -> (строка)

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

Статус -> (строка)

Текущий статус набора рекомендуемых результатов. Когда значение равно 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