RankRequest Class

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Request a set of actions to be ranked by the Personalizer service.

All required parameters must be populated in order to send to Azure.

Inheritance

Model

RankRequest

Constructor

RankRequest(*, actions, context_features=None, excluded_actions=None, event_id: Optional[str] = None, defer_activation: bool = False, **kwargs)

Parameters

context_features

list[object]

Required

Features of the context used for Personalizer as a dictionary of dictionaries. This depends on the application, and typically includes features about the current user, their device, profile information, data about time and date, etc.

actions

list[RankableAction]

Required

Required. The set of actions the Personalizer service can pick from. The set should not contain more than 50 actions. The order of the actions does not affect the rank result but the order should match the sequence your application would have used to display them.

excluded_actions

list[str]

Required

The set of action ids to exclude from ranking.

event_id

str

Required

Optionally pass an eventId that uniquely identifies this Rank event. If null, the service generates a unique eventId. The eventId will be used for associating this request with its reward, as well as seeding the pseudo-random generator when making a Personalizer call.

defer_activation

bool

Required

Send false if the user will see the rank results, therefore Personalizer will expect a Reward call, otherwise it will assign the default Reward to the event. Send true if it is possible the user will not see the rank results, because the page is rendering later, or the Rank results may be overridden by code further downstream. Default value: False .