Skip to content

Merge main into live #11294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 13, 2025
Merged

Merge main into live #11294

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
453 changes: 349 additions & 104 deletions xml/FrameworksIndex/net-10.0-pp.xml
View file
Open in desktop

Large diffs are not rendered by default.

453 changes: 349 additions & 104 deletions xml/FrameworksIndex/net-8.0-pp.xml
View file
Open in desktop

Large diffs are not rendered by default.

453 changes: 349 additions & 104 deletions xml/FrameworksIndex/net-9.0-pp.xml
View file
Open in desktop

Large diffs are not rendered by default.

453 changes: 349 additions & 104 deletions xml/FrameworksIndex/netframework-4.6.2-pp.xml
View file
Open in desktop

Large diffs are not rendered by default.

453 changes: 349 additions & 104 deletions xml/FrameworksIndex/netstandard-2.0-pp.xml
View file
Open in desktop

Large diffs are not rendered by default.

480 changes: 0 additions & 480 deletions xml/Microsoft.Extensions.AI.Evaluation.Quality/ChatConversationEvaluator.xml
View file
Open in desktop

This file was deleted.

131 changes: 59 additions & 72 deletions xml/Microsoft.Extensions.AI.Evaluation.Quality/CoherenceEvaluator.xml
View file
Open in desktop

Large diffs are not rendered by default.

179 changes: 179 additions & 0 deletions xml/Microsoft.Extensions.AI.Evaluation.Quality/CompletenessEvaluator.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,179 @@
<Type Name="CompletenessEvaluator" FullName="Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluator">
<TypeSignature Language="C#" Value="public sealed class CompletenessEvaluator : Microsoft.Extensions.AI.Evaluation.IEvaluator" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit CompletenessEvaluator extends System.Object implements class Microsoft.Extensions.AI.Evaluation.IEvaluator" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluator" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class CompletenessEvaluator&#xA;Implements IEvaluator" />
<TypeSignature Language="F#" Value="type CompletenessEvaluator = class&#xA; interface IEvaluator" />
<TypeSignature Language="C++ CLI" Value="public ref class CompletenessEvaluator sealed : Microsoft::Extensions::AI::Evaluation::IEvaluator" />
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI.Evaluation.Quality</AssemblyName>
<AssemblyVersion>9.4.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Extensions.AI.Evaluation.IEvaluator</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute FrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(0)&gt;]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
An <see cref="T:Microsoft.Extensions.AI.Evaluation.IEvaluator" /> that evaluates the 'Completeness' of a response produced by an AI model.
</summary>
<remarks>
<para>
<see cref="T:Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluator" /> measures an AI system's ability to deliver comprehensive and accurate
responses. It assesses how thoroughly the response aligns with the key information, claims, and statements
established in the supplied <see cref="P:Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluatorContext.GroundTruth" />. It returns a
<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
indicating a poor score, and 5 indicating an excellent score.
</para>
<para>
<b>Note:</b>
<see cref="T:Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluator" /> is an AI-based evaluator that uses an AI model to perform its
evaluation. While the prompt that this evaluator uses to perform its evaluation is designed to be model-agnostic,
the performance of this prompt (and the resulting evaluation) can vary depending on the model used, and can be
especially poor when a smaller / local model is used.
</para>
<para>
The prompt that <see cref="T:Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluator" /> uses has been tested against (and tuned to work well with) the
following models. So, using this evaluator with a model from the following list is likely to produce the best
results. (The model to be used can be configured via <see cref="P:Microsoft.Extensions.AI.Evaluation.ChatConfiguration.ChatClient" />.)
</para>
<para>
<b>GPT-4o</b>
</para>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CompletenessEvaluator ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluator.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; CompletenessEvaluator();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI.Evaluation.Quality</AssemblyName>
<AssemblyVersion>9.4.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CompletenessMetricName">
<MemberSignature Language="C#" Value="public static string CompletenessMetricName { get; }" />
<MemberSignature Language="ILAsm" Value=".property string CompletenessMetricName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluator.CompletenessMetricName" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property CompletenessMetricName As String" />
<MemberSignature Language="F#" Value="static member CompletenessMetricName : string" Usage="Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluator.CompletenessMetricName" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; static property System::String ^ CompletenessMetricName { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI.Evaluation.Quality</AssemblyName>
<AssemblyVersion>9.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the <see cref="P:Microsoft.Extensions.AI.Evaluation.EvaluationMetric.Name" /> of the <see cref="T:Microsoft.Extensions.AI.Evaluation.NumericMetric" /> returned by
<see cref="T:Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluator" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EvaluateAsync">
<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);" />
<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" />
<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)" />
<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)" />
<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)" />
<MemberType>Method</MemberType>
<Implements>
<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>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI.Evaluation.Quality</AssemblyName>
<AssemblyVersion>9.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.ValueTask&lt;Microsoft.Extensions.AI.Evaluation.EvaluationResult&gt;</ReturnType>
<Attributes>
<Attribute FrameworkAlternate="net-10.0-pp">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })]</AttributeName>
<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })&gt;]</AttributeName>
</Attribute>
</Attributes>
</ReturnValue>
<Parameters>
<Parameter Name="messages" Type="System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.AI.ChatMessage&gt;" />
<Parameter Name="modelResponse" Type="Microsoft.Extensions.AI.ChatResponse" />
<Parameter Name="chatConfiguration" Type="Microsoft.Extensions.AI.Evaluation.ChatConfiguration">
<Attributes>
<Attribute FrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(2)&gt;]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
<Parameter Name="additionalContext" Type="System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.AI.Evaluation.EvaluationContext&gt;">
<Attributes>
<Attribute FrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })]</AttributeName>
<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })&gt;]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="messages">To be added.</param>
<param name="modelResponse">To be added.</param>
<param name="chatConfiguration">To be added.</param>
<param name="additionalContext">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="EvaluationMetricNames">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyCollection&lt;string&gt; EvaluationMetricNames { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyCollection`1&lt;string&gt; EvaluationMetricNames" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluator.EvaluationMetricNames" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property EvaluationMetricNames As IReadOnlyCollection(Of String)" />
<MemberSignature Language="F#" Value="member this.EvaluationMetricNames : System.Collections.Generic.IReadOnlyCollection&lt;string&gt;" Usage="Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluator.EvaluationMetricNames" />
<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(); };" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:Microsoft.Extensions.AI.Evaluation.IEvaluator.EvaluationMetricNames</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI.Evaluation.Quality</AssemblyName>
<AssemblyVersion>9.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IReadOnlyCollection&lt;System.String&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
</Type>
Loading
Loading