Spec-Zone.ru › AWS CLI v2

[ aws . personalize ]

describe-recommender

Описание

Описывает данный рекомендатель, включая его состояние.

Рекомендатель может находиться в одном из следующих состояний:

  • ОЖИДАНИЕ СОЗДАНИЯ > ПРОЦЕСС СОЗДАНИЯ > АКТИВЕН -или- СОЗДАНИЕ НЕУДАЛОСЬ
  • ОЖИДАНИЕ ОСТАНОВКИ > ПРОЦЕСС ОСТАНОВКИ > НЕАКТИВЕН > ОЖИДАНИЕ ЗАПУСКА > ПРОЦЕСС ЗАПУСКА > АКТИВЕН
  • ОЖИДАНИЕ УДАЛЕНИЯ > ПРОЦЕСС УДАЛЕНИЯ

Когда status находится в состоянии CREATE FAILED, ответ включает ключ failureReason, который описывает причину.

Ключ modelMetrics имеет значение null, когда рекомендатель создается или удаляется.

Для получения дополнительной информации о рекомендателях, см. CreateRecommender.

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

Синтаксис

  describe-recommender
--recommender-arn <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]

Параметры

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

Amazon Resource Name (ARN) рекомендателя, который нужно описать.

--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 для вывода.

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

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

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

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

Вывод

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

Свойства рекомендателя.

recommenderArn -> (строка)

Amazon Resource Name (ARN) рекомендателя.

datasetGroupArn -> (строка)

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

name -> (строка)

Имя рекомендателя.

recipeArn -> (строка)

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

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

Детали конфигурации рекомендателя.

itemExplorationConfig -> (карта)

Указывает параметры гиперпараметров конфигурации исследования элементов, включая explorationWeight и explorationItemAgeCutOff, которые вы хотите использовать для настройки объема исследования элементов Amazon Personalize при рекомендациях элементов. Предоставляйте данные itemExplorationConfig только в том случае, если ваши рекомендатели генерируют персонализированные рекомендации для пользователя (а не популярные или похожие элементы).

key -> (строка)

value -> (строка)

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

Указывает запрашиваемое минимальное выделенное количество запросов на рекомендации в секунду, которое будет поддерживать Amazon Personalize. Высокое значение minRecommendationRequestsPerSecond увеличит ваш счет. Мы рекомендуем начинать с 1 для minRecommendationRequestsPerSecond (по умолчанию). Отслеживайте использование с помощью метрик Amazon CloudWatch и увеличивайте minRecommendationRequestsPerSecond по мере необходимости.

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

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

excludedDatasetColumns -> (карта)

Указывает столбцы, которые следует исключить из обучения. Каждый ключ — тип набора данных, а каждое значение — список столбцов. Исключайте столбцы, чтобы контролировать данные, которые Amazon Personalize использует для генерации рекомендаций.

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

key -> (строка)

value -> (список)

(строка)

enableMetadataWithRecommendations -> (булево значение)

Включена ли метаданные с рекомендациями для рекомендателя. При включении вы можете указать столбцы из вашего набора данных элементов в запросе рекомендаций. Amazon Personalize возвращает эти данные для каждого элемента в ответе о рекомендациях. Дополнительную информацию об включении метаданных для рекомендателя см. в разделе Включение метаданных в рекомендации для рекомендателя .

Если вы включите метаданные в рекомендациях, вы понесёте дополнительные расходы. Более подробная информация содержится в ценах Amazon Personalize .

creationDateTime -> (метка времени)

Дата и время (в формате Unix) создания рекомендателя.

lastUpdatedDateTime -> (метка времени)

Дата и время (в формате Unix) последнего обновления рекомендателя.

status -> (строка)

Статус рекомендателя.

Рекомендатель может находиться в одном из следующих состояний:

  • ОЖИДАНИЕ СОЗДАНИЯ > ПРОЦЕСС СОЗДАНИЯ > АКТИВЕН -ИЛИ- СОЗДАНИЕ НЕ УСПЕШНО
  • ОЖИДАНИЕ ОСТАНОВКИ > ПРОЦЕСС ОСТАНОВКИ > НЕАКТИВЕН > ОЖИДАНИЕ ЗАПУСКА > ПРОЦЕСС ЗАПУСКА > АКТИВЕН
  • ОЖИДАНИЕ УДАЛЕНИЯ > ПРОЦЕСС УДАЛЕНИЯ

failureReason -> (строка)

При сбое рекомендателя причина сбоя.

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

Предоставляет сводку последних обновлений рекомендателя.

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

Детали конфигурации обновления рекомендателя.

itemExplorationConfig -> (карта)

Указывает параметры гиперпараметров конфигурации исследования элементов, включая explorationWeight и explorationItemAgeCutOff, которые вы хотите использовать для настройки объема исследования элементов Amazon Personalize при рекомендациях элементов. Предоставляйте данные itemExplorationConfig только в том случае, если ваши рекомендатели генерируют персонализированные рекомендации для пользователя (а не популярные или похожие элементы).

key -> (строка)

value -> (строка)

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

Указывает запрашиваемое минимальное выделенное количество запросов на рекомендации в секунду, которое будет поддерживать Amazon Personalize. Высокое значение minRecommendationRequestsPerSecond увеличит ваш счет. Мы рекомендуем начинать с 1 для minRecommendationRequestsPerSecond (по умолчанию). Отслеживайте использование с помощью метрик Amazon CloudWatch и увеличивайте minRecommendationRequestsPerSecond по мере необходимости.

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

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

excludedDatasetColumns -> (карта)

Указывает столбцы, которые следует исключить из обучения. Каждый ключ — тип набора данных, а каждое значение — список столбцов. Исключайте столбцы, чтобы контролировать данные, которые Amazon Personalize использует для генерации рекомендаций.

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

key -> (строка)

value -> (список)

(строка)

enableMetadataWithRecommendations -> (булево значение)

Включена ли метаданные с рекомендациями для рекомендателя. При включении вы можете указать столбцы из вашего набора данных элементов в запросе рекомендаций. Amazon Personalize возвращает эти данные для каждого элемента в ответе о рекомендациях. Дополнительную информацию об включении метаданных для рекомендателя см. в разделе Включение метаданных в рекомендации для рекомендателя .

Если вы включите метаданные в рекомендациях, вы понесёте дополнительные расходы. Более подробная информация содержится в ценах Amazon Personalize .

creationDateTime -> (метка времени)

Дата и время (в формате Unix) создания обновления рекомендателя.

lastUpdatedDateTime -> (метка времени)

Дата и время (в формате Unix) последнего обновления обновления рекомендателя.

status -> (строка)

Статус обновления рекомендателя. Обновление рекомендателя может находиться в одном из следующих состояний:

ОЖИДАНИЕ СОЗДАНИЯ > ПРОЦЕСС СОЗДАНИЯ > АКТИВЕН -ИЛИ- СОЗДАНИЕ НЕ УСПЕШНО

failureReason -> (строка)

При сбое обновления рекомендателя причина сбоя.

modelMetrics -> (карта)

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

key -> (строка)

value -> (двойное значение)

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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