PersonalizerClient.RankMultiSlotAsync Method

Definition

Overloads

RankMultiSlotAsync(PersonalizerRankMultiSlotOptions, CancellationToken)

Submit a Personalizer multi-slot rank request. Receives a context, a list of actions, and a list of slots. Returns which of the provided actions should be used in each slot, in each rewardActionId.

RankMultiSlotAsync(IEnumerable<PersonalizerRankableAction>, IEnumerable<PersonalizerSlotOptions>, IList<Object>, CancellationToken)

Submit a Personalizer multi-slot rank request. Receives a context, a list of actions, and a list of slots. Returns which of the provided actions should be used in each slot, in each rewardActionId.

RankMultiSlotAsync(PersonalizerRankMultiSlotOptions, CancellationToken)

Source:
PersonalizerClient.cs

Submit a Personalizer multi-slot rank request. Receives a context, a list of actions, and a list of slots. Returns which of the provided actions should be used in each slot, in each rewardActionId.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Personalizer.PersonalizerMultiSlotRankResult>> RankMultiSlotAsync (Azure.AI.Personalizer.PersonalizerRankMultiSlotOptions options, System.Threading.CancellationToken cancellationToken = default);
abstract member RankMultiSlotAsync : Azure.AI.Personalizer.PersonalizerRankMultiSlotOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Personalizer.PersonalizerMultiSlotRankResult>>
override this.RankMultiSlotAsync : Azure.AI.Personalizer.PersonalizerRankMultiSlotOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Personalizer.PersonalizerMultiSlotRankResult>>
Public Overridable Function RankMultiSlotAsync (options As PersonalizerRankMultiSlotOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of PersonalizerMultiSlotRankResult))

Parameters

options
PersonalizerRankMultiSlotOptions

A Personalizer multi-slot Rank request.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Applies to

RankMultiSlotAsync(IEnumerable<PersonalizerRankableAction>, IEnumerable<PersonalizerSlotOptions>, IList<Object>, CancellationToken)

Source:
PersonalizerClient.cs

Submit a Personalizer multi-slot rank request. Receives a context, a list of actions, and a list of slots. Returns which of the provided actions should be used in each slot, in each rewardActionId.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Personalizer.PersonalizerMultiSlotRankResult>> RankMultiSlotAsync (System.Collections.Generic.IEnumerable<Azure.AI.Personalizer.PersonalizerRankableAction> actions, System.Collections.Generic.IEnumerable<Azure.AI.Personalizer.PersonalizerSlotOptions> slots, System.Collections.Generic.IList<object> contextFeatures, System.Threading.CancellationToken cancellationToken = default);
abstract member RankMultiSlotAsync : seq<Azure.AI.Personalizer.PersonalizerRankableAction> * seq<Azure.AI.Personalizer.PersonalizerSlotOptions> * System.Collections.Generic.IList<obj> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Personalizer.PersonalizerMultiSlotRankResult>>
override this.RankMultiSlotAsync : seq<Azure.AI.Personalizer.PersonalizerRankableAction> * seq<Azure.AI.Personalizer.PersonalizerSlotOptions> * System.Collections.Generic.IList<obj> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Personalizer.PersonalizerMultiSlotRankResult>>
Public Overridable Function RankMultiSlotAsync (actions As IEnumerable(Of PersonalizerRankableAction), slots As IEnumerable(Of PersonalizerSlotOptions), contextFeatures As IList(Of Object), Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of PersonalizerMultiSlotRankResult))

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.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Applies to