-
Notifications
You must be signed in to change notification settings - Fork 260
/
PersonalizerRankResult.xml
85 lines (85 loc) · 4.57 KB
/
PersonalizerRankResult.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
<Type Name="PersonalizerRankResult" FullName="Azure.AI.Personalizer.PersonalizerRankResult">
<TypeSignature Language="C#" Value="public class PersonalizerRankResult" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PersonalizerRankResult extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.AI.Personalizer.PersonalizerRankResult" />
<TypeSignature Language="VB.NET" Value="Public Class PersonalizerRankResult" />
<TypeSignature Language="F#" Value="type PersonalizerRankResult = class" />
<AssemblyInfo>
<AssemblyName>Azure.AI.Personalizer</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary> Returns which action to use as rewardActionId, and additional information about each action as a result of a Rank request. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="EventId">
<MemberSignature Language="C#" Value="public string EventId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string EventId" />
<MemberSignature Language="DocId" Value="P:Azure.AI.Personalizer.PersonalizerRankResult.EventId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property EventId As String" />
<MemberSignature Language="F#" Value="member this.EventId : string" Usage="Azure.AI.Personalizer.PersonalizerRankResult.EventId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Personalizer</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary> The eventId for the round trip from request to response. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Ranking">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyList<Azure.AI.Personalizer.PersonalizerRankedAction> Ranking { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyList`1<class Azure.AI.Personalizer.PersonalizerRankedAction> Ranking" />
<MemberSignature Language="DocId" Value="P:Azure.AI.Personalizer.PersonalizerRankResult.Ranking" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Ranking As IReadOnlyList(Of PersonalizerRankedAction)" />
<MemberSignature Language="F#" Value="member this.Ranking : System.Collections.Generic.IReadOnlyList<Azure.AI.Personalizer.PersonalizerRankedAction>" Usage="Azure.AI.Personalizer.PersonalizerRankResult.Ranking" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Personalizer</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IReadOnlyList<Azure.AI.Personalizer.PersonalizerRankedAction></ReturnType>
</ReturnValue>
<Docs>
<summary> The calculated ranking for the current request. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RewardActionId">
<MemberSignature Language="C#" Value="public string RewardActionId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string RewardActionId" />
<MemberSignature Language="DocId" Value="P:Azure.AI.Personalizer.PersonalizerRankResult.RewardActionId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property RewardActionId As String" />
<MemberSignature Language="F#" Value="member this.RewardActionId : string" Usage="Azure.AI.Personalizer.PersonalizerRankResult.RewardActionId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Personalizer</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The action chosen by the Personalizer service.
This is the action your application should display, and for which to report the reward.
This might not be the first found in 'ranking'.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>