RankRequest Класс
Запрос набора действий для ранжирования службой Персонализатора.
Все необходимые параметры должны быть заполнены для отправки в Azure.
- Наследование
-
RankRequest
Конструктор
RankRequest(*, actions, context_features=None, excluded_actions=None, event_id: str = None, defer_activation: bool = False, **kwargs)
Параметры
Функции контекста, используемые Для Персонализатора в качестве словаря словарей. Это зависит от приложения и обычно включает функции о текущем пользователе, его устройстве, сведения о профиле, данные о времени и дате и т. д.
- actions
- list[RankableAction]
Обязательный. Набор действий, из которых может выбрать служба Персонализатора. Набор не должен содержать более 50 действий. Порядок действий не влияет на результат ранжирования, но он должен соответствовать последовательности, которую приложение использовало для их отображения.
- event_id
- str
При необходимости передайте eventId, который однозначно идентифицирует это событие ранжирования. Если значение равно null, служба создает уникальный eventId. EventId будет использоваться для связывания этого запроса с его вознаграждением, а также для заполнения генератора псевдослучайных при вызове Персонализатора.
- defer_activation
- bool
Отправьте значение false, если пользователь увидит результаты ранжирования, поэтому Персонализатор будет ожидать вызова Reward, в противном случае он назначит награду по умолчанию для события. Отправьте значение true, если это возможно, пользователь не увидит результаты ранжирования, так как страница будет отображаться позже, или результаты ранжирования могут быть переопределены нижестоящим кодом. Значение по умолчанию: False.
Методы
as_dict |
Возвращает диктовку, которая может иметь значение JSONify с помощью json.dump. При дополнительном использовании можно использовать обратный вызов в качестве параметра: Ключ — это имя атрибута, используемого в Python. Attr_desc — это диктовка метаданных. В настоящее время содержит тип с типом msrest и key с ключом в кодировке RestAPI. Значение — это текущее значение в этом объекте. Возвращаемая строка будет использоваться для сериализации ключа. Если тип возвращаемого значения является списком, это считается иерархическим результирующим диктом. См. три примера в этом файле:
Если требуется сериализация XML, можно передать kwargs is_xml=True. |
deserialize |
Выполните синтаксический анализ str с помощью синтаксиса RestAPI и верните модель. |
enable_additional_properties_sending | |
from_dict |
Синтаксический анализ диктовки с помощью заданного средства извлечения ключей возвращает модель. По умолчанию рекомендуется использовать средства извлечения ключей (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor и last_rest_key_case_insensitive_extractor). |
is_xml_model | |
serialize |
Возвращает json, который будет отправлен в Azure из этой модели. Это псевдоним для as_dict(full_restapi_key_transformer, keep_readonly=False). Если требуется сериализация XML, можно передать kwargs is_xml=True. |
validate |
Рекурсивная проверка модели и возврат списка ValidationError. |
as_dict
Возвращает диктовку, которая может иметь значение JSONify с помощью json.dump.
При дополнительном использовании можно использовать обратный вызов в качестве параметра:
Ключ — это имя атрибута, используемого в Python. Attr_desc — это диктовка метаданных. В настоящее время содержит тип с типом msrest и key с ключом в кодировке RestAPI. Значение — это текущее значение в этом объекте.
Возвращаемая строка будет использоваться для сериализации ключа. Если тип возвращаемого значения является списком, это считается иерархическим результирующим диктом.
См. три примера в этом файле:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
Если требуется сериализация XML, можно передать kwargs is_xml=True.
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)
Параметры
- key_transformer
- <xref:function>
Функция преобразователя ключей.
- keep_readonly
Возвращаемое значение
Объект, совместимый с JSON для диктовки
Возвращаемый тип
deserialize
Выполните синтаксический анализ str с помощью синтаксиса RestAPI и верните модель.
deserialize(data, content_type=None)
Параметры
- content_type
- str
JSON по умолчанию задайте значение application/xml, если XML.
Возвращаемое значение
Экземпляр этой модели
Исключения
enable_additional_properties_sending
enable_additional_properties_sending()
from_dict
Синтаксический анализ диктовки с помощью заданного средства извлечения ключей возвращает модель.
По умолчанию рекомендуется использовать средства извлечения ключей (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor и last_rest_key_case_insensitive_extractor).
from_dict(data, key_extractors=None, content_type=None)
Параметры
- content_type
- str
JSON по умолчанию задайте значение application/xml, если XML.
- key_extractors
Возвращаемое значение
Экземпляр этой модели
Исключения
is_xml_model
is_xml_model()
serialize
Возвращает json, который будет отправлен в Azure из этой модели.
Это псевдоним для as_dict(full_restapi_key_transformer, keep_readonly=False).
Если требуется сериализация XML, можно передать kwargs is_xml=True.
serialize(keep_readonly=False, **kwargs)
Параметры
- keep_readonly
- bool
Если вы хотите сериализовать атрибуты только для чтения
Возвращаемое значение
Объект, совместимый с JSON для диктовки
Возвращаемый тип
validate
Рекурсивная проверка модели и возврат списка ValidationError.
validate()
Возвращаемое значение
Список ошибок проверки
Возвращаемый тип
Azure SDK for Python
Обратная связь
https://aka.ms/ContentUserFeedback.
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделеОтправить и просмотреть отзыв по