Skip to content

Commit d39bf3d

Browse files
authored
docs updates (#5643)
1 parent 430065c commit d39bf3d

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed

src/Libraries/Microsoft.Extensions.AI.Abstractions/AdditionalPropertiesDictionary.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,8 +153,8 @@ public bool TryAdd(string key, object? value)
153153
/// in the dictionary and converted to the requested type; otherwise, <see langword="false"/>.
154154
/// </returns>
155155
/// <remarks>
156-
/// If a non-<see langword="null"/> is found for the key in the dictionary, but the value is not of the requested type but is
157-
/// an <see cref="IConvertible"/> object, the method will attempt to convert the object to the requested type.
156+
/// If a non-<see langword="null"/> value is found for the key in the dictionary, but the value is not of the requested type and is
157+
/// an <see cref="IConvertible"/> object, the method attempts to convert the object to the requested type.
158158
/// </remarks>
159159
public bool TryGetValue<T>(string key, [NotNullWhen(true)] out T? value)
160160
{

src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatCompletion/ChatOptions.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ public class ChatOptions
2727
/// <summary>Gets or sets the presence penalty for generating chat responses.</summary>
2828
public float? PresencePenalty { get; set; }
2929

30-
/// <summary>Gets or sets a seed value used by a service to control the reproducability of results.</summary>
30+
/// <summary>Gets or sets a seed value used by a service to control the reproducibility of results.</summary>
3131
public long? Seed { get; set; }
3232

3333
/// <summary>

src/Libraries/Microsoft.Extensions.AI/ChatCompletion/ConfigureOptionsChatClientBuilderExtensions.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ public static class ConfigureOptionsChatClientBuilderExtensions
2020
/// It is passed a clone of the caller-supplied <see cref="ChatOptions"/> instance (or a newly constructed instance if the caller-supplied instance is <see langword="null"/>).
2121
/// </param>
2222
/// <remarks>
23-
/// This can be used to set default options. The <paramref name="configure"/> delegate is passed either a new instance of
24-
/// <see cref="ChatOptions"/> if the caller didn't supply a <see cref="ChatOptions"/> instance, or a clone (via <see cref="ChatOptions.Clone"/>
23+
/// This method can be used to set default options. The <paramref name="configure"/> delegate is passed either a new instance of
24+
/// <see cref="ChatOptions"/> if the caller didn't supply a <see cref="ChatOptions"/> instance, or a clone (via <see cref="ChatOptions.Clone"/>)
2525
/// of the caller-supplied instance if one was supplied.
2626
/// </remarks>
2727
/// <returns>The <paramref name="builder"/>.</returns>

src/Libraries/Microsoft.Extensions.AI/Embeddings/ConfigureOptionsEmbeddingGenerator.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@
99

1010
namespace Microsoft.Extensions.AI;
1111

12-
/// <summary>A delegating embedding generator that configures a <see cref="EmbeddingGenerationOptions"/> instance used by the remainder of the pipeline.</summary>
13-
/// <typeparam name="TInput">Specifies the type of the input passed to the generator.</typeparam>
14-
/// <typeparam name="TEmbedding">Specifies the type of the embedding instance produced by the generator.</typeparam>
12+
/// <summary>Represents a delegating embedding generator that configures a <see cref="EmbeddingGenerationOptions"/> instance used by the remainder of the pipeline.</summary>
13+
/// <typeparam name="TInput">The type of the input passed to the generator.</typeparam>
14+
/// <typeparam name="TEmbedding">The type of the embedding instance produced by the generator.</typeparam>
1515
public sealed class ConfigureOptionsEmbeddingGenerator<TInput, TEmbedding> : DelegatingEmbeddingGenerator<TInput, TEmbedding>
1616
where TEmbedding : Embedding
1717
{

src/Libraries/Microsoft.Extensions.AI/Embeddings/ConfigureOptionsEmbeddingGeneratorBuilderExtensions.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ public static class ConfigureOptionsEmbeddingGeneratorBuilderExtensions
1414
/// <summary>
1515
/// Adds a callback that configures a <see cref="EmbeddingGenerationOptions"/> to be passed to the next client in the pipeline.
1616
/// </summary>
17-
/// <typeparam name="TInput">Specifies the type of the input passed to the generator.</typeparam>
18-
/// <typeparam name="TEmbedding">Specifies the type of the embedding instance produced by the generator.</typeparam>
17+
/// <typeparam name="TInput">The type of the input passed to the generator.</typeparam>
18+
/// <typeparam name="TEmbedding">The type of the embedding instance produced by the generator.</typeparam>
1919
/// <param name="builder">The <see cref="EmbeddingGeneratorBuilder{TInput, TEmbedding}"/>.</param>
2020
/// <param name="configure">
2121
/// The delegate to invoke to configure the <see cref="EmbeddingGenerationOptions"/> instance. It is passed a clone of the caller-supplied

0 commit comments

Comments
 (0)