From 38b45e56dae3277d9e87bd4db960701d4dda18aa Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Tue, 28 Jan 2025 14:30:21 -0800 Subject: [PATCH 1/4] add some crefs to inheritdoc --- .../AdditionalPropertiesDictionary{TValue}.cs | 4 ++-- .../ChatCompletion/CachingChatClient.cs | 4 ++-- .../ChatCompletion/ConfigureOptionsChatClient.cs | 4 ++-- .../Embeddings/CachingEmbeddingGenerator.cs | 2 +- .../Embeddings/ConfigureOptionsEmbeddingGenerator.cs | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/Libraries/Microsoft.Extensions.AI.Abstractions/AdditionalPropertiesDictionary{TValue}.cs b/src/Libraries/Microsoft.Extensions.AI.Abstractions/AdditionalPropertiesDictionary{TValue}.cs index 0c8afb3ce06..1e503d13889 100644 --- a/src/Libraries/Microsoft.Extensions.AI.Abstractions/AdditionalPropertiesDictionary{TValue}.cs +++ b/src/Libraries/Microsoft.Extensions.AI.Abstractions/AdditionalPropertiesDictionary{TValue}.cs @@ -143,10 +143,10 @@ void ICollection>.CopyTo(KeyValuePair>.Remove(KeyValuePair item) => ((ICollection>)_dictionary).Remove(item); /// Attempts to extract a typed value from the dictionary. - /// Specifies the type of the value to be retrieved. + /// The type of the value to be retrieved. /// The key to locate. /// - /// The value retrieved from the dictionary, if found and successfully converted to the requested type; + /// When this method returns, contains he value retrieved from the dictionary, if found and successfully converted to the requested type; /// otherwise, the default value of . /// /// diff --git a/src/Libraries/Microsoft.Extensions.AI/ChatCompletion/CachingChatClient.cs b/src/Libraries/Microsoft.Extensions.AI/ChatCompletion/CachingChatClient.cs index f2de7f92fc8..72f1028afa5 100644 --- a/src/Libraries/Microsoft.Extensions.AI/ChatCompletion/CachingChatClient.cs +++ b/src/Libraries/Microsoft.Extensions.AI/ChatCompletion/CachingChatClient.cs @@ -44,7 +44,7 @@ protected CachingChatClient(IChatClient innerClient) /// public bool CoalesceStreamingUpdates { get; set; } = true; - /// + /// public override async Task CompleteAsync(IList chatMessages, ChatOptions? options = null, CancellationToken cancellationToken = default) { _ = Throw.IfNull(chatMessages); @@ -63,7 +63,7 @@ public override async Task CompleteAsync(IList chat return result; } - /// + /// public override async IAsyncEnumerable CompleteStreamingAsync( IList chatMessages, ChatOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default) { diff --git a/src/Libraries/Microsoft.Extensions.AI/ChatCompletion/ConfigureOptionsChatClient.cs b/src/Libraries/Microsoft.Extensions.AI/ChatCompletion/ConfigureOptionsChatClient.cs index ce2fe3ca29d..5f84226d846 100644 --- a/src/Libraries/Microsoft.Extensions.AI/ChatCompletion/ConfigureOptionsChatClient.cs +++ b/src/Libraries/Microsoft.Extensions.AI/ChatCompletion/ConfigureOptionsChatClient.cs @@ -33,13 +33,13 @@ public ConfigureOptionsChatClient(IChatClient innerClient, Action c _configureOptions = Throw.IfNull(configure); } - /// + /// public override async Task CompleteAsync(IList chatMessages, ChatOptions? options = null, CancellationToken cancellationToken = default) { return await base.CompleteAsync(chatMessages, Configure(options), cancellationToken).ConfigureAwait(false); } - /// + /// public override async IAsyncEnumerable CompleteStreamingAsync( IList chatMessages, ChatOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default) { diff --git a/src/Libraries/Microsoft.Extensions.AI/Embeddings/CachingEmbeddingGenerator.cs b/src/Libraries/Microsoft.Extensions.AI/Embeddings/CachingEmbeddingGenerator.cs index 688e4b2353d..44fa7384a9d 100644 --- a/src/Libraries/Microsoft.Extensions.AI/Embeddings/CachingEmbeddingGenerator.cs +++ b/src/Libraries/Microsoft.Extensions.AI/Embeddings/CachingEmbeddingGenerator.cs @@ -24,7 +24,7 @@ protected CachingEmbeddingGenerator(IEmbeddingGenerator inne { } - /// + /// public override async Task> GenerateAsync( IEnumerable values, EmbeddingGenerationOptions? options = null, CancellationToken cancellationToken = default) { diff --git a/src/Libraries/Microsoft.Extensions.AI/Embeddings/ConfigureOptionsEmbeddingGenerator.cs b/src/Libraries/Microsoft.Extensions.AI/Embeddings/ConfigureOptionsEmbeddingGenerator.cs index 8332064f22a..f3da95d00f7 100644 --- a/src/Libraries/Microsoft.Extensions.AI/Embeddings/ConfigureOptionsEmbeddingGenerator.cs +++ b/src/Libraries/Microsoft.Extensions.AI/Embeddings/ConfigureOptionsEmbeddingGenerator.cs @@ -40,7 +40,7 @@ public ConfigureOptionsEmbeddingGenerator( _configureOptions = Throw.IfNull(configure); } - /// + /// public override async Task> GenerateAsync( IEnumerable values, EmbeddingGenerationOptions? options = null, From 758903d46bc87fcdf3634aac4f742782e87a09f5 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Tue, 28 Jan 2025 14:45:40 -0800 Subject: [PATCH 2/4] be more specific --- .../ChatCompletion/CachingChatClient.cs | 4 ++-- .../ChatCompletion/ConfigureOptionsChatClient.cs | 4 ++-- .../Embeddings/CachingEmbeddingGenerator.cs | 2 +- .../Embeddings/ConfigureOptionsEmbeddingGenerator.cs | 2 +- .../Microsoft.Extensions.Hosting.Testing/FakeHostOptions.cs | 4 ++-- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/Libraries/Microsoft.Extensions.AI/ChatCompletion/CachingChatClient.cs b/src/Libraries/Microsoft.Extensions.AI/ChatCompletion/CachingChatClient.cs index 72f1028afa5..81718480505 100644 --- a/src/Libraries/Microsoft.Extensions.AI/ChatCompletion/CachingChatClient.cs +++ b/src/Libraries/Microsoft.Extensions.AI/ChatCompletion/CachingChatClient.cs @@ -44,7 +44,7 @@ protected CachingChatClient(IChatClient innerClient) /// public bool CoalesceStreamingUpdates { get; set; } = true; - /// + /// public override async Task CompleteAsync(IList chatMessages, ChatOptions? options = null, CancellationToken cancellationToken = default) { _ = Throw.IfNull(chatMessages); @@ -63,7 +63,7 @@ public override async Task CompleteAsync(IList chat return result; } - /// + /// public override async IAsyncEnumerable CompleteStreamingAsync( IList chatMessages, ChatOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default) { diff --git a/src/Libraries/Microsoft.Extensions.AI/ChatCompletion/ConfigureOptionsChatClient.cs b/src/Libraries/Microsoft.Extensions.AI/ChatCompletion/ConfigureOptionsChatClient.cs index 5f84226d846..2761f303fb1 100644 --- a/src/Libraries/Microsoft.Extensions.AI/ChatCompletion/ConfigureOptionsChatClient.cs +++ b/src/Libraries/Microsoft.Extensions.AI/ChatCompletion/ConfigureOptionsChatClient.cs @@ -33,13 +33,13 @@ public ConfigureOptionsChatClient(IChatClient innerClient, Action c _configureOptions = Throw.IfNull(configure); } - /// + /// public override async Task CompleteAsync(IList chatMessages, ChatOptions? options = null, CancellationToken cancellationToken = default) { return await base.CompleteAsync(chatMessages, Configure(options), cancellationToken).ConfigureAwait(false); } - /// + /// public override async IAsyncEnumerable CompleteStreamingAsync( IList chatMessages, ChatOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default) { diff --git a/src/Libraries/Microsoft.Extensions.AI/Embeddings/CachingEmbeddingGenerator.cs b/src/Libraries/Microsoft.Extensions.AI/Embeddings/CachingEmbeddingGenerator.cs index 44fa7384a9d..c4437a06c36 100644 --- a/src/Libraries/Microsoft.Extensions.AI/Embeddings/CachingEmbeddingGenerator.cs +++ b/src/Libraries/Microsoft.Extensions.AI/Embeddings/CachingEmbeddingGenerator.cs @@ -24,7 +24,7 @@ protected CachingEmbeddingGenerator(IEmbeddingGenerator inne { } - /// + /// public override async Task> GenerateAsync( IEnumerable values, EmbeddingGenerationOptions? options = null, CancellationToken cancellationToken = default) { diff --git a/src/Libraries/Microsoft.Extensions.AI/Embeddings/ConfigureOptionsEmbeddingGenerator.cs b/src/Libraries/Microsoft.Extensions.AI/Embeddings/ConfigureOptionsEmbeddingGenerator.cs index f3da95d00f7..693ae3c8b12 100644 --- a/src/Libraries/Microsoft.Extensions.AI/Embeddings/ConfigureOptionsEmbeddingGenerator.cs +++ b/src/Libraries/Microsoft.Extensions.AI/Embeddings/ConfigureOptionsEmbeddingGenerator.cs @@ -40,7 +40,7 @@ public ConfigureOptionsEmbeddingGenerator( _configureOptions = Throw.IfNull(configure); } - /// + /// public override async Task> GenerateAsync( IEnumerable values, EmbeddingGenerationOptions? options = null, diff --git a/src/Libraries/Microsoft.Extensions.Hosting.Testing/FakeHostOptions.cs b/src/Libraries/Microsoft.Extensions.Hosting.Testing/FakeHostOptions.cs index 345d604f5cd..7080cae5bea 100644 --- a/src/Libraries/Microsoft.Extensions.Hosting.Testing/FakeHostOptions.cs +++ b/src/Libraries/Microsoft.Extensions.Hosting.Testing/FakeHostOptions.cs @@ -43,10 +43,10 @@ public class FakeHostOptions /// public bool FakeLogging { get; set; } = true; - /// + /// public bool ValidateScopes { get; set; } = true; - /// + /// public bool ValidateOnBuild { get; set; } = true; /// From 935127a11909d5ea434e26012b2b8d9949aa70a2 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Tue, 28 Jan 2025 14:49:36 -0800 Subject: [PATCH 3/4] typo --- .../AdditionalPropertiesDictionary{TValue}.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Libraries/Microsoft.Extensions.AI.Abstractions/AdditionalPropertiesDictionary{TValue}.cs b/src/Libraries/Microsoft.Extensions.AI.Abstractions/AdditionalPropertiesDictionary{TValue}.cs index 1e503d13889..21d1daf2820 100644 --- a/src/Libraries/Microsoft.Extensions.AI.Abstractions/AdditionalPropertiesDictionary{TValue}.cs +++ b/src/Libraries/Microsoft.Extensions.AI.Abstractions/AdditionalPropertiesDictionary{TValue}.cs @@ -146,7 +146,7 @@ void ICollection>.CopyTo(KeyValuePairThe type of the value to be retrieved. /// The key to locate. /// - /// When this method returns, contains he value retrieved from the dictionary, if found and successfully converted to the requested type; + /// When this method returns, contains the value retrieved from the dictionary, if found and successfully converted to the requested type; /// otherwise, the default value of . /// /// From 5dcf864c6e188564e5bed6ccf01d8d4535696276 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Tue, 28 Jan 2025 19:13:38 -0800 Subject: [PATCH 4/4] reset some files; fix platform bug instead --- .../ChatCompletion/CachingChatClient.cs | 4 ++-- .../ChatCompletion/ConfigureOptionsChatClient.cs | 4 ++-- .../Embeddings/CachingEmbeddingGenerator.cs | 2 +- .../Embeddings/ConfigureOptionsEmbeddingGenerator.cs | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/Libraries/Microsoft.Extensions.AI/ChatCompletion/CachingChatClient.cs b/src/Libraries/Microsoft.Extensions.AI/ChatCompletion/CachingChatClient.cs index 81718480505..f2de7f92fc8 100644 --- a/src/Libraries/Microsoft.Extensions.AI/ChatCompletion/CachingChatClient.cs +++ b/src/Libraries/Microsoft.Extensions.AI/ChatCompletion/CachingChatClient.cs @@ -44,7 +44,7 @@ protected CachingChatClient(IChatClient innerClient) /// public bool CoalesceStreamingUpdates { get; set; } = true; - /// + /// public override async Task CompleteAsync(IList chatMessages, ChatOptions? options = null, CancellationToken cancellationToken = default) { _ = Throw.IfNull(chatMessages); @@ -63,7 +63,7 @@ public override async Task CompleteAsync(IList chat return result; } - /// + /// public override async IAsyncEnumerable CompleteStreamingAsync( IList chatMessages, ChatOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default) { diff --git a/src/Libraries/Microsoft.Extensions.AI/ChatCompletion/ConfigureOptionsChatClient.cs b/src/Libraries/Microsoft.Extensions.AI/ChatCompletion/ConfigureOptionsChatClient.cs index 2761f303fb1..ce2fe3ca29d 100644 --- a/src/Libraries/Microsoft.Extensions.AI/ChatCompletion/ConfigureOptionsChatClient.cs +++ b/src/Libraries/Microsoft.Extensions.AI/ChatCompletion/ConfigureOptionsChatClient.cs @@ -33,13 +33,13 @@ public ConfigureOptionsChatClient(IChatClient innerClient, Action c _configureOptions = Throw.IfNull(configure); } - /// + /// public override async Task CompleteAsync(IList chatMessages, ChatOptions? options = null, CancellationToken cancellationToken = default) { return await base.CompleteAsync(chatMessages, Configure(options), cancellationToken).ConfigureAwait(false); } - /// + /// public override async IAsyncEnumerable CompleteStreamingAsync( IList chatMessages, ChatOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default) { diff --git a/src/Libraries/Microsoft.Extensions.AI/Embeddings/CachingEmbeddingGenerator.cs b/src/Libraries/Microsoft.Extensions.AI/Embeddings/CachingEmbeddingGenerator.cs index c4437a06c36..688e4b2353d 100644 --- a/src/Libraries/Microsoft.Extensions.AI/Embeddings/CachingEmbeddingGenerator.cs +++ b/src/Libraries/Microsoft.Extensions.AI/Embeddings/CachingEmbeddingGenerator.cs @@ -24,7 +24,7 @@ protected CachingEmbeddingGenerator(IEmbeddingGenerator inne { } - /// + /// public override async Task> GenerateAsync( IEnumerable values, EmbeddingGenerationOptions? options = null, CancellationToken cancellationToken = default) { diff --git a/src/Libraries/Microsoft.Extensions.AI/Embeddings/ConfigureOptionsEmbeddingGenerator.cs b/src/Libraries/Microsoft.Extensions.AI/Embeddings/ConfigureOptionsEmbeddingGenerator.cs index 693ae3c8b12..8332064f22a 100644 --- a/src/Libraries/Microsoft.Extensions.AI/Embeddings/ConfigureOptionsEmbeddingGenerator.cs +++ b/src/Libraries/Microsoft.Extensions.AI/Embeddings/ConfigureOptionsEmbeddingGenerator.cs @@ -40,7 +40,7 @@ public ConfigureOptionsEmbeddingGenerator( _configureOptions = Throw.IfNull(configure); } - /// + /// public override async Task> GenerateAsync( IEnumerable values, EmbeddingGenerationOptions? options = null,