Skip to content

Commit fb73678

Browse files
author
[email protected]
committed
CI Update
 Build.Reason:Manual by Genevieve Warren Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=489437&view=results source_repo.branch:meai-evaluation source_repo.url:https://apidrop.visualstudio.com/_git/binaries
1 parent 967a026 commit fb73678

File tree

367 files changed

+39650
-3449
lines changed

Some content is hidden

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

367 files changed

+39650
-3449
lines changed

‎xml/FrameworksIndex/net-7.0-pp.xml‎

Lines changed: 1429 additions & 0 deletions
Large diffs are not rendered by default.

‎xml/FrameworksIndex/net-8.0-pp.xml‎

Lines changed: 987 additions & 52 deletions
Large diffs are not rendered by default.

‎xml/FrameworksIndex/net-9.0-pp.xml‎

Lines changed: 4667 additions & 0 deletions
Large diffs are not rendered by default.

‎xml/FrameworksIndex/netstandard-2.0-pp.xml‎

Lines changed: 183 additions & 0 deletions
Large diffs are not rendered by default.

‎xml/Microsoft.Extensions.AI.Evaluation.Quality/ChatConversationEvaluator.xml‎

Lines changed: 454 additions & 0 deletions
Large diffs are not rendered by default.

‎xml/Microsoft.Extensions.AI.Evaluation.Quality/CoherenceEvaluator.xml‎

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
<Type Name="CoherenceEvaluator" FullName="Microsoft.Extensions.AI.Evaluation.Quality.CoherenceEvaluator">
2+
<TypeSignature Language="C#" Value="public sealed class CoherenceEvaluator : Microsoft.Extensions.AI.Evaluation.Quality.SingleNumericMetricEvaluator" />
3+
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit CoherenceEvaluator extends Microsoft.Extensions.AI.Evaluation.Quality.SingleNumericMetricEvaluator" />
4+
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.AI.Evaluation.Quality.CoherenceEvaluator" />
5+
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class CoherenceEvaluator&#xA;Inherits SingleNumericMetricEvaluator" />
6+
<TypeSignature Language="F#" Value="type CoherenceEvaluator = class&#xA; inherit SingleNumericMetricEvaluator" />
7+
<TypeSignature Language="C++ CLI" Value="public ref class CoherenceEvaluator sealed : Microsoft::Extensions::AI::Evaluation::Quality::SingleNumericMetricEvaluator" />
8+
<AssemblyInfo>
9+
<AssemblyName>Microsoft.Extensions.AI.Evaluation.Quality</AssemblyName>
10+
<AssemblyVersion>1.0.0.0</AssemblyVersion>
11+
</AssemblyInfo>
12+
<Base>
13+
<BaseTypeName>Microsoft.Extensions.AI.Evaluation.Quality.SingleNumericMetricEvaluator</BaseTypeName>
14+
</Base>
15+
<Interfaces />
16+
<Attributes>
17+
<Attribute FrameworkAlternate="net-8.0-pp">
18+
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
19+
<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(0)&gt;]</AttributeName>
20+
</Attribute>
21+
</Attributes>
22+
<Docs>
23+
<summary>
24+
An <see cref="T:Microsoft.Extensions.AI.Evaluation.IEvaluator" /> that evaluates the 'Coherence' of a response produced by an AI model.
25+
</summary>
26+
<remarks>To be added.</remarks>
27+
</Docs>
28+
<Members>
29+
<Member MemberName=".ctor">
30+
<MemberSignature Language="C#" Value="public CoherenceEvaluator ();" />
31+
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
32+
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AI.Evaluation.Quality.CoherenceEvaluator.#ctor" />
33+
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
34+
<MemberSignature Language="C++ CLI" Value="public:&#xA; CoherenceEvaluator();" />
35+
<MemberType>Constructor</MemberType>
36+
<AssemblyInfo>
37+
<AssemblyName>Microsoft.Extensions.AI.Evaluation.Quality</AssemblyName>
38+
<AssemblyVersion>1.0.0.0</AssemblyVersion>
39+
</AssemblyInfo>
40+
<Parameters />
41+
<Docs>
42+
<summary>To be added.</summary>
43+
<remarks>To be added.</remarks>
44+
</Docs>
45+
</Member>
46+
<Member MemberName="CoherenceMetricName">
47+
<MemberSignature Language="C#" Value="public static string CoherenceMetricName { get; }" />
48+
<MemberSignature Language="ILAsm" Value=".property string CoherenceMetricName" />
49+
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.AI.Evaluation.Quality.CoherenceEvaluator.CoherenceMetricName" />
50+
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property CoherenceMetricName As String" />
51+
<MemberSignature Language="F#" Value="static member CoherenceMetricName : string" Usage="Microsoft.Extensions.AI.Evaluation.Quality.CoherenceEvaluator.CoherenceMetricName" />
52+
<MemberSignature Language="C++ CLI" Value="public:&#xA; static property System::String ^ CoherenceMetricName { System::String ^ get(); };" />
53+
<MemberType>Property</MemberType>
54+
<AssemblyInfo>
55+
<AssemblyName>Microsoft.Extensions.AI.Evaluation.Quality</AssemblyName>
56+
<AssemblyVersion>1.0.0.0</AssemblyVersion>
57+
</AssemblyInfo>
58+
<ReturnValue>
59+
<ReturnType>System.String</ReturnType>
60+
</ReturnValue>
61+
<Docs>
62+
<summary>
63+
The <see cref="P:Microsoft.Extensions.AI.Evaluation.EvaluationMetric.Name" /> of the <see cref="T:Microsoft.Extensions.AI.Evaluation.NumericMetric" /> returned by
64+
<see cref="T:Microsoft.Extensions.AI.Evaluation.Quality.CoherenceEvaluator" />.
65+
</summary>
66+
<value>To be added.</value>
67+
<remarks>To be added.</remarks>
68+
</Docs>
69+
</Member>
70+
<Member MemberName="IgnoresHistory">
71+
<MemberSignature Language="C#" Value="protected override bool IgnoresHistory { get; }" />
72+
<MemberSignature Language="ILAsm" Value=".property instance bool IgnoresHistory" />
73+
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.AI.Evaluation.Quality.CoherenceEvaluator.IgnoresHistory" />
74+
<MemberSignature Language="VB.NET" Value="Protected Overrides ReadOnly Property IgnoresHistory As Boolean" />
75+
<MemberSignature Language="F#" Value="member this.IgnoresHistory : bool" Usage="Microsoft.Extensions.AI.Evaluation.Quality.CoherenceEvaluator.IgnoresHistory" />
76+
<MemberSignature Language="C++ CLI" Value="protected:&#xA; virtual property bool IgnoresHistory { bool get(); };" />
77+
<MemberType>Property</MemberType>
78+
<AssemblyInfo>
79+
<AssemblyName>Microsoft.Extensions.AI.Evaluation.Quality</AssemblyName>
80+
<AssemblyVersion>1.0.0.0</AssemblyVersion>
81+
</AssemblyInfo>
82+
<ReturnValue>
83+
<ReturnType>System.Boolean</ReturnType>
84+
</ReturnValue>
85+
<Docs>
86+
<summary>To be added.</summary>
87+
<value>To be added.</value>
88+
<remarks>To be added.</remarks>
89+
<inheritdoc />
90+
</Docs>
91+
</Member>
92+
<Member MemberName="MetricName">
93+
<MemberSignature Language="C#" Value="protected override string MetricName { get; }" />
94+
<MemberSignature Language="ILAsm" Value=".property instance string MetricName" />
95+
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.AI.Evaluation.Quality.CoherenceEvaluator.MetricName" />
96+
<MemberSignature Language="VB.NET" Value="Protected Overrides ReadOnly Property MetricName As String" />
97+
<MemberSignature Language="F#" Value="member this.MetricName : string" Usage="Microsoft.Extensions.AI.Evaluation.Quality.CoherenceEvaluator.MetricName" />
98+
<MemberSignature Language="C++ CLI" Value="protected:&#xA; virtual property System::String ^ MetricName { System::String ^ get(); };" />
99+
<MemberType>Property</MemberType>
100+
<AssemblyInfo>
101+
<AssemblyName>Microsoft.Extensions.AI.Evaluation.Quality</AssemblyName>
102+
<AssemblyVersion>1.0.0.0</AssemblyVersion>
103+
</AssemblyInfo>
104+
<ReturnValue>
105+
<ReturnType>System.String</ReturnType>
106+
</ReturnValue>
107+
<Docs>
108+
<summary>To be added.</summary>
109+
<value>To be added.</value>
110+
<remarks>To be added.</remarks>
111+
<inheritdoc />
112+
</Docs>
113+
</Member>
114+
<Member MemberName="RenderEvaluationPromptAsync">
115+
<MemberSignature Language="C#" Value="protected override System.Threading.Tasks.ValueTask&lt;string&gt; RenderEvaluationPromptAsync (Microsoft.Extensions.AI.ChatMessage? userRequest, Microsoft.Extensions.AI.ChatMessage modelResponse, System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.AI.ChatMessage&gt;? includedHistory, System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.AI.Evaluation.EvaluationContext&gt;? additionalContext, System.Threading.CancellationToken cancellationToken);" />
116+
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance valuetype System.Threading.Tasks.ValueTask`1&lt;string&gt; RenderEvaluationPromptAsync(class Microsoft.Extensions.AI.ChatMessage userRequest, class Microsoft.Extensions.AI.ChatMessage modelResponse, class System.Collections.Generic.IEnumerable`1&lt;class Microsoft.Extensions.AI.ChatMessage&gt; includedHistory, class System.Collections.Generic.IEnumerable`1&lt;class Microsoft.Extensions.AI.Evaluation.EvaluationContext&gt; additionalContext, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
117+
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AI.Evaluation.Quality.CoherenceEvaluator.RenderEvaluationPromptAsync(Microsoft.Extensions.AI.ChatMessage,Microsoft.Extensions.AI.ChatMessage,System.Collections.Generic.IEnumerable{Microsoft.Extensions.AI.ChatMessage},System.Collections.Generic.IEnumerable{Microsoft.Extensions.AI.Evaluation.EvaluationContext},System.Threading.CancellationToken)" />
118+
<MemberSignature Language="VB.NET" Value="Protected Overrides Function RenderEvaluationPromptAsync (userRequest As ChatMessage, modelResponse As ChatMessage, includedHistory As IEnumerable(Of ChatMessage), additionalContext As IEnumerable(Of EvaluationContext), cancellationToken As CancellationToken) As ValueTask(Of String)" />
119+
<MemberSignature Language="F#" Value="override this.RenderEvaluationPromptAsync : Microsoft.Extensions.AI.ChatMessage * Microsoft.Extensions.AI.ChatMessage * seq&lt;Microsoft.Extensions.AI.ChatMessage&gt; * seq&lt;Microsoft.Extensions.AI.Evaluation.EvaluationContext&gt; * System.Threading.CancellationToken -&gt; System.Threading.Tasks.ValueTask&lt;string&gt;" Usage="coherenceEvaluator.RenderEvaluationPromptAsync (userRequest, modelResponse, includedHistory, additionalContext, cancellationToken)" />
120+
<MemberSignature Language="C++ CLI" Value="protected:&#xA; override System::Threading::Tasks::ValueTask&lt;System::String ^&gt; RenderEvaluationPromptAsync(Microsoft::Extensions::AI::ChatMessage ^ userRequest, Microsoft::Extensions::AI::ChatMessage ^ modelResponse, System::Collections::Generic::IEnumerable&lt;Microsoft::Extensions::AI::ChatMessage ^&gt; ^ includedHistory, System::Collections::Generic::IEnumerable&lt;Microsoft::Extensions::AI::Evaluation::EvaluationContext ^&gt; ^ additionalContext, System::Threading::CancellationToken cancellationToken);" />
121+
<MemberType>Method</MemberType>
122+
<AssemblyInfo>
123+
<AssemblyName>Microsoft.Extensions.AI.Evaluation.Quality</AssemblyName>
124+
<AssemblyVersion>1.0.0.0</AssemblyVersion>
125+
</AssemblyInfo>
126+
<ReturnValue>
127+
<ReturnType>System.Threading.Tasks.ValueTask&lt;System.String&gt;</ReturnType>
128+
<Attributes>
129+
<Attribute FrameworkAlternate="net-8.0-pp">
130+
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })]</AttributeName>
131+
<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })&gt;]</AttributeName>
132+
</Attribute>
133+
</Attributes>
134+
</ReturnValue>
135+
<Parameters>
136+
<Parameter Name="userRequest" Type="Microsoft.Extensions.AI.ChatMessage">
137+
<Attributes>
138+
<Attribute FrameworkAlternate="net-8.0-pp">
139+
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
140+
<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(2)&gt;]</AttributeName>
141+
</Attribute>
142+
</Attributes>
143+
</Parameter>
144+
<Parameter Name="modelResponse" Type="Microsoft.Extensions.AI.ChatMessage" />
145+
<Parameter Name="includedHistory" Type="System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.AI.ChatMessage&gt;">
146+
<Attributes>
147+
<Attribute FrameworkAlternate="net-8.0-pp">
148+
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })]</AttributeName>
149+
<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })&gt;]</AttributeName>
150+
</Attribute>
151+
</Attributes>
152+
</Parameter>
153+
<Parameter Name="additionalContext" Type="System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.AI.Evaluation.EvaluationContext&gt;">
154+
<Attributes>
155+
<Attribute FrameworkAlternate="net-8.0-pp">
156+
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })]</AttributeName>
157+
<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })&gt;]</AttributeName>
158+
</Attribute>
159+
</Attributes>
160+
</Parameter>
161+
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
162+
</Parameters>
163+
<Docs>
164+
<param name="userRequest">To be added.</param>
165+
<param name="modelResponse">To be added.</param>
166+
<param name="includedHistory">To be added.</param>
167+
<param name="additionalContext">To be added.</param>
168+
<param name="cancellationToken">To be added.</param>
169+
<summary>To be added.</summary>
170+
<returns>To be added.</returns>
171+
<remarks>To be added.</remarks>
172+
<inheritdoc />
173+
</Docs>
174+
</Member>
175+
</Members>
176+
</Type>

‎xml/Microsoft.Extensions.AI.Evaluation.Quality/EquivalenceEvaluator+Context.xml‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
<Type Name="EquivalenceEvaluator+Context" FullName="Microsoft.Extensions.AI.Evaluation.Quality.EquivalenceEvaluator+Context">
2+
<TypeSignature Language="C#" Value="public sealed class EquivalenceEvaluator.Context : Microsoft.Extensions.AI.Evaluation.EvaluationContext" />
3+
<TypeSignature Language="ILAsm" Value=".class nested public auto ansi sealed beforefieldinit EquivalenceEvaluator/Context extends Microsoft.Extensions.AI.Evaluation.EvaluationContext" />
4+
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.AI.Evaluation.Quality.EquivalenceEvaluator.Context" />
5+
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class EquivalenceEvaluator.Context&#xA;Inherits EvaluationContext" />
6+
<TypeSignature Language="F#" Value="type EquivalenceEvaluator.Context = class&#xA; inherit EvaluationContext" />
7+
<TypeSignature Language="C++ CLI" Value="public: ref class EquivalenceEvaluator::Context sealed : Microsoft::Extensions::AI::Evaluation::EvaluationContext" />
8+
<AssemblyInfo>
9+
<AssemblyName>Microsoft.Extensions.AI.Evaluation.Quality</AssemblyName>
10+
<AssemblyVersion>1.0.0.0</AssemblyVersion>
11+
</AssemblyInfo>
12+
<Base>
13+
<BaseTypeName>Microsoft.Extensions.AI.Evaluation.EvaluationContext</BaseTypeName>
14+
</Base>
15+
<Interfaces />
16+
<Attributes>
17+
<Attribute FrameworkAlternate="net-8.0-pp">
18+
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
19+
<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(0)&gt;]</AttributeName>
20+
</Attribute>
21+
</Attributes>
22+
<Docs>
23+
<param name="groundTruth">
24+
The ground truth response against which the response that is being evaluated is compared.
25+
</param>
26+
<summary>
27+
Contextual information required to evaluate the 'Equivalence' of a response.
28+
</summary>
29+
<remarks>
30+
The <see cref="T:Microsoft.Extensions.AI.Evaluation.Quality.EquivalenceEvaluator" /> measures the degree to which the response being evaluated is similar to
31+
the response supplied via <paramref name="groundTruth" />.
32+
</remarks>
33+
</Docs>
34+
<Members>
35+
<Member MemberName=".ctor">
36+
<MemberSignature Language="C#" Value="public Context (string groundTruth);" />
37+
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string groundTruth) cil managed" />
38+
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AI.Evaluation.Quality.EquivalenceEvaluator.Context.#ctor(System.String)" />
39+
<MemberSignature Language="VB.NET" Value="Public Sub New (groundTruth As String)" />
40+
<MemberSignature Language="F#" Value="new Microsoft.Extensions.AI.Evaluation.Quality.EquivalenceEvaluator.Context : string -&gt; Microsoft.Extensions.AI.Evaluation.Quality.EquivalenceEvaluator.Context" Usage="new Microsoft.Extensions.AI.Evaluation.Quality.EquivalenceEvaluator.Context groundTruth" />
41+
<MemberSignature Language="C++ CLI" Value="public:&#xA; Context(System::String ^ groundTruth);" />
42+
<MemberType>Constructor</MemberType>
43+
<AssemblyInfo>
44+
<AssemblyName>Microsoft.Extensions.AI.Evaluation.Quality</AssemblyName>
45+
<AssemblyVersion>1.0.0.0</AssemblyVersion>
46+
</AssemblyInfo>
47+
<Parameters>
48+
<Parameter Name="groundTruth" Type="System.String" />
49+
</Parameters>
50+
<Docs>
51+
<param name="groundTruth">
52+
The ground truth response against which the response that is being evaluated is compared.
53+
</param>
54+
<summary>
55+
Contextual information required to evaluate the 'Equivalence' of a response.
56+
</summary>
57+
<remarks>
58+
The <see cref="T:Microsoft.Extensions.AI.Evaluation.Quality.EquivalenceEvaluator" /> measures the degree to which the response being evaluated is similar to
59+
the response supplied via <paramref name="groundTruth" />.
60+
</remarks>
61+
</Docs>
62+
</Member>
63+
<Member MemberName="GroundTruth">
64+
<MemberSignature Language="C#" Value="public string GroundTruth { get; }" />
65+
<MemberSignature Language="ILAsm" Value=".property instance string GroundTruth" />
66+
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.AI.Evaluation.Quality.EquivalenceEvaluator.Context.GroundTruth" />
67+
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property GroundTruth As String" />
68+
<MemberSignature Language="F#" Value="member this.GroundTruth : string" Usage="Microsoft.Extensions.AI.Evaluation.Quality.EquivalenceEvaluator.Context.GroundTruth" />
69+
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ GroundTruth { System::String ^ get(); };" />
70+
<MemberType>Property</MemberType>
71+
<AssemblyInfo>
72+
<AssemblyName>Microsoft.Extensions.AI.Evaluation.Quality</AssemblyName>
73+
<AssemblyVersion>1.0.0.0</AssemblyVersion>
74+
</AssemblyInfo>
75+
<ReturnValue>
76+
<ReturnType>System.String</ReturnType>
77+
</ReturnValue>
78+
<Docs>
79+
<summary>
80+
The ground truth response against which the response that is being evaluated is compared.
81+
</summary>
82+
<value>To be added.</value>
83+
<remarks>
84+
The <see cref="T:Microsoft.Extensions.AI.Evaluation.Quality.EquivalenceEvaluator" /> measures the degree to which the response being evaluated is
85+
similar to the response supplied via <see cref="P:Microsoft.Extensions.AI.Evaluation.Quality.EquivalenceEvaluator.Context.GroundTruth" />.
86+
</remarks>
87+
</Docs>
88+
</Member>
89+
</Members>
90+
</Type>

0 commit comments

Comments
 (0)