PersonalizerClient.Rank Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| Rank(PersonalizerRankOptions, CancellationToken) |
Submit a Personalizer rank request. Receives a context and a list of actions. Returns which of the provided actions should be used by your application, in rewardActionId. |
| Rank(IEnumerable<PersonalizerRankableAction>, IEnumerable<Object>, CancellationToken) |
Submit a Personalizer rank request. Receives a context and a list of actions. Returns which of the provided actions should be used by your application, in rewardActionId. |
Rank(PersonalizerRankOptions, CancellationToken)
- Source:
- PersonalizerClient.cs
Submit a Personalizer rank request. Receives a context and a list of actions. Returns which of the provided actions should be used by your application, in rewardActionId.
public virtual Azure.Response<Azure.AI.Personalizer.PersonalizerRankResult> Rank (Azure.AI.Personalizer.PersonalizerRankOptions options, System.Threading.CancellationToken cancellationToken = default);abstract member Rank : Azure.AI.Personalizer.PersonalizerRankOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Personalizer.PersonalizerRankResult>
override this.Rank : Azure.AI.Personalizer.PersonalizerRankOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Personalizer.PersonalizerRankResult>Public Overridable Function Rank (options As PersonalizerRankOptions, Optional cancellationToken As CancellationToken = Nothing) As Response(Of PersonalizerRankResult)Parameters
- options
- PersonalizerRankOptions
A Personalizer Rank request.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Applies to
Rank(IEnumerable<PersonalizerRankableAction>, IEnumerable<Object>, CancellationToken)
- Source:
- PersonalizerClient.cs
Submit a Personalizer rank request. Receives a context and a list of actions. Returns which of the provided actions should be used by your application, in rewardActionId.
public virtual Azure.Response<Azure.AI.Personalizer.PersonalizerRankResult> Rank (System.Collections.Generic.IEnumerable<Azure.AI.Personalizer.PersonalizerRankableAction> actions, System.Collections.Generic.IEnumerable<object> contextFeatures, System.Threading.CancellationToken cancellationToken = default);abstract member Rank : seq<Azure.AI.Personalizer.PersonalizerRankableAction> * seq<obj> * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Personalizer.PersonalizerRankResult>
override this.Rank : seq<Azure.AI.Personalizer.PersonalizerRankableAction> * seq<obj> * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Personalizer.PersonalizerRankResult>Public Overridable Function Rank (actions As IEnumerable(Of PersonalizerRankableAction), contextFeatures As IEnumerable(Of Object), Optional cancellationToken As CancellationToken = Nothing) As Response(Of PersonalizerRankResult)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.
- contextFeatures
- IEnumerable<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.
