Share via


RankRequest Constructors

Definition

Overloads

RankRequest()

Initializes a new instance of the RankRequest class.

RankRequest(IList<RankableAction>, IList<Object>, IList<String>, String, Nullable<Boolean>)

Initializes a new instance of the RankRequest class.

RankRequest()

Initializes a new instance of the RankRequest class.

public RankRequest ();
Public Sub New ()

Applies to

RankRequest(IList<RankableAction>, IList<Object>, IList<String>, String, Nullable<Boolean>)

Initializes a new instance of the RankRequest class.

public RankRequest (System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Personalizer.Models.RankableAction> actions, System.Collections.Generic.IList<object> contextFeatures = default, System.Collections.Generic.IList<string> excludedActions = default, string eventId = default, bool? deferActivation = default);
new Microsoft.Azure.CognitiveServices.Personalizer.Models.RankRequest : System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Personalizer.Models.RankableAction> * System.Collections.Generic.IList<obj> * System.Collections.Generic.IList<string> * string * Nullable<bool> -> Microsoft.Azure.CognitiveServices.Personalizer.Models.RankRequest
Public Sub New (actions As IList(Of RankableAction), Optional contextFeatures As IList(Of Object) = Nothing, Optional excludedActions As IList(Of String) = Nothing, Optional eventId As String = Nothing, Optional deferActivation As Nullable(Of Boolean) = Nothing)

Parameters

actions
IList<RankableAction>

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.

contextFeatures
IList<Object>

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.

excludedActions
IList<String>

The set of action ids to exclude from ranking.

eventId
String

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.

deferActivation
Nullable<Boolean>

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.

Applies to