Make IChatClient/IEmbeddingGenerator.GetService non-generic (#5608)

Author: stephentoub

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

@@ -11,6 +11,22 @@ namespace Microsoft.Extensions.AI;
 /// <summary>Provides a collection of static methods for extending <see cref="IChatClient"/> instances.</summary>
 public static class ChatClientExtensions
 {
+    /// <summary>Asks the <see cref="IChatClient"/> for an object of type <typeparamref name="TService"/>.</summary>
+    /// <typeparam name="TService">The type of the object to be retrieved.</typeparam>
+    /// <param name="client">The client.</param>
+    /// <param name="serviceKey">An optional key that may be used to help identify the target service.</param>
+    /// <returns>The found object, otherwise <see langword="null"/>.</returns>
+    /// <remarks>
+    /// The purpose of this method is to allow for the retrieval of strongly-typed services that may be provided by the <see cref="IChatClient"/>,
+    /// including itself or any services it might be wrapping.
+    /// </remarks>
+    public static TService? GetService<TService>(this IChatClient client, object? serviceKey = null)
+    {
+        _ = Throw.IfNull(client);
+
+        return (TService?)client.GetService(typeof(TService), serviceKey);
+    }
+
     /// <summary>Sends a user chat text message to the model and returns the response messages.</summary>
     /// <param name="client">The chat client.</param>
     /// <param name="chatMessage">The text content for the chat message to send.</param>

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

@@ -63,12 +63,13 @@ public virtual IAsyncEnumerable<StreamingChatCompletionUpdate> CompleteStreaming
     }
 
     /// <inheritdoc />
-    public virtual TService? GetService<TService>(object? key = null)
-        where TService : class
+    public virtual object? GetService(Type serviceType, object? serviceKey = null)
     {
-#pragma warning disable S3060 // "is" should not be used with "this"
-        // If the key is non-null, we don't know what it means so pass through to the inner service
-        return key is null && this is TService service ? service : InnerClient.GetService<TService>(key);
-#pragma warning restore S3060
+        _ = Throw.IfNull(serviceType);
+
+        // If the key is non-null, we don't know what it means so pass through to the inner service.
+        return
+            serviceKey is null && serviceType.IsInstanceOfType(this) ? this :
+            InnerClient.GetService(serviceType, serviceKey);
     }
 }

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

@@ -56,14 +56,13 @@ IAsyncEnumerable<StreamingChatCompletionUpdate> CompleteStreamingAsync(
     /// <summary>Gets metadata that describes the <see cref="IChatClient"/>.</summary>
     ChatClientMetadata Metadata { get; }
 
-    /// <summary>Asks the <see cref="IChatClient"/> for an object of type <typeparamref name="TService"/>.</summary>
-    /// <typeparam name="TService">The type of the object to be retrieved.</typeparam>
-    /// <param name="key">An optional key that may be used to help identify the target service.</param>
+    /// <summary>Asks the <see cref="IChatClient"/> for an object of the specified type <paramref name="serviceType"/>.</summary>
+    /// <param name="serviceType">The type of object being requested.</param>
+    /// <param name="serviceKey">An optional key that may be used to help identify the target service.</param>
     /// <returns>The found object, otherwise <see langword="null"/>.</returns>
     /// <remarks>
     /// The purpose of this method is to allow for the retrieval of strongly-typed services that may be provided by the <see cref="IChatClient"/>,
     /// including itself or any services it might be wrapping.
     /// </remarks>
-    TService? GetService<TService>(object? key = null)
-        where TService : class;
+    object? GetService(Type serviceType, object? serviceKey = null);
 }

src/Libraries/Microsoft.Extensions.AI.Abstractions/Embeddings/DelegatingEmbeddingGenerator.cs

@@ -59,12 +59,13 @@ public virtual Task<GeneratedEmbeddings<TEmbedding>> GenerateAsync(IEnumerable<T
         InnerGenerator.GenerateAsync(values, options, cancellationToken);
 
     /// <inheritdoc />
-    public virtual TService? GetService<TService>(object? key = null)
-        where TService : class
+    public virtual object? GetService(Type serviceType, object? serviceKey = null)
     {
-#pragma warning disable S3060 // "is" should not be used with "this"
-        // If the key is non-null, we don't know what it means so pass through to the inner service
-        return key is null && this is TService service ? service : InnerGenerator.GetService<TService>(key);
-#pragma warning restore S3060
+        _ = Throw.IfNull(serviceType);
+
+        // If the key is non-null, we don't know what it means so pass through to the inner service.
+        return
+            serviceKey is null && serviceType.IsInstanceOfType(this) ? this :
+            InnerGenerator.GetService(serviceType, serviceKey);
     }
 }

