Skip to content

Commit 8671443

Browse files
gewarrengewarren
committed
Microsoft.Extensions*
1 parent 67968f4 commit 8671443

File tree

388 files changed

+5154
-1696
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

388 files changed

+5154
-1696
lines changed

‎xml/Microsoft.Extensions.AI.Evaluation.NLP/BLEUEvaluator.xml‎

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
<Type Name="BLEUEvaluator" FullName="Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluator">
2+
<TypeSignature Language="C#" Value="public sealed class BLEUEvaluator : Microsoft.Extensions.AI.Evaluation.IEvaluator" />
3+
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit BLEUEvaluator extends System.Object implements class Microsoft.Extensions.AI.Evaluation.IEvaluator" />
4+
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluator" />
5+
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class BLEUEvaluator&#xA;Implements IEvaluator" />
6+
<TypeSignature Language="F#" Value="type BLEUEvaluator = class&#xA; interface IEvaluator" />
7+
<TypeSignature Language="C++ CLI" Value="public ref class BLEUEvaluator sealed : Microsoft::Extensions::AI::Evaluation::IEvaluator" />
8+
<AssemblyInfo>
9+
<AssemblyName>Microsoft.Extensions.AI.Evaluation.NLP</AssemblyName>
10+
<AssemblyVersion>9.7.0.0</AssemblyVersion>
11+
</AssemblyInfo>
12+
<Base>
13+
<BaseTypeName>System.Object</BaseTypeName>
14+
</Base>
15+
<Interfaces>
16+
<Interface>
17+
<InterfaceName>Microsoft.Extensions.AI.Evaluation.IEvaluator</InterfaceName>
18+
</Interface>
19+
</Interfaces>
20+
<Attributes>
21+
<Attribute FrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
22+
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
23+
<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(0)&gt;]</AttributeName>
24+
</Attribute>
25+
</Attributes>
26+
<Docs>
27+
<summary>
28+
An <see cref="T:Microsoft.Extensions.AI.Evaluation.IEvaluator" /> that evaluates the quality of a response produced by an AI model by comparing
29+
it to a reference response using the BLEU (Bilingual Evaluation Understudy) algorithm. It is often used
30+
to evaluate the quality of machine translation or text generation tasks.
31+
</summary>
32+
<remarks>
33+
<para>
34+
The <see cref="T:Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluator" /> computes the BLEU score of a response ("hypothesis") compared to one or more
35+
reference responses supplied via <see cref="P:Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluatorContext.References" />. The score is returned in a
36+
<see cref="T:Microsoft.Extensions.AI.Evaluation.NumericMetric" /> with a value between 0.0 and 1.0 where 0.0 represents no match at all and 1.0 indicates
37+
a perfect match. By default, the score is interpreted with a pass/fail cutoff of 0.5. So a score of 0.5 or higher
38+
is passing and a score below 0.5 is failing.
39+
</para>
40+
</remarks>
41+
</Docs>
42+
<Members>
43+
<Member MemberName=".ctor">
44+
<MemberSignature Language="C#" Value="public BLEUEvaluator ();" />
45+
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
46+
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluator.#ctor" />
47+
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
48+
<MemberSignature Language="C++ CLI" Value="public:&#xA; BLEUEvaluator();" />
49+
<MemberType>Constructor</MemberType>
50+
<AssemblyInfo>
51+
<AssemblyName>Microsoft.Extensions.AI.Evaluation.NLP</AssemblyName>
52+
<AssemblyVersion>9.7.0.0</AssemblyVersion>
53+
</AssemblyInfo>
54+
<Parameters />
55+
<Docs>
56+
<summary>To be added.</summary>
57+
<remarks>To be added.</remarks>
58+
</Docs>
59+
</Member>
60+
<Member MemberName="BLEUMetricName">
61+
<MemberSignature Language="C#" Value="public static string BLEUMetricName { get; }" />
62+
<MemberSignature Language="ILAsm" Value=".property string BLEUMetricName" />
63+
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluator.BLEUMetricName" />
64+
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property BLEUMetricName As String" />
65+
<MemberSignature Language="F#" Value="static member BLEUMetricName : string" Usage="Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluator.BLEUMetricName" />
66+
<MemberSignature Language="C++ CLI" Value="public:&#xA; static property System::String ^ BLEUMetricName { System::String ^ get(); };" />
67+
<MemberType>Property</MemberType>
68+
<AssemblyInfo>
69+
<AssemblyName>Microsoft.Extensions.AI.Evaluation.NLP</AssemblyName>
70+
<AssemblyVersion>9.7.0.0</AssemblyVersion>
71+
</AssemblyInfo>
72+
<ReturnValue>
73+
<ReturnType>System.String</ReturnType>
74+
</ReturnValue>
75+
<Docs>
76+
<summary>
77+
Gets the <see cref="P:Microsoft.Extensions.AI.Evaluation.EvaluationMetric.Name" /> of the <see cref="T:Microsoft.Extensions.AI.Evaluation.NumericMetric" /> returned by
78+
<see cref="T:Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluator" />.
79+
</summary>
80+
<value>To be added.</value>
81+
<remarks>To be added.</remarks>
82+
</Docs>
83+
</Member>
84+
<Member MemberName="EvaluateAsync">
85+
<MemberSignature Language="C#" Value="public System.Threading.Tasks.ValueTask&lt;Microsoft.Extensions.AI.Evaluation.EvaluationResult&gt; EvaluateAsync (System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.AI.ChatMessage&gt; messages, Microsoft.Extensions.AI.ChatResponse modelResponse, Microsoft.Extensions.AI.Evaluation.ChatConfiguration? chatConfiguration = default, System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.AI.Evaluation.EvaluationContext&gt;? additionalContext = default, System.Threading.CancellationToken cancellationToken = default);" />
86+
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype System.Threading.Tasks.ValueTask`1&lt;class Microsoft.Extensions.AI.Evaluation.EvaluationResult&gt; EvaluateAsync(class System.Collections.Generic.IEnumerable`1&lt;class Microsoft.Extensions.AI.ChatMessage&gt; messages, class Microsoft.Extensions.AI.ChatResponse modelResponse, class Microsoft.Extensions.AI.Evaluation.ChatConfiguration chatConfiguration, class System.Collections.Generic.IEnumerable`1&lt;class Microsoft.Extensions.AI.Evaluation.EvaluationContext&gt; additionalContext, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
87+
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluator.EvaluateAsync(System.Collections.Generic.IEnumerable{Microsoft.Extensions.AI.ChatMessage},Microsoft.Extensions.AI.ChatResponse,Microsoft.Extensions.AI.Evaluation.ChatConfiguration,System.Collections.Generic.IEnumerable{Microsoft.Extensions.AI.Evaluation.EvaluationContext},System.Threading.CancellationToken)" />
88+
<MemberSignature Language="VB.NET" Value="Public Function EvaluateAsync (messages As IEnumerable(Of ChatMessage), modelResponse As ChatResponse, Optional chatConfiguration As ChatConfiguration = Nothing, Optional additionalContext As IEnumerable(Of EvaluationContext) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of EvaluationResult)" />
89+
<MemberSignature Language="F#" Value="abstract member EvaluateAsync : seq&lt;Microsoft.Extensions.AI.ChatMessage&gt; * Microsoft.Extensions.AI.ChatResponse * Microsoft.Extensions.AI.Evaluation.ChatConfiguration * seq&lt;Microsoft.Extensions.AI.Evaluation.EvaluationContext&gt; * System.Threading.CancellationToken -&gt; System.Threading.Tasks.ValueTask&lt;Microsoft.Extensions.AI.Evaluation.EvaluationResult&gt;&#xA;override this.EvaluateAsync : seq&lt;Microsoft.Extensions.AI.ChatMessage&gt; * Microsoft.Extensions.AI.ChatResponse * Microsoft.Extensions.AI.Evaluation.ChatConfiguration * seq&lt;Microsoft.Extensions.AI.Evaluation.EvaluationContext&gt; * System.Threading.CancellationToken -&gt; System.Threading.Tasks.ValueTask&lt;Microsoft.Extensions.AI.Evaluation.EvaluationResult&gt;" Usage="bLEUEvaluator.EvaluateAsync (messages, modelResponse, chatConfiguration, additionalContext, cancellationToken)" />
90+
<MemberType>Method</MemberType>
91+
<Implements>
92+
<InterfaceMember>M:Microsoft.Extensions.AI.Evaluation.IEvaluator.EvaluateAsync(System.Collections.Generic.IEnumerable{Microsoft.Extensions.AI.ChatMessage},Microsoft.Extensions.AI.ChatResponse,Microsoft.Extensions.AI.Evaluation.ChatConfiguration,System.Collections.Generic.IEnumerable{Microsoft.Extensions.AI.Evaluation.EvaluationContext},System.Threading.CancellationToken)</InterfaceMember>
93+
</Implements>
94+
<AssemblyInfo>
95+
<AssemblyName>Microsoft.Extensions.AI.Evaluation.NLP</AssemblyName>
96+
<AssemblyVersion>9.7.0.0</AssemblyVersion>
97+
</AssemblyInfo>
98+
<ReturnValue>
99+
<ReturnType>System.Threading.Tasks.ValueTask&lt;Microsoft.Extensions.AI.Evaluation.EvaluationResult&gt;</ReturnType>
100+
<Attributes>
101+
<Attribute FrameworkAlternate="net-10.0-pp">
102+
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })]</AttributeName>
103+
<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })&gt;]</AttributeName>
104+
</Attribute>
105+
</Attributes>
106+
</ReturnValue>
107+
<Parameters>
108+
<Parameter Name="messages" Type="System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.AI.ChatMessage&gt;" />
109+
<Parameter Name="modelResponse" Type="Microsoft.Extensions.AI.ChatResponse" />
110+
<Parameter Name="chatConfiguration" Type="Microsoft.Extensions.AI.Evaluation.ChatConfiguration">
111+
<Attributes>
112+
<Attribute FrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
113+
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
114+
<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(2)&gt;]</AttributeName>
115+
</Attribute>
116+
</Attributes>
117+
</Parameter>
118+
<Parameter Name="additionalContext" Type="System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.AI.Evaluation.EvaluationContext&gt;">
119+
<Attributes>
120+
<Attribute FrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
121+
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })]</AttributeName>
122+
<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })&gt;]</AttributeName>
123+
</Attribute>
124+
</Attributes>
125+
</Parameter>
126+
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
127+
</Parameters>
128+
<Docs>
129+
<param name="messages">To be added.</param>
130+
<param name="modelResponse">To be added.</param>
131+
<param name="chatConfiguration">To be added.</param>
132+
<param name="additionalContext">To be added.</param>
133+
<param name="cancellationToken">To be added.</param>
134+
<summary>To be added.</summary>
135+
<returns>To be added.</returns>
136+
<remarks>To be added.</remarks>
137+
<inheritdoc />
138+
</Docs>
139+
</Member>
140+
<Member MemberName="EvaluationMetricNames">
141+
<MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyCollection&lt;string&gt; EvaluationMetricNames { get; }" />
142+
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyCollection`1&lt;string&gt; EvaluationMetricNames" />
143+
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluator.EvaluationMetricNames" />
144+
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property EvaluationMetricNames As IReadOnlyCollection(Of String)" />
145+
<MemberSignature Language="F#" Value="member this.EvaluationMetricNames : System.Collections.Generic.IReadOnlyCollection&lt;string&gt;" Usage="Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluator.EvaluationMetricNames" />
146+
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Collections::Generic::IReadOnlyCollection&lt;System::String ^&gt; ^ EvaluationMetricNames { System::Collections::Generic::IReadOnlyCollection&lt;System::String ^&gt; ^ get(); };" />
147+
<MemberType>Property</MemberType>
148+
<Implements>
149+
<InterfaceMember>P:Microsoft.Extensions.AI.Evaluation.IEvaluator.EvaluationMetricNames</InterfaceMember>
150+
</Implements>
151+
<AssemblyInfo>
152+
<AssemblyName>Microsoft.Extensions.AI.Evaluation.NLP</AssemblyName>
153+
<AssemblyVersion>9.7.0.0</AssemblyVersion>
154+
</AssemblyInfo>
155+
<ReturnValue>
156+
<ReturnType>System.Collections.Generic.IReadOnlyCollection&lt;System.String&gt;</ReturnType>
157+
</ReturnValue>
158+
<Docs>
159+
<summary>To be added.</summary>
160+
<value>To be added.</value>
161+
<remarks>To be added.</remarks>
162+
<inheritdoc />
163+
</Docs>
164+
</Member>
165+
</Members>
166+
</Type>

0 commit comments

Comments
 (0)