From d39bf3dfecf2df69676e0ee6678dd606b234c2c8 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Wed, 13 Nov 2024 21:06:04 -0800 Subject: [PATCH] docs updates (#5643) --- .../AdditionalPropertiesDictionary.cs | 4 ++-- .../ChatCompletion/ChatOptions.cs | 2 +- .../ConfigureOptionsChatClientBuilderExtensions.cs | 4 ++-- .../Embeddings/ConfigureOptionsEmbeddingGenerator.cs | 6 +++--- .../ConfigureOptionsEmbeddingGeneratorBuilderExtensions.cs | 4 ++-- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/src/Libraries/Microsoft.Extensions.AI.Abstractions/AdditionalPropertiesDictionary.cs b/src/Libraries/Microsoft.Extensions.AI.Abstractions/AdditionalPropertiesDictionary.cs index 4a681d4679..8b8d69896b 100644 --- a/src/Libraries/Microsoft.Extensions.AI.Abstractions/AdditionalPropertiesDictionary.cs +++ b/src/Libraries/Microsoft.Extensions.AI.Abstractions/AdditionalPropertiesDictionary.cs @@ -153,8 +153,8 @@ public sealed class AdditionalPropertiesDictionary : IDictionary. /// /// - /// If a non- is found for the key in the dictionary, but the value is not of the requested type but is - /// an object, the method will attempt to convert the object to the requested type. + /// If a non- value is found for the key in the dictionary, but the value is not of the requested type and is + /// an object, the method attempts to convert the object to the requested type. /// public bool TryGetValue(string key, [NotNullWhen(true)] out T? value) { diff --git a/src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatCompletion/ChatOptions.cs b/src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatCompletion/ChatOptions.cs index 63ccb69031..f3d3621aa6 100644 --- a/src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatCompletion/ChatOptions.cs +++ b/src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatCompletion/ChatOptions.cs @@ -27,7 +27,7 @@ public class ChatOptions /// Gets or sets the presence penalty for generating chat responses. public float? PresencePenalty { get; set; } - /// Gets or sets a seed value used by a service to control the reproducability of results. + /// Gets or sets a seed value used by a service to control the reproducibility of results. public long? Seed { get; set; } /// diff --git a/src/Libraries/Microsoft.Extensions.AI/ChatCompletion/ConfigureOptionsChatClientBuilderExtensions.cs b/src/Libraries/Microsoft.Extensions.AI/ChatCompletion/ConfigureOptionsChatClientBuilderExtensions.cs index 5c160794a9..ea990d09a8 100644 --- a/src/Libraries/Microsoft.Extensions.AI/ChatCompletion/ConfigureOptionsChatClientBuilderExtensions.cs +++ b/src/Libraries/Microsoft.Extensions.AI/ChatCompletion/ConfigureOptionsChatClientBuilderExtensions.cs @@ -20,8 +20,8 @@ public static class ConfigureOptionsChatClientBuilderExtensions /// It is passed a clone of the caller-supplied instance (or a newly constructed instance if the caller-supplied instance is ). /// /// - /// This can be used to set default options. The delegate is passed either a new instance of - /// if the caller didn't supply a instance, or a clone (via + /// This method can be used to set default options. The delegate is passed either a new instance of + /// if the caller didn't supply a instance, or a clone (via ) /// of the caller-supplied instance if one was supplied. /// /// The . diff --git a/src/Libraries/Microsoft.Extensions.AI/Embeddings/ConfigureOptionsEmbeddingGenerator.cs b/src/Libraries/Microsoft.Extensions.AI/Embeddings/ConfigureOptionsEmbeddingGenerator.cs index c956a0bfe9..8332064f22 100644 --- a/src/Libraries/Microsoft.Extensions.AI/Embeddings/ConfigureOptionsEmbeddingGenerator.cs +++ b/src/Libraries/Microsoft.Extensions.AI/Embeddings/ConfigureOptionsEmbeddingGenerator.cs @@ -9,9 +9,9 @@ using Microsoft.Shared.Diagnostics; namespace Microsoft.Extensions.AI; -/// A delegating embedding generator that configures a instance used by the remainder of the pipeline. -/// Specifies the type of the input passed to the generator. -/// Specifies the type of the embedding instance produced by the generator. +/// Represents a delegating embedding generator that configures a instance used by the remainder of the pipeline. +/// The type of the input passed to the generator. +/// The type of the embedding instance produced by the generator. public sealed class ConfigureOptionsEmbeddingGenerator : DelegatingEmbeddingGenerator where TEmbedding : Embedding { diff --git a/src/Libraries/Microsoft.Extensions.AI/Embeddings/ConfigureOptionsEmbeddingGeneratorBuilderExtensions.cs b/src/Libraries/Microsoft.Extensions.AI/Embeddings/ConfigureOptionsEmbeddingGeneratorBuilderExtensions.cs index 4bf0a7b9e6..51f1804c2d 100644 --- a/src/Libraries/Microsoft.Extensions.AI/Embeddings/ConfigureOptionsEmbeddingGeneratorBuilderExtensions.cs +++ b/src/Libraries/Microsoft.Extensions.AI/Embeddings/ConfigureOptionsEmbeddingGeneratorBuilderExtensions.cs @@ -14,8 +14,8 @@ public static class ConfigureOptionsEmbeddingGeneratorBuilderExtensions /// /// Adds a callback that configures a to be passed to the next client in the pipeline. /// - /// Specifies the type of the input passed to the generator. - /// Specifies the type of the embedding instance produced by the generator. + /// The type of the input passed to the generator. + /// The type of the embedding instance produced by the generator. /// The . /// /// The delegate to invoke to configure the instance. It is passed a clone of the caller-supplied