Skip to content

Disable default required property schema generation and OpenAI strict mode. #6285

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.

Sign up for GitHub

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

Merged
merged 9 commits into from
Apr 25, 2025
Merged

Disable default required property schema generation and OpenAI strict mode. #6285

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
25a8b4e
Disable default required property schema generation and OpenAI strict…
eiriktsarpalis Apr 11, 2025
7ac77ac
Default strictness to OpenAI client defaults.
eiriktsarpalis Apr 11, 2025
e4faa65
Fix a few failing tests.
eiriktsarpalis Apr 11, 2025
513e8aa
Undo a number of additional changes made by https://github.com/dotnet…
eiriktsarpalis Apr 11, 2025
850aee9
Revert change to structured output defaults.
eiriktsarpalis Apr 24, 2025
29c06a2
Incorporate more test fixes.
eiriktsarpalis Apr 24, 2025
d54f41e
Address feedback.
eiriktsarpalis Apr 24, 2025
2a04e87
Tweak strict mode signature, fix failing tests.
eiriktsarpalis Apr 25, 2025
ef8285c
Roll back schemaIsStrict flag from ChatResponseFormat.
eiriktsarpalis Apr 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Libraries/Microsoft.Extensions.AI.Abstractions/Utilities/AIJsonSchemaCreateOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,5 +55,5 @@ public sealed record class AIJsonSchemaCreateOptions
/// <summary>
/// Gets a value indicating whether to mark all properties as required in the schema.
/// </summary>
public bool RequireAllProperties { get; init; } = true;
public bool RequireAllProperties { get; init; }
}
3 changes: 1 addition & 2 deletions src/Libraries/Microsoft.Extensions.AI.AzureAIInference/AzureAIInferenceChatClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,8 +370,7 @@ private ChatCompletionsOptions ToAzureAIOptions(IEnumerable<ChatMessage> chatCon
["required"] = BinaryData.FromBytes(JsonSerializer.SerializeToUtf8Bytes(tool.Required, JsonContext.Default.ListString)),
["additionalProperties"] = _falseString,
},
json.SchemaDescription,
jsonSchemaIsStrict: true);
json.SchemaDescription);
}
else
{
Expand Down
12 changes: 5 additions & 7 deletions src/Libraries/Microsoft.Extensions.AI.OpenAI/OpenAIChatClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -611,8 +611,7 @@ private static ChatCompletionOptions ToOpenAIOptions(ChatOptions? options)
jsonFormat.SchemaName ?? "json_schema",
BinaryData.FromBytes(
JsonSerializer.SerializeToUtf8Bytes(jsonSchema, ChatClientJsonContext.Default.JsonElement)),
jsonFormat.SchemaDescription,
jsonSchemaIsStrict: true) :
jsonFormat.SchemaDescription) :
OpenAI.Chat.ChatResponseFormat.CreateJsonObjectFormat();
}
}
Expand All @@ -623,11 +622,10 @@ private static ChatCompletionOptions ToOpenAIOptions(ChatOptions? options)
/// <summary>Converts an Extensions function to an OpenAI chat tool.</summary>
private static ChatTool ToOpenAIChatTool(AIFunction aiFunction)
{
// Default strict to true, but allow to be overridden by an additional Strict property.
bool strict =
!aiFunction.AdditionalProperties.TryGetValue("Strict", out object? strictObj) ||
strictObj is not bool strictValue ||
strictValue;
bool? strict =
aiFunction.AdditionalProperties.TryGetValue("strictJsonSchema", out object? strictObj) &&
strictObj is bool strictValue ?
strictValue : null;

// Map to an intermediate model so that redundant properties are skipped.
var tool = JsonSerializer.Deserialize(aiFunction.JsonSchema, ChatClientJsonContext.Default.ChatToolJson)!;
Expand Down
3 changes: 1 addition & 2 deletions src/Libraries/Microsoft.Extensions.AI.OpenAI/OpenAIResponseChatClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -418,8 +418,7 @@ private static ResponseCreationOptions ToOpenAIResponseCreationOptions(ChatOptio
ResponseTextFormat.CreateJsonSchemaFormat(
jsonFormat.SchemaName ?? "json_schema",
BinaryData.FromBytes(JsonSerializer.SerializeToUtf8Bytes(jsonSchema, ResponseClientJsonContext.Default.JsonElement)),
jsonFormat.SchemaDescription,
jsonSchemaIsStrict: true) :
jsonFormat.SchemaDescription) :
ResponseTextFormat.CreateJsonObjectFormat(),
};
}
Expand Down
3 changes: 2 additions & 1 deletion src/Libraries/Microsoft.Extensions.AI/ChatCompletion/ChatClientStructuredOutputExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ public static class ChatClientStructuredOutputExtensions
{
IncludeSchemaKeyword = true,
DisallowAdditionalProperties = true,
IncludeTypeInEnumSchemas = true
IncludeTypeInEnumSchemas = true,
RequireAllProperties = true,
};

/// <summary>Sends chat messages, requesting a response matching the type <typeparamref name="T"/>.</summary>
Expand Down
26 changes: 12 additions & 14 deletions test/Libraries/Microsoft.Extensions.AI.Abstractions.Tests/Utilities/AIJsonUtilitiesTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ public static void AIJsonSchemaCreateOptions_DefaultInstance_ReturnsExpectedValu
Assert.True(options.IncludeTypeInEnumSchemas);
Assert.True(options.DisallowAdditionalProperties);
Assert.False(options.IncludeSchemaKeyword);
Assert.True(options.RequireAllProperties);
Assert.False(options.RequireAllProperties);
Assert.Null(options.TransformSchemaNode);
}

Expand Down Expand Up @@ -148,11 +148,11 @@ public static void CreateJsonSchema_DefaultParameters_GeneratesExpectedJsonSchem
"enum": ["A", "B"]
},
"Value": {
"description": "Default value: \"defaultValue\"",
"type": ["string", "null"]
"type": ["string", "null"],
"default": "defaultValue"
}
},
"required": ["Key", "EnumValue", "Value"],
"required": ["Key", "EnumValue"],
"additionalProperties": false
}
""").RootElement;
Expand All @@ -168,7 +168,7 @@ public static void CreateJsonSchema_OverriddenParameters_GeneratesExpectedJsonSc
JsonElement expected = JsonDocument.Parse("""
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "alternative description",
"description": "alternative description (Default value: null)",
"type": "object",
"properties": {
"Key": {
Expand All @@ -179,12 +179,11 @@ public static void CreateJsonSchema_OverriddenParameters_GeneratesExpectedJsonSc
"enum": ["A", "B"]
},
"Value": {
"type": ["string", "null"],
"default": "defaultValue"
"description": "Default value: \"defaultValue\"",
"type": ["string", "null"]
}
},
"required": ["Key", "EnumValue"],
"default": null
"required": ["Key", "EnumValue", "Value"]
}
""").RootElement;

Expand All @@ -193,7 +192,7 @@ public static void CreateJsonSchema_OverriddenParameters_GeneratesExpectedJsonSc
IncludeTypeInEnumSchemas = false,
DisallowAdditionalProperties = false,
IncludeSchemaKeyword = true,
RequireAllProperties = false,
RequireAllProperties = true,
};

JsonElement actual = AIJsonUtilities.CreateJsonSchema(
Expand Down Expand Up @@ -224,11 +223,11 @@ public static void CreateJsonSchema_UserDefinedTransformer()
"enum": ["A", "B"]
},
"Value": {
"description": "Default value: \"defaultValue\"",
"type": ["string", "null"]
"type": ["string", "null"],
"default": "defaultValue"
}
},
"required": ["Key", "EnumValue", "Value"],
"required": ["Key", "EnumValue"],
"additionalProperties": false
}
""").RootElement;
Expand Down Expand Up @@ -270,7 +269,6 @@ public static void CreateJsonSchema_FiltersDisallowedKeywords()
"type": "string"
}
},
"required": ["Date","TimeSpan","Char"],
"additionalProperties": false
}
""").RootElement;
Expand Down
3 changes: 1 addition & 2 deletions ...braries/Microsoft.Extensions.AI.AzureAIInference.Tests/AzureAIInferenceChatClientTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -385,8 +385,7 @@ public async Task ResponseFormat_JsonSchema_NonStreaming()
"required":["description"],
"additionalProperties":false
},
"description":"An object with a description",
"strict":true
"description":"An object with a description"
}
}
}
Expand Down
2 changes: 0 additions & 2 deletions test/Libraries/Microsoft.Extensions.AI.OpenAI.Tests/OpenAIChatClientTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -662,7 +662,6 @@ public async Task FunctionCallContent_NonStreaming()
"function": {
"description": "Gets the age of the specified person.",
"name": "GetPersonAge",
"strict":true,
"parameters": {
"type": "object",
"required": [
Expand Down Expand Up @@ -868,7 +867,6 @@ public async Task FunctionCallContent_Streaming()
"function": {
"description": "Gets the age of the specified person.",
"name": "GetPersonAge",
"strict":true,
"parameters": {
"type": "object",
"required": [
Expand Down
Loading