Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,11 @@
</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<Docs>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Extensions.AI.Evaluation.NLP.BLEUEvaluatorContext" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public BLEUEvaluatorContext (System.Collections.Generic.IEnumerable&lt;string&gt; references);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Collections.Generic.IEnumerable`1&lt;string&gt; references) cil managed" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,11 @@
</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<Docs>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Extensions.AI.Evaluation.NLP.GLEUEvaluatorContext" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public GLEUEvaluatorContext (System.Collections.Generic.IEnumerable&lt;string&gt; references);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Collections.Generic.IEnumerable`1&lt;string&gt; references) cil managed" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,11 @@
</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<Docs>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Extensions.AI.Evaluation.Quality.IntentResolutionEvaluatorContext" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IntentResolutionEvaluatorContext (params Microsoft.Extensions.AI.AITool[] toolDefinitions);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Extensions.AI.AITool[] toolDefinitions) cil managed" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,11 @@
</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<Docs>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Extensions.AI.Evaluation.Quality.RetrievalEvaluatorContext" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RetrievalEvaluatorContext (System.Collections.Generic.IEnumerable&lt;string&gt; retrievedContextChunks);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Collections.Generic.IEnumerable`1&lt;string&gt; retrievedContextChunks) cil managed" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,11 @@
</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<Docs>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Extensions.AI.Evaluation.Quality.TaskAdherenceEvaluatorContext" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TaskAdherenceEvaluatorContext (params Microsoft.Extensions.AI.AITool[] toolDefinitions);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Extensions.AI.AITool[] toolDefinitions) cil managed" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,11 @@
</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<Docs>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Extensions.AI.Evaluation.Quality.ToolCallAccuracyEvaluatorContext" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ToolCallAccuracyEvaluatorContext (params Microsoft.Extensions.AI.AITool[] toolDefinitions);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Extensions.AI.AITool[] toolDefinitions) cil managed" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,11 @@
<remarks>To be added.</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<Docs>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Extensions.AI.Evaluation.Reporting.ChatDetails" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ChatDetails (params Microsoft.Extensions.AI.Evaluation.Reporting.ChatTurnDetails[] turnDetails);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Extensions.AI.Evaluation.Reporting.ChatTurnDetails[] turnDetails) cil managed" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,12 @@
<remarks>To be added.</remarks>
</Docs>
<Members>
<MemberGroup MemberName="AddTurnDetails">
<Docs>
<summary>Adds <see cref="T:Microsoft.Extensions.AI.Evaluation.Reporting.ChatTurnDetails" /> for one or more LLM chat conversation turns to the
<see cref="P:Microsoft.Extensions.AI.Evaluation.Reporting.ChatDetails.TurnDetails" /> collection.</summary>
</Docs>
</MemberGroup>
<Member MemberName="AddTurnDetails">
<MemberSignature Language="C#" Value="public static void AddTurnDetails (this Microsoft.Extensions.AI.Evaluation.Reporting.ChatDetails chatDetails, params Microsoft.Extensions.AI.Evaluation.Reporting.ChatTurnDetails[] turnDetails);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void AddTurnDetails(class Microsoft.Extensions.AI.Evaluation.Reporting.ChatDetails chatDetails, class Microsoft.Extensions.AI.Evaluation.Reporting.ChatTurnDetails[] turnDetails) cil managed" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,11 @@
<remarks>To be added.</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<Docs>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Extensions.AI.Evaluation.Reporting.ChatTurnDetails" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ChatTurnDetails (TimeSpan latency, string? model = default, Microsoft.Extensions.AI.UsageDetails? usage = default, string? cacheKey = default, bool? cacheHit = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.TimeSpan latency, string model, class Microsoft.Extensions.AI.UsageDetails usage, string cacheKey, valuetype System.Nullable`1&lt;bool&gt; cacheHit) cil managed" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,12 @@
<remarks>To be added.</remarks>
</Docs>
<Members>
<MemberGroup MemberName="EvaluateAsync">
<Docs>
<summary>Evaluates the supplied <paramref name="modelResponse" /> and returns an <see cref="T:Microsoft.Extensions.AI.Evaluation.EvaluationResult" />
containing one or more <see cref="T:Microsoft.Extensions.AI.Evaluation.EvaluationMetric" />s.</summary>
</Docs>
</MemberGroup>
<Member MemberName="EvaluateAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.ValueTask&lt;Microsoft.Extensions.AI.Evaluation.EvaluationResult&gt; EvaluateAsync (this Microsoft.Extensions.AI.Evaluation.Reporting.ScenarioRun scenarioRun, Microsoft.Extensions.AI.ChatMessage modelResponse, System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.AI.Evaluation.EvaluationContext&gt;? additionalContext = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype System.Threading.Tasks.ValueTask`1&lt;class Microsoft.Extensions.AI.Evaluation.EvaluationResult&gt; EvaluateAsync(class Microsoft.Extensions.AI.Evaluation.Reporting.ScenarioRun scenarioRun, class Microsoft.Extensions.AI.ChatMessage modelResponse, class System.Collections.Generic.IEnumerable`1&lt;class Microsoft.Extensions.AI.Evaluation.EvaluationContext&gt; additionalContext, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,11 @@
</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<Docs>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Extensions.AI.Evaluation.Reporting.ScenarioRunResult" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ScenarioRunResult (string scenarioName, string iterationName, string executionName, DateTime creationTime, System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.AI.ChatMessage&gt; messages, Microsoft.Extensions.AI.ChatResponse modelResponse, Microsoft.Extensions.AI.Evaluation.EvaluationResult evaluationResult, Microsoft.Extensions.AI.Evaluation.Reporting.ChatDetails? chatDetails = default, System.Collections.Generic.IEnumerable&lt;string&gt;? tags = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string scenarioName, string iterationName, string executionName, valuetype System.DateTime creationTime, 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.EvaluationResult evaluationResult, class Microsoft.Extensions.AI.Evaluation.Reporting.ChatDetails chatDetails, class System.Collections.Generic.IEnumerable`1&lt;string&gt; tags) cil managed" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,11 @@
</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<Docs>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Extensions.AI.Evaluation.Safety.ContentSafetyServiceConfiguration" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ContentSafetyServiceConfiguration (Azure.Core.TokenCredential credential, string endpointUrl, System.Net.Http.HttpClient? httpClient = default, int timeoutInSecondsForRetries = 300);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Azure.Core.TokenCredential credential, string endpointUrl, class System.Net.Http.HttpClient httpClient, int32 timeoutInSecondsForRetries) cil managed" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,12 @@
<remarks>To be added.</remarks>
</Docs>
<Members>
<MemberGroup MemberName="ToChatConfiguration">
<Docs>
<summary>Returns a <see cref="T:Microsoft.Extensions.AI.Evaluation.ChatConfiguration" /> that can be used to communicate with the Azure AI Foundry Evaluation
service for performing content safety evaluations.</summary>
</Docs>
</MemberGroup>
<Member MemberName="ToChatConfiguration">
<MemberSignature Language="C#" Value="public static Microsoft.Extensions.AI.Evaluation.ChatConfiguration ToChatConfiguration (this Microsoft.Extensions.AI.Evaluation.Safety.ContentSafetyServiceConfiguration contentSafetyServiceConfiguration, Microsoft.Extensions.AI.Evaluation.ChatConfiguration? originalChatConfiguration = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Extensions.AI.Evaluation.ChatConfiguration ToChatConfiguration(class Microsoft.Extensions.AI.Evaluation.Safety.ContentSafetyServiceConfiguration contentSafetyServiceConfiguration, class Microsoft.Extensions.AI.Evaluation.ChatConfiguration originalChatConfiguration) cil managed" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,13 @@
<remarks>To be added.</remarks>
</Docs>
<Members>
<MemberGroup MemberName="RenderText">
<Docs>
<summary>Renders the supplied <paramref name="message" /> to a <see langword="string" />. The returned
<see langword="string" /> can be used as part of constructing an evaluation prompt to evaluate a conversation
that includes the supplied <paramref name="message" />.</summary>
</Docs>
</MemberGroup>
<Member MemberName="RenderText">
<MemberSignature Language="C#" Value="public static string RenderText (this Microsoft.Extensions.AI.ChatMessage message);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig string RenderText(class Microsoft.Extensions.AI.ChatMessage message) cil managed" />
Expand Down Expand Up @@ -121,6 +128,11 @@
</remarks>
</Docs>
</Member>
<MemberGroup MemberName="TryGetUserRequest">
<Docs>
<summary>Tries to get the last user request message from the supplied collection of <paramref name="messages" />.</summary>
</Docs>
</MemberGroup>
<Member MemberName="TryGetUserRequest">
<MemberSignature Language="C#" Value="public static bool TryGetUserRequest (this System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.AI.ChatMessage&gt; messages, out Microsoft.Extensions.AI.ChatMessage? userRequest);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool TryGetUserRequest(class System.Collections.Generic.IEnumerable`1&lt;class Microsoft.Extensions.AI.ChatMessage&gt; messages, [out] class Microsoft.Extensions.AI.ChatMessage&amp; userRequest) cil managed" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,11 @@
<remarks>To be added.</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<Docs>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Extensions.AI.Evaluation.CompositeEvaluator" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CompositeEvaluator (params Microsoft.Extensions.AI.Evaluation.IEvaluator[] evaluators);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Extensions.AI.Evaluation.IEvaluator[] evaluators) cil managed" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,11 @@
</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<Docs>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Extensions.AI.Evaluation.EvaluationContext" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected EvaluationContext (string name, params Microsoft.Extensions.AI.AIContent[] contents);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(string name, class Microsoft.Extensions.AI.AIContent[] contents) cil managed" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,12 @@
<remarks>To be added.</remarks>
</Docs>
<Members>
<MemberGroup MemberName="AddDiagnostics">
<Docs>
<summary>Adds the supplied <see cref="T:Microsoft.Extensions.AI.Evaluation.EvaluationDiagnostic" />s to the supplied <see cref="T:Microsoft.Extensions.AI.Evaluation.EvaluationMetric" />'s
<see cref="P:Microsoft.Extensions.AI.Evaluation.EvaluationMetric.Diagnostics" /> collection.</summary>
</Docs>
</MemberGroup>
<Member MemberName="AddDiagnostics">
<MemberSignature Language="C#" Value="public static void AddDiagnostics (this Microsoft.Extensions.AI.Evaluation.EvaluationMetric metric, params Microsoft.Extensions.AI.Evaluation.EvaluationDiagnostic[] diagnostics);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void AddDiagnostics(class Microsoft.Extensions.AI.Evaluation.EvaluationMetric metric, class Microsoft.Extensions.AI.Evaluation.EvaluationDiagnostic[] diagnostics) cil managed" />
Expand Down Expand Up @@ -139,6 +145,12 @@
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberGroup MemberName="AddOrUpdateContext">
<Docs>
<summary>Adds or updates the supplied <paramref name="context" /> objects in the supplied <paramref name="metric" />'s
<see cref="P:Microsoft.Extensions.AI.Evaluation.EvaluationMetric.Context" /> dictionary.</summary>
</Docs>
</MemberGroup>
<Member MemberName="AddOrUpdateContext">
<MemberSignature Language="C#" Value="public static void AddOrUpdateContext (this Microsoft.Extensions.AI.Evaluation.EvaluationMetric metric, params Microsoft.Extensions.AI.Evaluation.EvaluationContext[] context);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void AddOrUpdateContext(class Microsoft.Extensions.AI.Evaluation.EvaluationMetric metric, class Microsoft.Extensions.AI.Evaluation.EvaluationContext[] context) cil managed" />
Expand Down Expand Up @@ -235,6 +247,12 @@
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberGroup MemberName="AddOrUpdateMetadata">
<Docs>
<summary>Adds or updates the supplied <paramref name="metadata" /> in the supplied <paramref name="metric" />'s
<see cref="P:Microsoft.Extensions.AI.Evaluation.EvaluationMetric.Metadata" /> dictionary.</summary>
</Docs>
</MemberGroup>
<Member MemberName="AddOrUpdateMetadata">
<MemberSignature Language="C#" Value="public static void AddOrUpdateMetadata (this Microsoft.Extensions.AI.Evaluation.EvaluationMetric metric, System.Collections.Generic.IDictionary&lt;string,string&gt; metadata);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void AddOrUpdateMetadata(class Microsoft.Extensions.AI.Evaluation.EvaluationMetric metric, class System.Collections.Generic.IDictionary`2&lt;string, string&gt; metadata) cil managed" />
Expand Down
5 changes: 5 additions & 0 deletions xml/Microsoft.Extensions.AI.Evaluation/EvaluationResult.xml
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@
</related>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<Docs>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Extensions.AI.Evaluation.EvaluationResult" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EvaluationResult (params Microsoft.Extensions.AI.Evaluation.EvaluationMetric[] metrics);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Extensions.AI.Evaluation.EvaluationMetric[] metrics) cil managed" />
Expand Down
Loading
Loading