Skip to content

Commit ef37065

Browse files
authoredMar 25, 2025··
Add "see also" links to conceptual docs (#6177)
1 parent db9ae66 commit ef37065

File tree

10 files changed

+16
-2
lines changed

10 files changed

+16
-2
lines changed
 

‎src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatCompletion/ChatMessage.cs

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
namespace Microsoft.Extensions.AI;
1111

1212
/// <summary>Represents a chat message used by an <see cref="IChatClient" />.</summary>
13+
/// <related type="Article" href="https://learn.microsoft.com/dotnet/ai/quickstarts/build-chat-app">Build an AI chat app with .NET.</related>
1314
[DebuggerDisplay("[{Role}] {ContentForDebuggerDisplay}{EllipsesForDebuggerDisplay,nq}")]
1415
public class ChatMessage
1516
{

‎src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatCompletion/IChatClient.cs

+1
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ namespace Microsoft.Extensions.AI;
2323
/// provided with a callback that could mutate the supplied options argument, and that should be avoided if using a singleton options instance.
2424
/// </para>
2525
/// </remarks>
26+
/// <related type="Article" href="https://learn.microsoft.com/dotnet/ai/quickstarts/build-chat-app">Build an AI chat app with .NET.</related>
2627
public interface IChatClient : IDisposable
2728
{
2829
/// <summary>Sends chat messages and returns the response.</summary>

‎src/Libraries/Microsoft.Extensions.AI.Evaluation.Quality/CoherenceEvaluator.cs

+1
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ namespace Microsoft.Extensions.AI.Evaluation.Quality;
3131
/// <b>GPT-4o</b>
3232
/// </para>
3333
/// </remarks>
34+
/// <related type="Article" href="https://learn.microsoft.com/dotnet/ai/quickstarts/evaluate-ai-response">Evaluate a model's response.</related>
3435
public sealed class CoherenceEvaluator : SingleNumericMetricEvaluator
3536
{
3637
/// <summary>

‎src/Libraries/Microsoft.Extensions.AI.Evaluation.Quality/RelevanceTruthAndCompletenessEvaluator.cs

+1
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ namespace Microsoft.Extensions.AI.Evaluation.Quality;
4242
/// <b>GPT-4o</b>
4343
/// </para>
4444
/// </remarks>
45+
/// <related type="Article" href="https://learn.microsoft.com/dotnet/ai/tutorials/evaluate-with-reporting">Tutorial: Evaluate a model's response with response caching and reporting.</related>
4546
public sealed partial class RelevanceTruthAndCompletenessEvaluator : ChatConversationEvaluator
4647
{
4748
/// <summary>

‎src/Libraries/Microsoft.Extensions.AI.Evaluation.Reporting/CSharp/ReportingConfiguration.cs

+2
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ namespace Microsoft.Extensions.AI.Evaluation.Reporting;
1616
/// used by these <see cref="IEvaluator"/>s, how the resulting <see cref="ScenarioRunResult"/>s should be persisted,
1717
/// and how AI responses should be cached.
1818
/// </summary>
19+
/// <related type="Article" href="https://learn.microsoft.com/dotnet/ai/tutorials/evaluate-with-reporting">Tutorial: Evaluate a model's response with response caching and reporting.</related>
1920
public sealed class ReportingConfiguration
2021
{
2122
/// <summary>
@@ -162,6 +163,7 @@ public ReportingConfiguration(
162163
/// A new <see cref="ScenarioRun"/> with the specified <paramref name="scenarioName"/> and
163164
/// <paramref name="iterationName"/>.
164165
/// </returns>
166+
/// <related type="Article" href="https://learn.microsoft.com/dotnet/ai/tutorials/evaluate-with-reporting">Tutorial: Evaluate a model's response with response caching and reporting.</related>
165167
public async ValueTask<ScenarioRun> CreateScenarioRunAsync(
166168
string scenarioName,
167169
string iterationName = Defaults.DefaultIterationName,

‎src/Libraries/Microsoft.Extensions.AI.Evaluation.Reporting/CSharp/ScenarioRun.cs

+3
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ namespace Microsoft.Extensions.AI.Evaluation.Reporting;
1616
/// can contain evaluations for multiple scenarios each with a unique <see cref="ScenarioName"/>. The execution of each
1717
/// such scenario in turn can include multiple iterations each with a unique <see cref="IterationName"/>.
1818
/// </remarks>
19+
/// <related type="Article" href="https://learn.microsoft.com/dotnet/ai/tutorials/evaluate-with-reporting">Tutorial: Evaluate a model's response with response caching and reporting.</related>
1920
public sealed class ScenarioRun : IAsyncDisposable
2021
{
2122
/// <summary>
@@ -31,6 +32,7 @@ public sealed class ScenarioRun : IAsyncDisposable
3132
/// suite can be set to the fully qualified name of the corresponding unit test.
3233
/// </para>
3334
/// </remarks>
35+
/// <related type="Article" href="https://learn.microsoft.com/dotnet/ai/tutorials/evaluate-with-reporting">Tutorial: Evaluate a model's response with response caching and reporting.</related>
3436
public string ScenarioName { get; }
3537

3638
/// <summary>
@@ -73,6 +75,7 @@ public sealed class ScenarioRun : IAsyncDisposable
7375
/// the new execution.
7476
/// </para>
7577
/// </remarks>
78+
/// <related type="Article" href="https://learn.microsoft.com/dotnet/ai/tutorials/evaluate-with-reporting">Tutorial: Evaluate a model's response with response caching and reporting.</related>
7679
public string ExecutionName { get; }
7780

7881
/// <summary>

‎src/Libraries/Microsoft.Extensions.AI.Evaluation/EvaluationResult.cs

+3-2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ namespace Microsoft.Extensions.AI.Evaluation;
1111
/// <summary>
1212
/// A collection of one or more <see cref="EvaluationMetric"/>s that represent the result of an evaluation.
1313
/// </summary>
14+
/// <related type="Article" href="https://learn.microsoft.com/dotnet/ai/quickstarts/evaluate-ai-response">Evaluate a model's response.</related>
1415
public sealed class EvaluationResult
1516
{
1617
/// <summary>
@@ -88,7 +89,7 @@ public EvaluationResult(params EvaluationMetric[] metrics)
8889
/// <summary>
8990
/// Returns an <see cref="EvaluationMetric"/> with type <typeparamref name="T"/> and with the
9091
/// <see cref="EvaluationMetric.Name"/> specified via <paramref name="metricName"/> if it exists in
91-
/// <see cref="Metrics"/>.
92+
/// <see cref="Metrics"/>.
9293
/// </summary>
9394
/// <typeparam name="T">The type of the <see cref="EvaluationMetric"/> to be returned.</typeparam>
9495
/// <param name="metricName">
@@ -119,7 +120,7 @@ public bool TryGet<T>(string metricName, [NotNullWhen(true)] out T? value)
119120
/// <summary>
120121
/// Returns an <see cref="EvaluationMetric"/> with type <typeparamref name="T"/> and with the
121122
/// <see cref="EvaluationMetric.Name"/> specified via <paramref name="metricName"/> if it exists in
122-
/// <see cref="Metrics"/>.
123+
/// <see cref="Metrics"/>.
123124
/// </summary>
124125
/// <typeparam name="T">The type of the <see cref="EvaluationMetric"/> to be returned.</typeparam>
125126
/// <param name="metricName">

‎src/Libraries/Microsoft.Extensions.AI.Evaluation/IEvaluator.cs

+2
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ namespace Microsoft.Extensions.AI.Evaluation;
1010
/// <summary>
1111
/// Evaluates responses produced by an AI model.
1212
/// </summary>
13+
/// <related type="Article" href="https://learn.microsoft.com/dotnet/ai/quickstarts/evaluate-ai-response">Evaluate a model's response.</related>
1314
public interface IEvaluator
1415
{
1516
/// <summary>
@@ -48,6 +49,7 @@ public interface IEvaluator
4849
/// A <see cref="CancellationToken"/> that can cancel the evaluation operation.
4950
/// </param>
5051
/// <returns>An <see cref="EvaluationResult"/> containing one or more <see cref="EvaluationMetric"/>s.</returns>
52+
/// <related type="Article" href="https://learn.microsoft.com/dotnet/ai/quickstarts/evaluate-ai-response">Evaluate a model's response.</related>
5153
ValueTask<EvaluationResult> EvaluateAsync(
5254
IEnumerable<ChatMessage> messages,
5355
ChatResponse modelResponse,

‎src/Libraries/Microsoft.Extensions.AI.Evaluation/NumericMetric.cs

+1
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,6 @@ namespace Microsoft.Extensions.AI.Evaluation;
2424
/// An optional string that can be used to provide some commentary around the result represented by this
2525
/// <see cref="NumericMetric"/>.
2626
/// </param>
27+
/// <related type="Article" href="https://learn.microsoft.com/dotnet/ai/quickstarts/evaluate-ai-response">Evaluate a model's response.</related>
2728
public sealed class NumericMetric(string name, double? value = null, string? reason = null)
2829
: EvaluationMetric<double?>(name, value, reason);

‎src/Libraries/Microsoft.Extensions.AI/Functions/AIFunctionFactory.cs

+1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
namespace Microsoft.Extensions.AI;
2828

2929
/// <summary>Provides factory methods for creating commonly used implementations of <see cref="AIFunction"/>.</summary>
30+
/// <related type="Article" href="https://learn.microsoft.com/dotnet/ai/quickstarts/use-function-calling">Invoke .NET functions using an AI model.</related>
3031
public static partial class AIFunctionFactory
3132
{
3233
/// <summary>Holds the default options instance used when creating function.</summary>

0 commit comments

Comments
 (0)
Please sign in to comment.