Move AIFunction properties down to AITool

Author: stephentoub

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

@@ -1,13 +1,55 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.Text;
+using Microsoft.Shared.Collections;
+
 namespace Microsoft.Extensions.AI;
 
+#pragma warning disable S1694 // An abstract class should have both abstract and concrete methods
+
 /// <summary>Represents a tool that can be specified to an AI service.</summary>
-public class AITool
+[DebuggerDisplay("{DebuggerDisplay,nq}")]
+public abstract class AITool
 {
     /// <summary>Initializes a new instance of the <see cref="AITool"/> class.</summary>
     protected AITool()
     {
     }
+
+    /// <summary>Gets the name of the tool.</summary>
+    public virtual string Name => GetType().Name;
+
+    /// <summary>Gets a description of the tool, suitable for use in describing the purpose to a model.</summary>
+    public virtual string Description => string.Empty;
+
+    /// <summary>Gets any additional properties associated with the tool.</summary>
+    public virtual IReadOnlyDictionary<string, object?> AdditionalProperties => EmptyReadOnlyDictionary<string, object?>.Instance;
+
+    /// <inheritdoc/>
+    public override string ToString() => Name;
+
+    /// <summary>Gets the string to display in the debugger for this instance.</summary>
+    [DebuggerBrowsable(DebuggerBrowsableState.Never)]
+    private string DebuggerDisplay
+    {
+        get
+        {
+            StringBuilder sb = new(Name);
+
+            if (Description is string description && !string.IsNullOrEmpty(description))
+            {
+                _ = sb.Append(" (").Append(description).Append(')');
+            }
+
+            foreach (var entry in AdditionalProperties)
+            {
+                _ = sb.Append(", ").Append(entry.Key).Append(" = ").Append(entry.Value);
+            }
+
+            return sb.ToString();
+        }
+    }
 }

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

@@ -1,6 +1,9 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using System.Collections.Generic;
+using Microsoft.Shared.Collections;
+
 namespace Microsoft.Extensions.AI;
 
 /// <summary>Represents a tool that can be specified to an AI service to enable it to execute code it generates.</summary>
@@ -11,10 +14,11 @@ namespace Microsoft.Extensions.AI;
 public class CodeInterpreterTool : AITool
 {
     /// <summary>Initializes a new instance of the <see cref="CodeInterpreterTool"/> class.</summary>
-    public CodeInterpreterTool()
+    public CodeInterpreterTool(IReadOnlyDictionary<string, object?>? additionalProperties = null)
     {
+        AdditionalProperties = additionalProperties ?? EmptyReadOnlyDictionary<string, object?>.Instance;
     }
 
-    /// <summary>Gets or sets additional properties that impact the behavior of the tool.</summary>
-    public AdditionalPropertiesDictionary? AdditionalProperties { get; set; }
+    /// <inheritdoc/>
+    public override IReadOnlyDictionary<string, object?> AdditionalProperties { get; }
 }

src/Libraries/Microsoft.Extensions.AI.Abstractions/Functions/AIFunction.cs

@@ -2,7 +2,6 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.Collections.Generic;
-using System.Diagnostics;
 using System.Reflection;
 using System.Text.Json;
 using System.Threading;
@@ -12,15 +11,8 @@
 namespace Microsoft.Extensions.AI;
 
 /// <summary>Represents a function that can be described to an AI service and invoked.</summary>
-[DebuggerDisplay("{DebuggerDisplay,nq}")]
 public abstract class AIFunction : AITool
 {
-    /// <summary>Gets the name of the function.</summary>
-    public abstract string Name { get; }
-
-    /// <summary>Gets a description of the function, suitable for use in describing the purpose to a model.</summary>
-    public abstract string Description { get; }
-
     /// <summary>Gets a JSON Schema describing the function and its input parameters.</summary>
     /// <remarks>
     /// <para>
@@ -56,11 +48,8 @@ public abstract class AIFunction : AITool
     /// </remarks>
     public virtual MethodInfo? UnderlyingMethod => null;
 
-    /// <summary>Gets any additional properties associated with the function.</summary>
-    public virtual IReadOnlyDictionary<string, object?> AdditionalProperties => EmptyReadOnlyDictionary<string, object?>.Instance;
-
     /// <summary>Gets a <see cref="JsonSerializerOptions"/> that can be used to marshal function parameters.</summary>
-    public virtual JsonSerializerOptions? JsonSerializerOptions => AIJsonUtilities.DefaultOptions;
+    public virtual JsonSerializerOptions JsonSerializerOptions => AIJsonUtilities.DefaultOptions;
 
     /// <summary>Invokes the <see cref="AIFunction"/> and returns its result.</summary>
     /// <param name="arguments">The arguments to pass to the function's invocation.</param>
@@ -75,18 +64,11 @@ public abstract class AIFunction : AITool
         return InvokeCoreAsync(arguments, cancellationToken);
     }
 
