PersonalizerRankMultiSlotOptions Constructors

Definition

Namespace:

Azure.AI.Personalizer

Assembly:

Azure.AI.Personalizer.dll

Package:

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

Overloads

PersonalizerRankMultiSlotOptions()	Initializes a new instance of the MultiSlotRankRequest class.
PersonalizerRankMultiSlotOptions(IEnumerable<PersonalizerRankableAction>, IEnumerable<PersonalizerSlotOptions>)	Initializes a new instance of PersonalizerRankMultiSlotOptions.
PersonalizerRankMultiSlotOptions(IEnumerable<PersonalizerRankableAction>, IEnumerable<PersonalizerSlotOptions>, IList<Object>, String, Boolean)	Initializes a new instance of MultiSlotRankRequest.

PersonalizerRankMultiSlotOptions()

Source:

PersonalizerRankMultiSlotOptions.cs

Initializes a new instance of the MultiSlotRankRequest class.

public PersonalizerRankMultiSlotOptions ();

Public Sub New ()

PersonalizerRankMultiSlotOptions(IEnumerable<PersonalizerRankableAction>, IEnumerable<PersonalizerSlotOptions>)

Source:

PersonalizerRankMultiSlotOptions.cs

Initializes a new instance of PersonalizerRankMultiSlotOptions.

public PersonalizerRankMultiSlotOptions (System.Collections.Generic.IEnumerable<Azure.AI.Personalizer.PersonalizerRankableAction> actions, System.Collections.Generic.IEnumerable<Azure.AI.Personalizer.PersonalizerSlotOptions> slots);

new Azure.AI.Personalizer.PersonalizerRankMultiSlotOptions : seq<Azure.AI.Personalizer.PersonalizerRankableAction> * seq<Azure.AI.Personalizer.PersonalizerSlotOptions> -> Azure.AI.Personalizer.PersonalizerRankMultiSlotOptions

Public Sub New (actions As IEnumerable(Of PersonalizerRankableAction), slots As IEnumerable(Of PersonalizerSlotOptions))

Parameters

actions

IEnumerable<PersonalizerRankableAction>

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.

slots

IEnumerable<PersonalizerSlotOptions>

The set of slots the Personalizer service should select actions for. The set should not contain more than 50 slots.

Exceptions

ArgumentNullException

actions or slots is null.

PersonalizerRankMultiSlotOptions(IEnumerable<PersonalizerRankableAction>, IEnumerable<PersonalizerSlotOptions>, IList<Object>, String, Boolean)

Source:

PersonalizerRankMultiSlotOptions.cs

Initializes a new instance of MultiSlotRankRequest.

public PersonalizerRankMultiSlotOptions (System.Collections.Generic.IEnumerable<Azure.AI.Personalizer.PersonalizerRankableAction> actions, System.Collections.Generic.IEnumerable<Azure.AI.Personalizer.PersonalizerSlotOptions> slots, System.Collections.Generic.IList<object> contextFeatures = default, string eventId = default, bool deferActivation = false);

new Azure.AI.Personalizer.PersonalizerRankMultiSlotOptions : seq<Azure.AI.Personalizer.PersonalizerRankableAction> * seq<Azure.AI.Personalizer.PersonalizerSlotOptions> * System.Collections.Generic.IList<obj> * string * bool -> Azure.AI.Personalizer.PersonalizerRankMultiSlotOptions

Public Sub New (actions As IEnumerable(Of PersonalizerRankableAction), slots As IEnumerable(Of PersonalizerSlotOptions), Optional contextFeatures As IList(Of Object) = Nothing, Optional eventId As String = Nothing, Optional deferActivation As Boolean = false)

Parameters

actions

IEnumerable<PersonalizerRankableAction>

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.

slots

IEnumerable<PersonalizerSlotOptions>

The set of slots the Personalizer service should select actions for.

The set should not contain more than 50 slots.

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, 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.

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

Boolean

Optionally pass an eventId that uniquely 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.

Exceptions

ArgumentNullException

actions or slots is null.