PersonalizerRankOptions Class

Definition

Namespace:

Azure.AI.Personalizer

Assembly:

Azure.AI.Personalizer.dll

Package:

Azure.AI.Personalizer v2.0.0-beta.2

Source:

PersonalizerRankOptions.cs

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

public class PersonalizerRankOptions

type PersonalizerRankOptions = class

Public Class PersonalizerRankOptions

Inheritance

Object

PersonalizerRankOptions

Constructors

PersonalizerRankOptions()	Initializes a new instance of the RankRequest class.
PersonalizerRankOptions(IEnumerable<PersonalizerRankableAction>)	Initializes a new instance of PersonalizerRankOptions.
PersonalizerRankOptions(IEnumerable<PersonalizerRankableAction>, IEnumerable<Object>, IEnumerable<String>, String, Nullable<Boolean>)	Initializes a new instance of the RankRequest class.

Properties

Actions	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. The first item in the array will be used as Baseline item in Offline Evaluations.
ContextFeatures	Features of the context used for Personalizer as a dictionary of dictionaries. This is determined by your application, and typically includes features about the current user, their device, profile information, aggregated data about time and date, etc. Features should not include personally identifiable information (PII), unique UserIDs, or precise timestamps. Need to be JSON serializable. https://docs.microsoft.com/azure/cognitive-services/personalizer/concepts-features.
DeferActivation	Send false if it is certain the rewardActionId in rank results will be shown to the user, 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 action specified in the rank results, (e.g. because the page is rendering later, or the Rank results may be overridden by code further downstream). You must call the Activate Event API if the event output is shown to users, otherwise Rewards will be ignored.
EventId	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.
ExcludedActions	The set of action ids to exclude from ranking. Personalizer will consider the first non-excluded item in the array as the Baseline action when performing Offline Evaluations.