Skip to content

Commit f03dff8

Browse files
dotnet-policy-service[bot]dotnet-policy-service[bot]
authored
Merge pull request #11294 from dotnet/main
Merge main into live
2 parents b8e269c + 66eeaf0 commit f03dff8

File tree

159 files changed

+12005
-3598
lines changed

Some content is hidden

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

159 files changed

+12005
-3598
lines changed

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

+349-104
Large diffs are not rendered by default.

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

+349-104
Large diffs are not rendered by default.

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

+349-104
Large diffs are not rendered by default.

‎xml/FrameworksIndex/netframework-4.6.2-pp.xml

+349-104
Large diffs are not rendered by default.

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

+349-104
Large diffs are not rendered by default.

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

-480
This file was deleted.

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

+59-72
Large diffs are not rendered by default.

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

+179
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,179 @@
1+
<Type Name="CompletenessEvaluator" FullName="Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluator">
2+
<TypeSignature Language="C#" Value="public sealed class CompletenessEvaluator : Microsoft.Extensions.AI.Evaluation.IEvaluator" />
3+
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit CompletenessEvaluator extends System.Object implements class Microsoft.Extensions.AI.Evaluation.IEvaluator" />
4+
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluator" />
5+
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class CompletenessEvaluator&#xA;Implements IEvaluator" />
6+
<TypeSignature Language="F#" Value="type CompletenessEvaluator = class&#xA; interface IEvaluator" />
7+
<TypeSignature Language="C++ CLI" Value="public ref class CompletenessEvaluator sealed : Microsoft::Extensions::AI::Evaluation::IEvaluator" />
8+
<AssemblyInfo>
9+
<AssemblyName>Microsoft.Extensions.AI.Evaluation.Quality</AssemblyName>
10+
<AssemblyVersion>9.4.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 'Completeness' of a response produced by an AI model.
29+
</summary>
30+
<remarks>
31+
<para>
32+
<see cref="T:Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluator" /> measures an AI system's ability to deliver comprehensive and accurate
33+
responses. It assesses how thoroughly the response aligns with the key information, claims, and statements
34+
established in the supplied <see cref="P:Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluatorContext.GroundTruth" />. It returns a
35+
<see cref="T:Microsoft.Extensions.AI.Evaluation.NumericMetric" /> that contains a score for 'Completeness'. The score is a number between 1 and 5, with 1
36+
indicating a poor score, and 5 indicating an excellent score.
37+
</para>
38+
<para>
39+
<b>Note:</b>
40+
<see cref="T:Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluator" /> is an AI-based evaluator that uses an AI model to perform its
41+
evaluation. While the prompt that this evaluator uses to perform its evaluation is designed to be model-agnostic,
42+
the performance of this prompt (and the resulting evaluation) can vary depending on the model used, and can be
43+
especially poor when a smaller / local model is used.
44+
</para>
45+
<para>
46+
The prompt that <see cref="T:Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluator" /> uses has been tested against (and tuned to work well with) the
47+
following models. So, using this evaluator with a model from the following list is likely to produce the best
48+
results. (The model to be used can be configured via <see cref="P:Microsoft.Extensions.AI.Evaluation.ChatConfiguration.ChatClient" />.)
49+
</para>
50+
<para>
51+
<b>GPT-4o</b>
52+
</para>
53+
</remarks>
54+
</Docs>
55+
<Members>
56+
<Member MemberName=".ctor">
57+
<MemberSignature Language="C#" Value="public CompletenessEvaluator ();" />
58+
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
59+
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluator.#ctor" />
60+
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
61+
<MemberSignature Language="C++ CLI" Value="public:&#xA; CompletenessEvaluator();" />
62+
<MemberType>Constructor</MemberType>
63+
<AssemblyInfo>
64+
<AssemblyName>Microsoft.Extensions.AI.Evaluation.Quality</AssemblyName>
65+
<AssemblyVersion>9.4.0.0</AssemblyVersion>
66+
</AssemblyInfo>
67+
<Parameters />
68+
<Docs>
69+
<summary>To be added.</summary>
70+
<remarks>To be added.</remarks>
71+
</Docs>
72+
</Member>
73+
<Member MemberName="CompletenessMetricName">
74+
<MemberSignature Language="C#" Value="public static string CompletenessMetricName { get; }" />
75+
<MemberSignature Language="ILAsm" Value=".property string CompletenessMetricName" />
76+
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluator.CompletenessMetricName" />
77+
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property CompletenessMetricName As String" />
78+
<MemberSignature Language="F#" Value="static member CompletenessMetricName : string" Usage="Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluator.CompletenessMetricName" />
79+
<MemberSignature Language="C++ CLI" Value="public:&#xA; static property System::String ^ CompletenessMetricName { System::String ^ get(); };" />
80+
<MemberType>Property</MemberType>
81+
<AssemblyInfo>
82+
<AssemblyName>Microsoft.Extensions.AI.Evaluation.Quality</AssemblyName>
83+
<AssemblyVersion>9.4.0.0</AssemblyVersion>
84+
</AssemblyInfo>
85+
<ReturnValue>
86+
<ReturnType>System.String</ReturnType>
87+
</ReturnValue>
88+
<Docs>
89+
<summary>
90+
Gets the <see cref="P:Microsoft.Extensions.AI.Evaluation.EvaluationMetric.Name" /> of the <see cref="T:Microsoft.Extensions.AI.Evaluation.NumericMetric" /> returned by
91+
<see cref="T:Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluator" />.
92+
</summary>
93+
<value>To be added.</value>
94+
<remarks>To be added.</remarks>
95+
</Docs>
96+
</Member>
97+
<Member MemberName="EvaluateAsync">
98+
<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);" />
99+
<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" />
100+
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluator.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)" />
101+
<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)" />
102+
<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="completenessEvaluator.EvaluateAsync (messages, modelResponse, chatConfiguration, additionalContext, cancellationToken)" />
103+
<MemberType>Method</MemberType>
104+
<Implements>
105+
<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>
106+
</Implements>
107+
<AssemblyInfo>
108+
<AssemblyName>Microsoft.Extensions.AI.Evaluation.Quality</AssemblyName>
109+
<AssemblyVersion>9.4.0.0</AssemblyVersion>
110+
</AssemblyInfo>
111+
<ReturnValue>
112+
<ReturnType>System.Threading.Tasks.ValueTask&lt;Microsoft.Extensions.AI.Evaluation.EvaluationResult&gt;</ReturnType>
113+
<Attributes>
114+
<Attribute FrameworkAlternate="net-10.0-pp">
115+
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })]</AttributeName>
116+
<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })&gt;]</AttributeName>
117+
</Attribute>
118+
</Attributes>
119+
</ReturnValue>
120+
<Parameters>
121+
<Parameter Name="messages" Type="System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.AI.ChatMessage&gt;" />
122+
<Parameter Name="modelResponse" Type="Microsoft.Extensions.AI.ChatResponse" />
123+
<Parameter Name="chatConfiguration" Type="Microsoft.Extensions.AI.Evaluation.ChatConfiguration">
124+
<Attributes>
125+
<Attribute FrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
126+
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
127+
<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(2)&gt;]</AttributeName>
128+
</Attribute>
129+
</Attributes>
130+
</Parameter>
131+
<Parameter Name="additionalContext" Type="System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.AI.Evaluation.EvaluationContext&gt;">
132+
<Attributes>
133+
<Attribute FrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
134+
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })]</AttributeName>
135+
<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })&gt;]</AttributeName>
136+
</Attribute>
137+
</Attributes>
138+
</Parameter>
139+
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
140+
</Parameters>
141+
<Docs>
142+
<param name="messages">To be added.</param>
143+
<param name="modelResponse">To be added.</param>
144+
<param name="chatConfiguration">To be added.</param>
145+
<param name="additionalContext">To be added.</param>
146+
<param name="cancellationToken">To be added.</param>
147+
<summary>To be added.</summary>
148+
<returns>To be added.</returns>
149+
<remarks>To be added.</remarks>
150+
<inheritdoc />
151+
</Docs>
152+
</Member>
153+
<Member MemberName="EvaluationMetricNames">
154+
<MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyCollection&lt;string&gt; EvaluationMetricNames { get; }" />
155+
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyCollection`1&lt;string&gt; EvaluationMetricNames" />
156+
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluator.EvaluationMetricNames" />
157+
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property EvaluationMetricNames As IReadOnlyCollection(Of String)" />
158+
<MemberSignature Language="F#" Value="member this.EvaluationMetricNames : System.Collections.Generic.IReadOnlyCollection&lt;string&gt;" Usage="Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluator.EvaluationMetricNames" />
159+
<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(); };" />
160+
<MemberType>Property</MemberType>
161+
<Implements>
162+
<InterfaceMember>P:Microsoft.Extensions.AI.Evaluation.IEvaluator.EvaluationMetricNames</InterfaceMember>
163+
</Implements>
164+
<AssemblyInfo>
165+
<AssemblyName>Microsoft.Extensions.AI.Evaluation.Quality</AssemblyName>
166+
<AssemblyVersion>9.4.0.0</AssemblyVersion>
167+
</AssemblyInfo>
168+
<ReturnValue>
169+
<ReturnType>System.Collections.Generic.IReadOnlyCollection&lt;System.String&gt;</ReturnType>
170+
</ReturnValue>
171+
<Docs>
172+
<summary>To be added.</summary>
173+
<value>To be added.</value>
174+
<remarks>To be added.</remarks>
175+
<inheritdoc />
176+
</Docs>
177+
</Member>
178+
</Members>
179+
</Type>

0 commit comments

Comments
 (0)