-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
Copy pathEvaluationMetric.xml
225 lines (225 loc) · 14.8 KB
/
EvaluationMetric.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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
<Type Name="EvaluationMetric" FullName="Microsoft.Extensions.AI.Evaluation.EvaluationMetric">
<TypeSignature Language="C#" Value="public class EvaluationMetric" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit EvaluationMetric extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.AI.Evaluation.EvaluationMetric" />
<TypeSignature Language="VB.NET" Value="Public Class EvaluationMetric" />
<TypeSignature Language="F#" Value="type EvaluationMetric = class" />
<TypeSignature Language="C++ CLI" Value="public ref class EvaluationMetric" />
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI.Evaluation</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.3.0.0</AssemblyVersion>
<AssemblyVersion>9.4.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Evaluation.NumericMetric), "numeric")]</AttributeName>
<AttributeName Language="F#">[<System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Evaluation.NumericMetric), "numeric")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Evaluation.BooleanMetric), "boolean")]</AttributeName>
<AttributeName Language="F#">[<System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Evaluation.BooleanMetric), "boolean")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Evaluation.StringMetric), "string")]</AttributeName>
<AttributeName Language="F#">[<System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Evaluation.StringMetric), "string")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Evaluation.EvaluationMetric), "none")]</AttributeName>
<AttributeName Language="F#">[<System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Evaluation.EvaluationMetric), "none")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<param name="name">The name of the <see cref="T:Microsoft.Extensions.AI.Evaluation.EvaluationMetric" />.</param>
<param name="reason">
An optional string that can be used to provide some commentary around the result represented by this
<see cref="T:Microsoft.Extensions.AI.Evaluation.EvaluationMetric" />.
</param>
<summary>
A base class that represents the result of an evaluation.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EvaluationMetric (string name, string? reason = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name, string reason) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AI.Evaluation.EvaluationMetric.#ctor(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (name As String, Optional reason As String = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Extensions.AI.Evaluation.EvaluationMetric : string * string -> Microsoft.Extensions.AI.Evaluation.EvaluationMetric" Usage="new Microsoft.Extensions.AI.Evaluation.EvaluationMetric (name, reason)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI.Evaluation</AssemblyName>
<AssemblyVersion>9.4.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="reason" Type="System.String">
<Attributes>
<Attribute FrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="name">The name of the <see cref="T:Microsoft.Extensions.AI.Evaluation.EvaluationMetric" />.</param>
<param name="reason">
An optional string that can be used to provide some commentary around the result represented by this
<see cref="T:Microsoft.Extensions.AI.Evaluation.EvaluationMetric" />.
</param>
<summary>
A base class that represents the result of an evaluation.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Diagnostics">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Extensions.AI.Evaluation.EvaluationDiagnostic>? Diagnostics { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Microsoft.Extensions.AI.Evaluation.EvaluationDiagnostic> Diagnostics" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.AI.Evaluation.EvaluationMetric.Diagnostics" />
<MemberSignature Language="VB.NET" Value="Public Property Diagnostics As IList(Of EvaluationDiagnostic)" />
<MemberSignature Language="F#" Value="member this.Diagnostics : System.Collections.Generic.IList<Microsoft.Extensions.AI.Evaluation.EvaluationDiagnostic> with get, set" Usage="Microsoft.Extensions.AI.Evaluation.EvaluationMetric.Diagnostics" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Collections::Generic::IList<Microsoft::Extensions::AI::Evaluation::EvaluationDiagnostic ^> ^ Diagnostics { System::Collections::Generic::IList<Microsoft::Extensions::AI::Evaluation::EvaluationDiagnostic ^> ^ get(); void set(System::Collections::Generic::IList<Microsoft::Extensions::AI::Evaluation::EvaluationDiagnostic ^> ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI.Evaluation</AssemblyName>
<AssemblyVersion>9.4.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Microsoft.Extensions.AI.Evaluation.EvaluationDiagnostic></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a collection of zero or more <see cref="T:Microsoft.Extensions.AI.Evaluation.EvaluationDiagnostic" />s associated with the current
<see cref="T:Microsoft.Extensions.AI.Evaluation.EvaluationMetric" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Interpretation">
<MemberSignature Language="C#" Value="public Microsoft.Extensions.AI.Evaluation.EvaluationMetricInterpretation? Interpretation { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Extensions.AI.Evaluation.EvaluationMetricInterpretation Interpretation" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.AI.Evaluation.EvaluationMetric.Interpretation" />
<MemberSignature Language="VB.NET" Value="Public Property Interpretation As EvaluationMetricInterpretation" />
<MemberSignature Language="F#" Value="member this.Interpretation : Microsoft.Extensions.AI.Evaluation.EvaluationMetricInterpretation with get, set" Usage="Microsoft.Extensions.AI.Evaluation.EvaluationMetric.Interpretation" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Extensions::AI::Evaluation::EvaluationMetricInterpretation ^ Interpretation { Microsoft::Extensions::AI::Evaluation::EvaluationMetricInterpretation ^ get(); void set(Microsoft::Extensions::AI::Evaluation::EvaluationMetricInterpretation ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI.Evaluation</AssemblyName>
<AssemblyVersion>9.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Extensions.AI.Evaluation.EvaluationMetricInterpretation</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets an <see cref="T:Microsoft.Extensions.AI.Evaluation.EvaluationMetricInterpretation" /> that identifies whether the result of the
evaluation represented by the current <see cref="T:Microsoft.Extensions.AI.Evaluation.EvaluationMetric" /> is considered good or bad, passed or
failed etc.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Metadata">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IDictionary<string,string>? Metadata { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IDictionary`2<string, string> Metadata" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.AI.Evaluation.EvaluationMetric.Metadata" />
<MemberSignature Language="VB.NET" Value="Public Property Metadata As IDictionary(Of String, String)" />
<MemberSignature Language="F#" Value="member this.Metadata : System.Collections.Generic.IDictionary<string, string> with get, set" Usage="Microsoft.Extensions.AI.Evaluation.EvaluationMetric.Metadata" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Collections::Generic::IDictionary<System::String ^, System::String ^> ^ Metadata { System::Collections::Generic::IDictionary<System::String ^, System::String ^> ^ get(); void set(System::Collections::Generic::IDictionary<System::String ^, System::String ^> ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI.Evaluation</AssemblyName>
<AssemblyVersion>9.4.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1, 1 })]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1, 1 })>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IDictionary<System.String,System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a collection of zero or more string metadata associated with the current
<see cref="T:Microsoft.Extensions.AI.Evaluation.EvaluationMetric" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.AI.Evaluation.EvaluationMetric.Name" />
<MemberSignature Language="VB.NET" Value="Public Property Name As String" />
<MemberSignature Language="F#" Value="member this.Name : string with get, set" Usage="Microsoft.Extensions.AI.Evaluation.EvaluationMetric.Name" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Name { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI.Evaluation</AssemblyName>
<AssemblyVersion>9.4.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(1)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the name of the <see cref="T:Microsoft.Extensions.AI.Evaluation.EvaluationMetric" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Reason">
<MemberSignature Language="C#" Value="public string? Reason { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Reason" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.AI.Evaluation.EvaluationMetric.Reason" />
<MemberSignature Language="VB.NET" Value="Public Property Reason As String" />
<MemberSignature Language="F#" Value="member this.Reason : string with get, set" Usage="Microsoft.Extensions.AI.Evaluation.EvaluationMetric.Reason" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Reason { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI.Evaluation</AssemblyName>
<AssemblyVersion>9.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a string that can optionally be used to provide some commentary around the result represented by
this <see cref="T:Microsoft.Extensions.AI.Evaluation.EvaluationMetric" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>