-    /// <inheritdoc/>
-    public override string ToString() => Name;
-
     /// <summary>Invokes the <see cref="AIFunction"/> and returns its result.</summary>
     /// <param name="arguments">The arguments to pass to the function's invocation.</param>
     /// <param name="cancellationToken">The <see cref="CancellationToken"/> to monitor for cancellation requests.</param>
     /// <returns>The result of the function's execution.</returns>
     protected abstract Task<object?> InvokeCoreAsync(
         IEnumerable<KeyValuePair<string, object?>> arguments,
         CancellationToken cancellationToken);
-
-    /// <summary>Gets the string to display in the debugger for this instance.</summary>
-    [DebuggerBrowsable(DebuggerBrowsableState.Never)]
-    private string DebuggerDisplay => string.IsNullOrWhiteSpace(Description) ? Name : $"{Name} ({Description})";
 }

src/Libraries/Microsoft.Extensions.AI.OpenAI/OpenAIAssistantClient.cs

@@ -222,10 +222,10 @@ strictObj is bool strictValue ?
 
                             var functionParameters = BinaryData.FromBytes(
                                 JsonSerializer.SerializeToUtf8Bytes(
-                                    JsonSerializer.Deserialize(aiFunction.Metadata.Schema, OpenAIJsonContext.Default.OpenAIChatToolJson)!,
+                                    JsonSerializer.Deserialize(aiFunction.JsonSchema, OpenAIJsonContext.Default.OpenAIChatToolJson)!,
                                     OpenAIJsonContext.Default.OpenAIChatToolJson));
 
-                            runOptions.ToolsOverride.Add(ToolDefinition.CreateFunction(aiFunction.Metadata.Name, aiFunction.Metadata.Description, functionParameters, strict));
+                            runOptions.ToolsOverride.Add(ToolDefinition.CreateFunction(aiFunction.Name, aiFunction.Description, functionParameters, strict));
                             break;
 
                         case CodeInterpreterTool:

src/Libraries/Microsoft.Extensions.AI/Functions/AIFunctionFactory.cs

@@ -339,7 +339,7 @@ static bool IsAsyncMethod(MethodInfo method)
             JsonTypeInfo typeInfo = options.SerializerOptions.GetTypeInfo(parameterType);
 
             // Create a marshaller that simply looks up the parameter by name in the arguments dictionary.
-            return (IReadOnlyDictionary<string, object?> arguments, AIFunctionContext? _) =>
+            return (arguments, _) =>
             {
                 // If the parameter has an argument specified in the dictionary, return that argument.
                 if (arguments.TryGetValue(parameter.Name, out object? value))

src/Libraries/Microsoft.Extensions.AI/Functions/AIFunctionFactoryCreateOptions.cs

@@ -55,7 +55,7 @@ public AIJsonSchemaCreateOptions JsonSchemaCreateOptions
     public string? Description { get; set; }
 
     /// <summary>
-    /// Gets or sets additional values to store on the resulting <see cref="AIFunction.AdditionalProperties" /> property.
+    /// Gets or sets additional values to store on the resulting <see cref="AITool.AdditionalProperties" /> property.
     /// </summary>
     /// <remarks>
     /// This property can be used to provide arbitrary information about the function.

test/Libraries/Microsoft.Extensions.AI.Abstractions.Tests/AIToolTests.cs

@@ -0,0 +1,21 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using Xunit;
+
+namespace Microsoft.Extensions.AI;
+
+public class AIToolTests
+{
+    [Fact]
+    public void Constructor_Roundtrips()
+    {
+        DerivedAITool tool = new();
+        Assert.Equal(nameof(DerivedAITool), tool.Name);
+        Assert.Equal(nameof(DerivedAITool), tool.ToString());
+        Assert.Empty(tool.Description);
+        Assert.Empty(tool.AdditionalProperties);
+    }
+
+    private sealed class DerivedAITool : AITool;
+}

test/Libraries/Microsoft.Extensions.AI.Abstractions.Tests/CodeInterpreterToolTests.cs

@@ -11,10 +11,16 @@ public class CodeInterpreterToolTests
     public void Constructor_Roundtrips()
     {
         var tool = new CodeInterpreterTool();
-        Assert.Null(tool.AdditionalProperties);
+        Assert.Equal(nameof(CodeInterpreterTool), tool.Name);
+        Assert.Empty(tool.Description);
+        Assert.Empty(tool.AdditionalProperties);
+        Assert.Equal(nameof(CodeInterpreterTool), tool.ToString());
 
         var props = new AdditionalPropertiesDictionary();
-        tool.AdditionalProperties = props;
+        tool = new CodeInterpreterTool(props);
+        Assert.Equal(nameof(CodeInterpreterTool), tool.Name);
+        Assert.Empty(tool.Description);
         Assert.Same(props, tool.AdditionalProperties);
+        Assert.Equal(nameof(CodeInterpreterTool), tool.ToString());
     }
 }