-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Expand file tree
/
Copy pathF1EvaluatorContext.xml
More file actions
117 lines (117 loc) · 7.14 KB
/
Copy pathF1EvaluatorContext.xml
File metadata and controls
117 lines (117 loc) · 7.14 KB
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
<Type Name="F1EvaluatorContext" FullName="Microsoft.Extensions.AI.Evaluation.NLP.F1EvaluatorContext">
<TypeSignature Language="C#" Value="public sealed class F1EvaluatorContext : Microsoft.Extensions.AI.Evaluation.EvaluationContext" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit F1EvaluatorContext extends Microsoft.Extensions.AI.Evaluation.EvaluationContext" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.AI.Evaluation.NLP.F1EvaluatorContext" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class F1EvaluatorContext
Inherits EvaluationContext" />
<TypeSignature Language="F#" Value="type F1EvaluatorContext = class
 inherit EvaluationContext" />
<TypeSignature Language="C++ CLI" Value="public ref class F1EvaluatorContext sealed : Microsoft::Extensions::AI::Evaluation::EvaluationContext" />
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI.Evaluation.NLP</AssemblyName>
<AssemblyVersion>9.7.0.0</AssemblyVersion>
<AssemblyVersion>9.9.0.0</AssemblyVersion>
<AssemblyVersion>9.10.0.0</AssemblyVersion>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
<AssemblyVersion>10.2.0.0</AssemblyVersion>
<AssemblyVersion>10.3.0.0</AssemblyVersion>
<AssemblyVersion>10.4.0.0</AssemblyVersion>
<AssemblyVersion>10.6.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Extensions.AI.Evaluation.EvaluationContext</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="net-10.0-pp;net-11.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>
</Attributes>
<Docs>
<summary>
Contextual information that the <see cref="T:Microsoft.Extensions.AI.Evaluation.NLP.F1Evaluator" /> uses to compute the F1 score for a response.
</summary>
<remarks>
<see cref="T:Microsoft.Extensions.AI.Evaluation.NLP.F1Evaluator" /> measures the F1 score of a response compared to a reference response that is supplied via
<see cref="P:Microsoft.Extensions.AI.Evaluation.NLP.F1EvaluatorContext.GroundTruth" />. F1 is a metric used to valuate the quality of machine-generated text. It is the ratio
of the number of shared words between the generated response and the reference response.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public F1EvaluatorContext (string groundTruth);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string groundTruth) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AI.Evaluation.NLP.F1EvaluatorContext.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (groundTruth As String)" />
<MemberSignature Language="F#" Value="new Microsoft.Extensions.AI.Evaluation.NLP.F1EvaluatorContext : string -> Microsoft.Extensions.AI.Evaluation.NLP.F1EvaluatorContext" Usage="new Microsoft.Extensions.AI.Evaluation.NLP.F1EvaluatorContext groundTruth" />
<MemberSignature Language="C++ CLI" Value="public:
 F1EvaluatorContext(System::String ^ groundTruth);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI.Evaluation.NLP</AssemblyName>
<AssemblyVersion>10.6.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="groundTruth" Type="System.String" />
</Parameters>
<Docs>
<param name="groundTruth">
The reference response against which the provided response will be scored.
</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Extensions.AI.Evaluation.NLP.F1EvaluatorContext" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GroundTruth">
<MemberSignature Language="C#" Value="public string GroundTruth { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string GroundTruth" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.AI.Evaluation.NLP.F1EvaluatorContext.GroundTruth" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property GroundTruth As String" />
<MemberSignature Language="F#" Value="member this.GroundTruth : string" Usage="Microsoft.Extensions.AI.Evaluation.NLP.F1EvaluatorContext.GroundTruth" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ GroundTruth { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI.Evaluation.NLP</AssemblyName>
<AssemblyVersion>10.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the reference response against which the provided response will be scored.
</summary>
<value>To be added.</value>
<remarks>
The <see cref="T:Microsoft.Extensions.AI.Evaluation.NLP.F1Evaluator" /> measures the degree to which the response being evaluated is similar to
the response supplied via <see cref="P:Microsoft.Extensions.AI.Evaluation.NLP.F1EvaluatorContext.GroundTruth" />. The metric will be reported as an F1 score.
</remarks>
</Docs>
</Member>
<Member MemberName="GroundTruthContextName">
<MemberSignature Language="C#" Value="public static string GroundTruthContextName { get; }" />
<MemberSignature Language="ILAsm" Value=".property string GroundTruthContextName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.AI.Evaluation.NLP.F1EvaluatorContext.GroundTruthContextName" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property GroundTruthContextName As String" />
<MemberSignature Language="F#" Value="static member GroundTruthContextName : string" Usage="Microsoft.Extensions.AI.Evaluation.NLP.F1EvaluatorContext.GroundTruthContextName" />
<MemberSignature Language="C++ CLI" Value="public:
 static property System::String ^ GroundTruthContextName { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI.Evaluation.NLP</AssemblyName>
<AssemblyVersion>10.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the unique <see cref="P:Microsoft.Extensions.AI.Evaluation.EvaluationContext.Name" /> that is used for
<see cref="T:Microsoft.Extensions.AI.Evaluation.NLP.F1EvaluatorContext" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>