-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Expand file tree
/
Copy pathBLEUEvaluatorContext.xml
More file actions
149 lines (149 loc) · 9.59 KB
/
Copy pathBLEUEvaluatorContext.xml
File metadata and controls
149 lines (149 loc) · 9.59 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
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
<Type Name="BLEUEvaluatorContext" FullName="Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluatorContext">
<TypeSignature Language="C#" Value="public sealed class BLEUEvaluatorContext : Microsoft.Extensions.AI.Evaluation.EvaluationContext" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit BLEUEvaluatorContext extends Microsoft.Extensions.AI.Evaluation.EvaluationContext" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluatorContext" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class BLEUEvaluatorContext
Inherits EvaluationContext" />
<TypeSignature Language="F#" Value="type BLEUEvaluatorContext = class
 inherit EvaluationContext" />
<TypeSignature Language="C++ CLI" Value="public ref class BLEUEvaluatorContext 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.BLEUEvaluator" /> uses to compute the BLEU score for a response.
</summary>
<remarks>
<see cref="T:Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluator" /> measures the BLEU score of a response compared to one or more reference responses
supplied via <see cref="P:Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluatorContext.References" />. BLEU (Bilingual Evaluation Understudy) is a metric used to evaluate the
quality of machine-generated text.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public BLEUEvaluatorContext (System.Collections.Generic.IEnumerable<string> references);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Collections.Generic.IEnumerable`1<string> references) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluatorContext.#ctor(System.Collections.Generic.IEnumerable{System.String})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (references As IEnumerable(Of String))" />
<MemberSignature Language="F#" Value="new Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluatorContext : seq<string> -> Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluatorContext" Usage="new Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluatorContext references" />
<MemberSignature Language="C++ CLI" Value="public:
 BLEUEvaluatorContext(System::Collections::Generic::IEnumerable<System::String ^> ^ references);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI.Evaluation.NLP</AssemblyName>
<AssemblyVersion>10.6.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="references" Type="System.Collections.Generic.IEnumerable<System.String>" />
</Parameters>
<Docs>
<param name="references">
The reference responses against which the response that is being evaluated is compared.
</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluatorContext" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public BLEUEvaluatorContext (params string[] references);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string[] references) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluatorContext.#ctor(System.String[])" />
<MemberSignature Language="VB.NET" Value="Public Sub New (ParamArray references As String())" />
<MemberSignature Language="F#" Value="new Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluatorContext : string[] -> Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluatorContext" Usage="new Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluatorContext references" />
<MemberSignature Language="C++ CLI" Value="public:
 BLEUEvaluatorContext(... cli::array <System::String ^> ^ references);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI.Evaluation.NLP</AssemblyName>
<AssemblyVersion>10.6.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="references" Type="System.String[]">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ParamArray]</AttributeName>
<AttributeName Language="F#">[<System.ParamArray>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="references">
The reference responses against which the response that is being evaluated is compared.
</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluatorContext" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="References">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyList<string> References { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyList`1<string> References" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluatorContext.References" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property References As IReadOnlyList(Of String)" />
<MemberSignature Language="F#" Value="member this.References : System.Collections.Generic.IReadOnlyList<string>" Usage="Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluatorContext.References" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Collections::Generic::IReadOnlyList<System::String ^> ^ References { System::Collections::Generic::IReadOnlyList<System::String ^> ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI.Evaluation.NLP</AssemblyName>
<AssemblyVersion>10.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IReadOnlyList<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the references against which the provided response will be scored.
</summary>
<value>To be added.</value>
<remarks>
The <see cref="T:Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluator" /> measures the degree to which the response being evaluated is similar to
the responses supplied via <see cref="P:Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluatorContext.References" />. The metric will be reported as a BLEU score.
</remarks>
</Docs>
</Member>
<Member MemberName="ReferencesContextName">
<MemberSignature Language="C#" Value="public static string ReferencesContextName { get; }" />
<MemberSignature Language="ILAsm" Value=".property string ReferencesContextName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluatorContext.ReferencesContextName" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property ReferencesContextName As String" />
<MemberSignature Language="F#" Value="static member ReferencesContextName : string" Usage="Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluatorContext.ReferencesContextName" />
<MemberSignature Language="C++ CLI" Value="public:
 static property System::String ^ ReferencesContextName { 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.BLEUEvaluatorContext" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>