Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable AIFunctionFactory.Create functions to get DI services #6141

Closed
wants to merge 1 commit into from

Conversation

stephentoub
Copy link
Member

@stephentoub stephentoub commented Mar 18, 2025

Microsoft Reviewers: Open in CodeFlow

@stephentoub stephentoub requested a review from a team as a code owner March 18, 2025 03:10
@github-actions github-actions bot added the area-ai Microsoft.Extensions.AI libraries label Mar 18, 2025
@@ -248,6 +253,30 @@ public static ReflectionAIFunctionDescriptor GetOrCreate(MethodInfo method, AIFu

private ReflectionAIFunctionDescriptor(DescriptorKey key, JsonSerializerOptions serializerOptions)
{
AIJsonSchemaCreateOptions schemaOptions = new()
{
// This needs to be kept in sync with the shape of AIJsonSchemaCreateOptions.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should AIJsonSchemaCreateOptions expose a Clone method? Or be a record if that won't introduce other issues?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given that AIJsonSchemaCreateOptions has custom implementations for Equals and GetHashCode that seem to mirror what records would give us, I think that makes sense. Especially now if we're cloning in some places.

If we don't go the record route, it would probably be best to extract this clone into an internal testable method, so you could write a reflection-based test like this to verify no one accidentally adds a property and forgets to update the clone method.

/// as the arguments to a call to <see cref="AIFunction.InvokeAsync"/>.
/// </remarks>
[AttributeUsage(AttributeTargets.Parameter)]
public sealed class FromServicesAttribute : Attribute
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know there's some hesitancy about duplicating the same name MVC uses. I don't have a better idea, though.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we have further reasons to think it wouldn't suffice to support passing in an IServiceProvider, and having the function resolve services from there?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be worth starting an effort lowering all those attributes to the M.E.DI package? We could then take a dependency on the next preview package.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alternate approaches:
#6144
#6145
#6146

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be worth starting an effort lowering all those attributes to the M.E.DI package? We could then take a dependency on the next preview package.

Not for a GA release. We wouldn't be able to add that until November. And FromServices is in an ASP.NET MVC namespace.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left a comment on #6146 explaining why I like that proposal the best. Is there any major pushback to making the IServiceProvider a top-level parameter like CancellationToken to AIFunction.InvokeAsync?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@@ -63,11 +64,13 @@ public partial class FunctionInvokingChatClient : DelegatingChatClient
/// </summary>
/// <param name="innerClient">The underlying <see cref="IChatClient"/>, or the next instance in a chain of clients.</param>
/// <param name="logger">An <see cref="ILogger"/> to use for logging information about function invocation.</param>
public FunctionInvokingChatClient(IChatClient innerClient, ILogger? logger = null)
/// <param name="services">An optional <see cref="IServiceProvider"/> to use for resolving services required by the <see cref="AIFunction"/> instances being invoked.</param>
public FunctionInvokingChatClient(IChatClient innerClient, ILogger? logger = null, IServiceProvider? services = null)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will it be confusing to pass an IServiceProvider into the constructor and not have it get used at all by FunctionInvokingChatClient.GetService(Type serviceType, object? serviceKey = null)?

I think it might be more consistent to rely on the IServiceProvider implementation from the innerClient and ensuring that the inner clients are initialized with the host's service provider whenever that's important. Another upside is that this would allow AIFunctions to inject services provided by the innerClient like ChatClientMetadata.

This might be made easier if we changed the IChatClient.GetService method to an IChatClient.Services property. We could get rid of a bunch of redundant ChatClientExtensions methods while we're at it.

I've already said my piece about how I don't like falling back to DI for the logger when null is passed in the same argument list, so I won't repeat that argument here.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will it be confusing to pass an IServiceProvider into the constructor and not have it get used at all by FunctionInvokingChatClient.GetService(Type serviceType, object? serviceKey = null)?

GetService has the same shape as with IServiceProvider, but it's not consulting any IServiceProvider in any of the implementations we have or have seen thus far. It's just a mechanism to ask the components in the pipeline for a particular object, e.g. if you have a pipeline of IChatClients that ends in an OnnxRuntimeGenAIClient, and for some reason you want to ask it for its Tokenizer, you can do so with GetService, and that call will be passed down through the pipeline until OnnxRuntimeGenAIClient says "yeah, I've got a Tokenizer, here". That also means it doesn't really work as a property.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it might be more consistent to rely on the IServiceProvider implementation from the innerClient

Most inner clients aren't going to have one. e.g. the OpenAIChatClient doesn't have an IServiceProvider, the AzureAIInferenceChatClient doesn't have one, etc. In fact I don't think any implementations I've seen do. Some other middleware components might, but there's no guarantee FunctionInvocationChatClient will be wrapping one of those. I can't think of a better way than to store the IServiceProvider that's pass in from the builder, typically in UseFunctionInvocation().

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-ai Microsoft.Extensions.AI libraries
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants