.Net: adds support for strict mode with OpenAI

dotnet/samples/Concepts/Agents/DeclarativeAgents.cs

@@ -33,7 +33,16 @@ public async Task LoadsAgentFromDeclarativeAgentManifestAsync(string agentFileNa
         ChatMessageContent message = new(AuthorRole.User, input);
         ChatHistory chatHistory = [message];
         StringBuilder sb = new();
-        await foreach (ChatMessageContent response in agent.InvokeAsync(chatHistory))
+        var kernelArguments = new KernelArguments(new PromptExecutionSettings
+        {
+            FunctionChoiceBehavior = FunctionChoiceBehavior.Auto(
+                    options: new FunctionChoiceBehaviorOptions
+                    {
+                        AllowStrictSchemaAdherence = true
+                    }
+                )
+        });
+        await foreach (ChatMessageContent response in agent.InvokeAsync(chatHistory, kernelArguments))
         {
             chatHistory.Add(response);
             sb.Append(response.Content);

dotnet/samples/Concepts/Plugins/ApiManifestBasedPlugins.cs

@@ -55,19 +55,28 @@ namespace Plugins;
 /// <param name="output">The output helper to use to the test can emit status information</param>
 public class ApiManifestBasedPlugins(ITestOutputHelper output) : BaseTest(output)
 {
+    private static readonly PromptExecutionSettings s_promptExecutionSettings = new()
+    {
+        FunctionChoiceBehavior = FunctionChoiceBehavior.Auto(
+                    options: new FunctionChoiceBehaviorOptions
+                    {
+                        AllowStrictSchemaAdherence = true
+                    }
+                )
+    };
     public static readonly IEnumerable<object[]> s_parameters =
     [
         // function names are sanitized operationIds from the OpenAPI document
-        ["MessagesPlugin", "me_ListMessages", new KernelArguments { { "_top", "1" } }, "MessagesPlugin"],
-        ["DriveItemPlugin", "drive_root_GetChildrenContent", new KernelArguments { { "driveItem-Id", "test.txt" } }, "DriveItemPlugin", "MessagesPlugin"],
-        ["ContactsPlugin", "me_ListContacts", new KernelArguments() { { "_count", "true" } }, "ContactsPlugin", "MessagesPlugin"],
-        ["CalendarPlugin", "me_calendar_ListEvents", new KernelArguments() { { "_top", "1" } }, "CalendarPlugin", "MessagesPlugin"],
+        ["MessagesPlugin", "me_ListMessages", new KernelArguments(s_promptExecutionSettings) { { "_top", "1" } }, "MessagesPlugin"],
+        ["DriveItemPlugin", "drive_root_GetChildrenContent", new KernelArguments(s_promptExecutionSettings) { { "driveItem-Id", "test.txt" } }, "DriveItemPlugin", "MessagesPlugin"],
+        ["ContactsPlugin", "me_ListContacts", new KernelArguments(s_promptExecutionSettings) { { "_count", "true" } }, "ContactsPlugin", "MessagesPlugin"],
+        ["CalendarPlugin", "me_calendar_ListEvents", new KernelArguments(s_promptExecutionSettings) { { "_top", "1" } }, "CalendarPlugin", "MessagesPlugin"],
 
         #region Multiple API dependencies (multiple auth requirements) scenario within the same plugin
         // Graph API uses MSAL
-        ["AstronomyPlugin", "me_ListMessages", new KernelArguments { { "_top", "1" } }, "AstronomyPlugin"],
+        ["AstronomyPlugin", "me_ListMessages", new KernelArguments(s_promptExecutionSettings) { { "_top", "1" } }, "AstronomyPlugin"],
         // Astronomy API uses API key authentication
-        ["AstronomyPlugin", "apod", new KernelArguments { { "_date", "2022-02-02" } }, "AstronomyPlugin"],
+        ["AstronomyPlugin", "apod", new KernelArguments(s_promptExecutionSettings) { { "_date", "2022-02-02" } }, "AstronomyPlugin"],
         #endregion
     ];
 
@@ -116,7 +125,9 @@ private async Task AddApiManifestPluginsAsync(Kernel kernel, params string[] plu
         // Microsoft Graph API execution parameters
         var graphOpenApiFunctionExecutionParameters = new OpenApiFunctionExecutionParameters(
             authCallback: authenticationProvider.AuthenticateRequestAsync,
-            serverUrlOverride: new Uri("https://graph.microsoft.com/v1.0"));
+            serverUrlOverride: new Uri("https://graph.microsoft.com/v1.0"),
+            enableDynamicOperationPayload: false,
+            enablePayloadNamespacing: true);
 
         // NASA API execution parameters
         var nasaOpenApiFunctionExecutionParameters = new OpenApiFunctionExecutionParameters(
@@ -127,7 +138,9 @@ private async Task AddApiManifestPluginsAsync(Kernel kernel, params string[] plu
                 query["api_key"] = "DEMO_KEY";
                 uriBuilder.Query = query.ToString();
                 request.RequestUri = uriBuilder.Uri;
-            });
+            },
+            enableDynamicOperationPayload: false,
+            enablePayloadNamespacing: true);
 
         var apiManifestPluginParameters = new ApiManifestPluginParameters(
             functionExecutionParameters: new()

dotnet/samples/Concepts/Plugins/CopilotAgentBasedPlugins.cs

@@ -1,5 +1,7 @@
 // Copyright (c) Microsoft. All rights reserved.
 
+using System.Text.Json;
+using System.Text.Json.Nodes;
 using System.Web;
 using Microsoft.SemanticKernel;
 using Microsoft.SemanticKernel.Plugins.MsGraph.Connectors.CredentialManagers;
@@ -52,19 +54,28 @@ namespace Plugins;
 /// <param name="output">The output helper to use to the test can emit status information</param>
 public class CopilotAgentBasedPlugins(ITestOutputHelper output) : BaseTest(output)
 {
+    private static readonly PromptExecutionSettings s_promptExecutionSettings = new()
+    {
+        FunctionChoiceBehavior = FunctionChoiceBehavior.Auto(
+                    options: new FunctionChoiceBehaviorOptions
+                    {
+                        AllowStrictSchemaAdherence = true
+                    }
+                )
+    };
     public static readonly IEnumerable<object[]> s_parameters =
     [
         // function names are sanitized operationIds from the OpenAPI document
-        ["MessagesPlugin", "me_ListMessages", new KernelArguments { { "_top", "1" } }, "MessagesPlugin"],
-        ["DriveItemPlugin", "drive_root_GetChildrenContent", new KernelArguments { { "driveItem-Id", "test.txt" } }, "DriveItemPlugin", "MessagesPlugin"],
-        ["ContactsPlugin", "me_ListContacts", new KernelArguments() { { "_count", "true" } }, "ContactsPlugin", "MessagesPlugin"],
-        ["CalendarPlugin", "me_calendar_ListEvents", new KernelArguments() { { "_top", "1" } }, "CalendarPlugin", "MessagesPlugin"],
+        ["MessagesPlugin", "me_ListMessages", new KernelArguments(s_promptExecutionSettings) { { "_top", "1" } }, "MessagesPlugin"],
+        ["DriveItemPlugin", "drives_GetItemsContent", new KernelArguments(s_promptExecutionSettings) { { "driveItem-Id", "test.txt" } }, "DriveItemPlugin", "MessagesPlugin"],
+        ["ContactsPlugin", "me_ListContacts", new KernelArguments(s_promptExecutionSettings) { { "_count", "true" } }, "ContactsPlugin", "MessagesPlugin"],
+        ["CalendarPlugin", "me_calendar_ListEvents", new KernelArguments(s_promptExecutionSettings) { { "_top", "1" } }, "CalendarPlugin", "MessagesPlugin"],
 
         // Multiple API dependencies (multiple auth requirements) scenario within the same plugin
         // Graph API uses MSAL
-        ["AstronomyPlugin", "me_ListMessages", new KernelArguments { { "_top", "1" } }, "AstronomyPlugin"],
+        ["AstronomyPlugin", "me_ListMessages", new KernelArguments(s_promptExecutionSettings) { { "_top", "1" } }, "AstronomyPlugin"],
         // Astronomy API uses API key authentication
-        ["AstronomyPlugin", "apod", new KernelArguments { { "_date", "2022-02-02" } }, "AstronomyPlugin"],
+        ["AstronomyPlugin", "apod", new KernelArguments(s_promptExecutionSettings) { { "_date", "2022-02-02" } }, "AstronomyPlugin"],
     ];
     [Theory, MemberData(nameof(s_parameters))]
     public async Task RunCopilotAgentPluginAsync(string pluginToTest, string functionToTest, KernelArguments? arguments, params string[] pluginsToLoad)
@@ -87,6 +98,80 @@ private void WriteSampleHeadingToConsole(string pluginToTest, string functionToT
         Console.WriteLine($"======== Calling Plugin Function: {pluginToTest}.{functionToTest} with parameters {arguments?.Select(x => x.Key + " = " + x.Value).Aggregate((x, y) => x + ", " + y)} ========");
         Console.WriteLine();
     }
+    private static readonly HashSet<string> s_fieldsToIgnore = new(
+        [
+            "bodyPreview",
+            "categories",
+            "conversationId",
+            "conversationIndex",
+            "inferenceClassification",
+            "internetMessageHeaders",
+            "isDeliveryReceiptRequested",
+            "multiValueExtendedProperties",
+            "singleValueExtendedProperties",
+            "uniqueBody",
+            "webLink",
+        ],
+        StringComparer.OrdinalIgnoreCase
+    );
+    private const string RequiredPropertyName = "required";
+    private const string PropertiesPropertyName = "properties";
+    /// <summary>
+    /// Trims the properties from the request body schema.
+    /// Most models in strict mode enforce a limit on the properties.
+    /// </summary>
+    /// <param name="schema">Source schema</param>
+    /// <returns>the trimmed schema for the request body</returns>
+    private static KernelJsonSchema? TrimPropertiesFromRequestBody(KernelJsonSchema? schema)
+    {
+        if (schema is null)
+        {
+            return null;
+        }
+
+        var originalSchema = JsonSerializer.Serialize(schema.RootElement);
+        var node = JsonNode.Parse(originalSchema);
+        if (node is not JsonObject jsonNode)
+        {
+            return schema;
+        }
+        if (jsonNode.TryGetPropertyValue(RequiredPropertyName, out var requiredRawValue) && requiredRawValue is JsonArray requiredArray)
+        {
+            jsonNode[RequiredPropertyName] = new JsonArray(requiredArray.Where(x => x is not null).Select(x => x!.GetValue<string>()).Where(x => !s_fieldsToIgnore.Contains(x)).Select(x => JsonValue.Create(x)).ToArray());
+        }
+
+        if (jsonNode.TryGetPropertyValue(PropertiesPropertyName, out var propertiesRawValue) && propertiesRawValue is JsonObject propertiesObject)
+        {
+            var properties = propertiesObject.Where(x => s_fieldsToIgnore.Contains(x.Key)).Select(x => x.Key).ToArray();
+            foreach (var property in properties)
+            {
+                propertiesObject.Remove(property);
+            }
+        }
+
+        return KernelJsonSchema.Parse(node.ToString());
+    }
+    private static readonly RestApiParameterFilter s_restApiParameterFilter = (RestApiParameterFilterContext context) =>
+    {
+        if ("me_CreateMessages".Equals(context.Operation.Id, StringComparison.OrdinalIgnoreCase) &&
+            "payload".Equals(context.Parameter.Name, StringComparison.OrdinalIgnoreCase))
+        {
+            return new RestApiParameter(
+                context.Parameter.Name,
+                context.Parameter.Type,
+                context.Parameter.IsRequired,
+                context.Parameter.Expand,
+                context.Parameter.Location,
+                context.Parameter.Style,
+                context.Parameter.ArrayItemType,
+                context.Parameter.DefaultValue,
+                context.Parameter.Description,
+                context.Parameter.Format,
+                TrimPropertiesFromRequestBody(context.Parameter.Schema)
+            );
+        }
+        return context.Parameter;
+    };
     internal static async Task<CopilotAgentPluginParameters> GetAuthenticationParametersAsync()
     {
         if (TestConfiguration.MSGraph.Scopes is null)
@@ -109,7 +194,12 @@ internal static async Task<CopilotAgentPluginParameters> GetAuthenticationParame
         // Microsoft Graph API execution parameters
         var graphOpenApiFunctionExecutionParameters = new OpenApiFunctionExecutionParameters(
             authCallback: authenticationProvider.AuthenticateRequestAsync,
-            serverUrlOverride: new Uri("https://graph.microsoft.com/v1.0"));
+            serverUrlOverride: new Uri("https://graph.microsoft.com/v1.0"),
+            enableDynamicOperationPayload: false,
+            enablePayloadNamespacing: true)
+        {
+            ParameterFilter = s_restApiParameterFilter
+        };
 
         // NASA API execution parameters
         var nasaOpenApiFunctionExecutionParameters = new OpenApiFunctionExecutionParameters(
@@ -120,7 +210,9 @@ internal static async Task<CopilotAgentPluginParameters> GetAuthenticationParame
                 query["api_key"] = "DEMO_KEY";
                 uriBuilder.Query = query.ToString();
                 request.RequestUri = uriBuilder.Uri;
-            });
+            },
+            enableDynamicOperationPayload: false,
+            enablePayloadNamespacing: true);
 
         var apiManifestPluginParameters = new CopilotAgentPluginParameters
         {

dotnet/samples/Concepts/Resources/Plugins/CopilotAgentPlugins/DriveItemPlugin/driveitem-openapi.yml

@@ -6,12 +6,12 @@ info:
 servers:
   - url: https://graph.microsoft.com/v1.0
 paths:
-  '/drives/{drive-id}/items/{driveItem-id}/content':
+  "/me/drive/root/children/{driveItem-id}/content":
     get:
       tags:
         - drives.driveItem
       summary: Get content for the navigation property items from drives
-      description: 'The content stream, if the item represents a file.'
+      description: "The content stream, if the item represents a file."
       operationId: drives_GetItemsContent
       parameters:
         - name: $format
@@ -30,18 +30,11 @@ paths:
                 type: string
                 format: binary
     parameters:
-      - name: drive-id
-        in: path
-        description: The unique identifier of drive
-        required: true
-        style: simple
-        schema:
-          type: string
       - name: driveItem-id
         in: path
         description: The unique identifier of driveItem
         required: true
         style: simple
         schema:
           type: string
-components: { }
+components: {}

dotnet/samples/Demos/OpenAIRealtime/Program.cs

@@ -70,7 +70,7 @@ public static async Task Main(string[] args)
         await session.AddItemAsync(
             ConversationItem.CreateUserMessage(["I'm trying to decide what to wear on my trip."]));
 
-        // Use audio file that contains a recorded question: "What's the weather like in San Francisco, California?" 
+        // Use audio file that contains a recorded question: "What's the weather like in San Francisco, California?"
         string inputAudioPath = FindFile("Assets\\realtime_whats_the_weather_pcm16_24khz_mono.wav");
         using Stream inputAudioStream = File.OpenRead(inputAudioPath);
 
@@ -165,7 +165,7 @@ await session.AddItemAsync(
                     var argumentsString = functionArgumentBuildersById[itemStreamingFinishedUpdate.ItemId].ToString();
                     var arguments = DeserializeArguments(argumentsString);
 
-                    // Create a function call content based on received data. 
+                    // Create a function call content based on received data.
                     var functionCallContent = new FunctionCallContent(
                         functionName: functionName,
                         pluginName: pluginName,
@@ -346,7 +346,7 @@ private static IEnumerable<ConversationTool> ConvertFunctions(Kernel kernel)
 
             foreach (var metadata in functionsMetadata)
             {
-                var toolDefinition = metadata.ToOpenAIFunction().ToFunctionDefinition();
+                var toolDefinition = metadata.ToOpenAIFunction().ToFunctionDefinition(false);
 
                 yield return new ConversationFunctionTool()
                 {

dotnet/src/Agents/OpenAI/Internal/AssistantThreadActions.cs

@@ -178,7 +178,7 @@ public static async IAsyncEnumerable<ChatMessageContent> GetMessagesAsync(Assist
 
         FunctionCallsProcessor functionProcessor = new(logger);
         // This matches current behavior.  Will be configurable upon integrating with `FunctionChoice` (#6795/#5200)
-        FunctionChoiceBehaviorOptions functionOptions = new() { AllowConcurrentInvocation = true, AllowParallelCalls = true };
+        FunctionChoiceBehaviorOptions functionOptions = new() { AllowConcurrentInvocation = true, AllowParallelCalls = true, AllowStrictSchemaAdherence = true };
 
         // Evaluate status and process steps and messages, as encountered.
         HashSet<string> processedStepIds = [];
@@ -412,7 +412,7 @@ public static async IAsyncEnumerable<StreamingChatMessageContent> InvokeStreamin
 
         FunctionCallsProcessor functionProcessor = new(logger);
         // This matches current behavior.  Will be configurable upon integrating with `FunctionChoice` (#6795/#5200)
-        FunctionChoiceBehaviorOptions functionOptions = new() { AllowConcurrentInvocation = true, AllowParallelCalls = true };
+        FunctionChoiceBehaviorOptions functionOptions = new() { AllowConcurrentInvocation = true, AllowParallelCalls = true, AllowStrictSchemaAdherence = true };
 
         IAsyncEnumerable<StreamingUpdate> asyncUpdates = client.CreateRunStreamingAsync(threadId, agent.Id, options, cancellationToken);
         do