Spec-Zone.ru › AWS CLI v2

[ aws . personalize-runtime ]

get-recommendations

Описание

Возвращает список рекомендуемых элементов. Для кампаний требуется Amazon Resource Name (ARN) кампании, а необходимые входные данные для пользователя и элемента зависят от типа рецепта, используемого для создания решения, поддерживающего кампанию, следующим образом:

  • USER_PERSONALIZATION - userId требуется, itemId не используется
  • RELATED_ITEMS - itemId требуется, userId не используется

Примечание

Кампании, которые поддерживаются решением, созданным с помощью рецепта типа PERSONALIZED_RANKING, используют API.

Для рекомендателей требуется ARN рекомендателя, а необходимые входные данные для элемента и пользователя зависят от сценария использования (рецепта на основе домена), поддерживающего рекомендатель. Сведения о требованиях к сценариям использования см. в разделе Выбор сценариев использования рекомендателей.

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

Синтаксис

  get-recommendations
[--campaign-arn <value>]
[--item-id <value>]
[--user-id <value>]
[--num-results <value>]
[--context <value>]
[--filter-arn <value>]
[--filter-values <value>]
[--recommender-arn <value>]
[--promotions <value>]
[--metadata-columns <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]

Параметры

--campaign-arn (строка)

Amazon Resource Name (ARN) кампании для получения рекомендаций.

--item-id (строка)

Идентификатор элемента, для которого необходимо получить рекомендации.

Требуется для RELATED_ITEMS типа рецепта.

--user-id (строка)

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

Требуется для USER_PERSONALIZATION типа рецепта.

--num-results (целое число)

Количество результатов, которые нужно вернуть. По умолчанию 25. Если вы включаете метаданные в рекомендации, максимальное значение 50. В противном случае максимальное значение 500.

--context (массив)

Контекстные метаданные для получения рекомендаций. Контекстные метаданные включают любую информацию об взаимодействии, которая может быть актуальной при получении рекомендаций для пользователя, например, текущее местоположение пользователя или тип устройства.

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

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

Краткая форма синтаксиса:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--filter-arn (строка)

ARN фильтра, который нужно применить к возвращаемым рекомендациям. Дополнительную информацию см. в разделе Фильтрование рекомендаций.

При использовании этого параметра убедитесь, что ресурс фильтра ACTIVE.

--filter-values (массив)

Значения для фильтрации рекомендаций. Для каждого параметра-заполнителя в вашем выражении фильтра укажите имя параметра (с совпадающим регистром) в качестве ключа и значения фильтра в качестве соответствующего значения. Разделяйте несколько значений для одного параметра запятыми.

Для выражений фильтра, использующих элемент INCLUDE для включения элементов, вы должны указать значения для всех определенных в выражении параметров. Для фильтров с выражениями, использующими элемент EXCLUDE для исключения элементов, вы можете опустить filter-values. В этом случае Amazon Personalize не использует эту часть выражения для фильтрации рекомендаций.

Дополнительную информацию см. в разделах Фильтрование рекомендаций и сегментов пользователей.

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

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

Краткая форма синтаксиса:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--recommender-arn (строка)

Amazon Resource Name (ARN) рекомендателя для получения рекомендаций. Укажите ARN рекомендателя, если вы создали группу наборов данных домена с рекомендателем для сценария использования домена.

--promotions (список)

Акции, которые нужно применить к запросу рекомендаций. Акция определяет дополнительные бизнес-правила, которые применяются к настраиваемому подмножеству рекомендуемых элементов.

(структура)

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

имя -> (строка)

Имя акции.

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

Процент рекомендуемых элементов, к которым применяется акция.

filterArn -> (строка)

Amazon Resource Name (ARN) фильтра, используемого акцией. Этот фильтр определяет критерии для продвинутых элементов. Дополнительную информацию см. в разделе Фильтры для акций.

filterValues -> (массив)

Значения, которые нужно использовать при продвижении элементов. Для каждого параметра-заполнителя в выражении фильтра акции укажите имя параметра (с совпадающим регистром) в качестве ключа и значения фильтра в качестве соответствующего значения. Разделяйте несколько значений для одного параметра запятыми.

Для выражений фильтра, использующих элемент INCLUDE для включения элементов, вы должны указать значения для всех определенных в выражении параметров. Для фильтров с выражениями, использующими элемент EXCLUDE для исключения элементов, вы можете опустить filter-values. В этом случае Amazon Personalize не использует эту часть выражения для фильтрации рекомендаций.

Дополнительную информацию о создании фильтров см. в разделах Фильтрование рекомендаций и сегментов пользователей.

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

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

Краткая форма синтаксиса:

name=string,percentPromotedItems=integer,filterArn=string,filterValues={KeyName1=string,KeyName2=string} ...

Синтаксис JSON:

[
  {
    "name": "string",
    "percentPromotedItems": integer,
    "filterArn": "string",
    "filterValues": {"string": "string"
      ...}
  }
  ...
]

--metadata-columns (массив)

Если вы включили метаданные в рекомендации при создании или обновлении кампании или рекомендателя, укажите столбцы метаданных из набора данных элементов, которые нужно включить в рекомендации для элементов. Ключом массива является ITEMS, а значением — список имен столбцов из набора данных элементов. Максимальное количество столбцов, которое вы можете указать, равно 10.

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

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

значение -> (список)

(строка)

Краткая форма синтаксиса:

KeyName1=string,string,KeyName2=string,string

Синтаксис JSON:

{"string": ["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
  • таблица
  • yaml
  • yaml-stream

--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.

--cli-auto-prompt (логическое значение)

Автоматически запросить параметры входных данных cli.

--no-cli-auto-prompt (логическое значение)

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

Вывод

itemList -> (список)

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

(структура)

Объект, определяющий элемент.

API возвращают список PredictedItem.

itemId -> (строка)

Идентификатор рекомендуемого элемента.

score -> (двойное)

Числовое представление уверенности модели в том, что элемент будет следующим выбором пользователя. Более подробную информацию о логике оценки см. в разделе как-оцениваются-результаты.

promotionName -> (строка)

Название акции, включающей предсказанный элемент.

metadata -> (карта)

Метаданные об элементе из набора данных Items.

key -> (строка)

value -> (строка)

reason -> (список)

Если вы используете User-Personalization-v2, список причин, по которым элемент включён в рекомендации. Возможные причины:

  • Рекламируемый элемент - Указание на то, что элемент включён в рамках акции, которую вы применили в запросе на рекомендации.
  • Исследование - Указание на то, что элемент включён в рамках исследования. При исследовании рекомендации включают элементы с меньшим объёмом данных взаимодействия или релевантности для пользователя. Более подробную информацию об исследовании см. в разделе Исследование.
  • Популярный элемент - Указание на то, что элемент включён как популярный элемент-заполнитель. Если вы используете фильтр, в зависимости от того, сколько рекомендаций удаляет фильтр, Amazon Personalize может добавить элементы-заполнители для удовлетворения требований к вашему запросу на рекомендации. Эти элементы являются популярными элементами, основанными на данных взаимодействий, которые удовлетворяют вашим критериям фильтрации. У них нет оценки релевантности для пользователя.

(строка)

recommendationId -> (строка)

Идентификатор рекомендации.

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

Spec-Zone.ru

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