src/Libraries/Microsoft.Extensions.AI.Abstractions/Embeddings/EmbeddingGeneratorExtensions.cs

@@ -15,6 +15,43 @@ namespace Microsoft.Extensions.AI;
 /// <summary>Provides a collection of static methods for extending <see cref="IEmbeddingGenerator{TInput,TEmbedding}"/> instances.</summary>
 public static class EmbeddingGeneratorExtensions
 {
+    /// <summary>Asks the <see cref="IEmbeddingGenerator{TInput,TEmbedding}"/> for an object of type <typeparamref name="TService"/>.</summary>
+    /// <typeparam name="TInput">The type from which embeddings will be generated.</typeparam>
+    /// <typeparam name="TEmbedding">The numeric type of the embedding data.</typeparam>
+    /// <typeparam name="TService">The type of the object to be retrieved.</typeparam>
+    /// <param name="generator">The generator.</param>
+    /// <param name="serviceKey">An optional key that may be used to help identify the target service.</param>
+    /// <returns>The found object, otherwise <see langword="null"/>.</returns>
+    /// <remarks>
+    /// The purpose of this method is to allow for the retrieval of strongly-typed services that may be provided by the
+    /// <see cref="IEmbeddingGenerator{TInput,TEmbedding}"/>, including itself or any services it might be wrapping.
+    /// </remarks>
+    public static TService? GetService<TInput, TEmbedding, TService>(this IEmbeddingGenerator<TInput, TEmbedding> generator, object? serviceKey = null)
+        where TEmbedding : Embedding
+    {
+        _ = Throw.IfNull(generator);
+
+        return (TService?)generator.GetService(typeof(TService), serviceKey);
+    }
+
+    // The following overload exists purely to work around the lack of partial generic type inference.
+    // Given an IEmbeddingGenerator<TInput, TEmbedding> generator, to call GetService with TService, you still need
+    // to re-specify both TInput and TEmbedding, e.g. generator.GetService<string, Embedding<float>, TService>.
+    // The case of string/Embedding<float> is by far the most common case today, so this overload exists as an
+    // accelerator to allow it to be written simply as generator.GetService<TService>.
+
+    /// <summary>Asks the <see cref="IEmbeddingGenerator{TInput, TEmbedding}"/> for an object of type <typeparamref name="TService"/>.</summary>
+    /// <typeparam name="TService">The type of the object to be retrieved.</typeparam>
+    /// <param name="generator">The generator.</param>
+    /// <param name="serviceKey">An optional key that may be used to help identify the target service.</param>
+    /// <returns>The found object, otherwise <see langword="null"/>.</returns>
+    /// <remarks>
+    /// The purpose of this method is to allow for the retrieval of strongly-typed services that may be provided by the
+    /// <see cref="IEmbeddingGenerator{TInput,TEmbedding}"/>, including itself or any services it might be wrapping.
+    /// </remarks>
+    public static TService? GetService<TService>(this IEmbeddingGenerator<string, Embedding<float>> generator, object? serviceKey = null) =>
+        GetService<string, Embedding<float>, TService>(generator, serviceKey);
+
     /// <summary>Generates an embedding vector from the specified <paramref name="value"/>.</summary>
     /// <typeparam name="TInput">The type from which embeddings will be generated.</typeparam>
     /// <typeparam name="TEmbedding">The numeric type of the embedding data.</typeparam>

src/Libraries/Microsoft.Extensions.AI.Abstractions/Embeddings/IEmbeddingGenerator.cs

@@ -40,14 +40,13 @@ Task<GeneratedEmbeddings<TEmbedding>> GenerateAsync(
     /// <summary>Gets metadata that describes the <see cref="IEmbeddingGenerator{TInput, TEmbedding}"/>.</summary>
     EmbeddingGeneratorMetadata Metadata { get; }
 
-    /// <summary>Asks the <see cref="IEmbeddingGenerator{TInput, TEmbedding}"/> for an object of type <typeparamref name="TService"/>.</summary>
-    /// <typeparam name="TService">The type of the object to be retrieved.</typeparam>
-    /// <param name="key">An optional key that may be used to help identify the target service.</param>
+    /// <summary>Asks the <see cref="IEmbeddingGenerator{TInput, TEmbedding}"/> for an object of the specified type <paramref name="serviceType"/>.</summary>
+    /// <param name="serviceType">The type of object being requested.</param>
+    /// <param name="serviceKey">An optional key that may be used to help identify the target service.</param>
     /// <returns>The found object, otherwise <see langword="null"/>.</returns>
     /// <remarks>
-    /// The purpose of this method is to allow for the retrieval of strongly-typed services that may be provided by the <see cref="IEmbeddingGenerator{TInput, TEmbedding}"/>,
-    /// including itself or any services it might be wrapping.
+    /// The purpose of this method is to allow for the retrieval of strongly-typed services that may be provided by the
+    /// <see cref="IEmbeddingGenerator{TInput, TEmbedding}"/>, including itself or any services it might be wrapping.
     /// </remarks>
-    TService? GetService<TService>(object? key = null)
-        where TService : class;
+    object? GetService(Type serviceType, object? serviceKey = null);
 }

src/Libraries/Microsoft.Extensions.AI.AzureAIInference/AzureAIInferenceChatClient.cs

@@ -57,10 +57,16 @@ public AzureAIInferenceChatClient(ChatCompletionsClient chatCompletionsClient, s
     public ChatClientMetadata Metadata { get; }
 
     /// <inheritdoc />
-    public TService? GetService<TService>(object? key = null)
-        where TService : class =>
-        typeof(TService) == typeof(ChatCompletionsClient) ? (TService?)(object?)_chatCompletionsClient :
-        this as TService;
+    public object? GetService(Type serviceType, object? serviceKey = null)
+    {
+        _ = Throw.IfNull(serviceType);
+
+        return
+            serviceKey is not null ? null :
+            serviceType == typeof(ChatCompletionsClient) ? _chatCompletionsClient :
+            serviceType.IsInstanceOfType(this) ? this :
+            null;
+    }
 
     /// <inheritdoc />
     public async Task<ChatCompletion> CompleteAsync(

src/Libraries/Microsoft.Extensions.AI.AzureAIInference/AzureAIInferenceEmbeddingGenerator.cs

@@ -70,10 +70,16 @@ public AzureAIInferenceEmbeddingGenerator(
     public EmbeddingGeneratorMetadata Metadata { get; }
 
     /// <inheritdoc />
-    public TService? GetService<TService>(object? key = null)
-        where TService : class =>
-        typeof(TService) == typeof(EmbeddingsClient) ? (TService)(object)_embeddingsClient :
-        this as TService;
+    public object? GetService(Type serviceType, object? serviceKey = null)
+    {
+        _ = Throw.IfNull(serviceType);
+
+        return
+            serviceKey is not null ? null :
+            serviceType == typeof(EmbeddingsClient) ? _embeddingsClient :
+            serviceType.IsInstanceOfType(this) ? this :
+            null;
+    }
 
     /// <inheritdoc />
     public async Task<GeneratedEmbeddings<Embedding<float>>> GenerateAsync(

src/Libraries/Microsoft.Extensions.AI.Ollama/OllamaChatClient.cs

@@ -166,9 +166,14 @@ public async IAsyncEnumerable<StreamingChatCompletionUpdate> CompleteStreamingAs
     }
 
     /// <inheritdoc />
-    public TService? GetService<TService>(object? key = null)
-        where TService : class
-        => key is null ? this as TService : null;
+    public object? GetService(Type serviceType, object? serviceKey = null)
+    {
+        _ = Throw.IfNull(serviceType);
+
+        return
+            serviceKey is null && serviceType.IsInstanceOfType(this) ? this :
+            null;
+    }
 
     /// <inheritdoc />
     public void Dispose()

src/Libraries/Microsoft.Extensions.AI.Ollama/OllamaEmbeddingGenerator.cs

@@ -57,9 +57,14 @@ public OllamaEmbeddingGenerator(Uri endpoint, string? modelId = null, HttpClient
     public EmbeddingGeneratorMetadata Metadata { get; }
 
     /// <inheritdoc />
-    public TService? GetService<TService>(object? key = null)
-        where TService : class
-        => key is null ? this as TService : null;
+    public object? GetService(Type serviceType, object? serviceKey = null)
+    {
+        _ = Throw.IfNull(serviceType);
+
+        return
+            serviceKey is null && serviceType.IsInstanceOfType(this) ? this :
+            null;
+    }
 
     /// <inheritdoc />
     public void Dispose()