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.

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

Structured output improvements (continuation of PR 5522) #5560

Merged
merged 14 commits into from
Oct 24, 2024
Merged

Structured output improvements (continuation of PR 5522) #5560

Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
0cd4422
Add support for arrays, enums and primitive types
kzu Oct 15, 2024
73c2c24
Use low level JSON API to manipulate the wrapper node
kzu Oct 16, 2024
b9b25df
Simplify and centralize how we read/set the $wrapped value
kzu Oct 16, 2024
a34e80d
Update following rebase
SteveSandersonMS Oct 23, 2024
9d9c75b
Tidy
SteveSandersonMS Oct 23, 2024
45d7d0d
Fix reference
SteveSandersonMS Oct 23, 2024
c9d861f
Make it much more reliable on Ollama
SteveSandersonMS Oct 23, 2024
f09d20b
Fix number handling
SteveSandersonMS Oct 23, 2024
3e90fad
CR feedback
SteveSandersonMS Oct 24, 2024
52f0b99
Better solution
SteveSandersonMS Oct 24, 2024
65480e7
Update src/Libraries/Microsoft.Extensions.AI/ChatCompletion/ChatClien…
SteveSandersonMS Oct 24, 2024
846702c
Avoid extra JsonElement representation
SteveSandersonMS Oct 24, 2024
b6b9bab
Have only one deserialization code path
SteveSandersonMS Oct 24, 2024
266b04b
Update unit test; add another
SteveSandersonMS Oct 24, 2024
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
Prev Previous commit
Next Next commit
Better solution
  • Loading branch information
@SteveSandersonMS
SteveSandersonMS committed Oct 24, 2024
commit 52f0b99b2ce06536e6d2752b4831118728843c14
31 changes: 20 additions & 11 deletions 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 @@ -6,6 +6,7 @@
using System.ComponentModel;
using System.Reflection;
using System.Text.Json;
using System.Text.Json.Nodes;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Shared.Diagnostics;
Expand Down Expand Up @@ -127,25 +128,23 @@ public static async Task<ChatCompletion<T>> CompleteAsync<T>(
inferenceOptions: _inferenceOptions);

var isWrappedInObject = false;
var schema = JsonSerializer.Serialize(schemaElement, AIJsonUtilities.DefaultOptions.GetTypeInfo(typeof(JsonElement)));
if (!SchemaRepresentsObject(schemaElement))
{
// For non-object-representing schemas, we wrap them in an object schema, because all
// the real LLM providers today require an object schema as the root. This is currently
// true even for providers that support native structured output.
isWrappedInObject = true;
schema = $$"""
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {{schema}}
},
"additionalProperties": false
}
""";
schemaElement = JsonSerializer.SerializeToElement(new JsonObject
SteveSandersonMS marked this conversation as resolved.
Show resolved Hide resolved
eiriktsarpalis marked this conversation as resolved.
Show resolved Hide resolved
{
{ "$schema", "https://json-schema.org/draft/2020-12/schema" },
{ "type", "object" },
{ "properties", new JsonObject { { "data", JsonElementToJsonNode(schemaElement) } } },
{ "additionalProperties", false },
}, AIJsonUtilities.DefaultOptions.GetTypeInfo(typeof(JsonObject)))!;
}

var schema = JsonSerializer.Serialize(schemaElement, AIJsonUtilities.DefaultOptions.GetTypeInfo(typeof(JsonElement)));

ChatMessage? promptAugmentation = null;
options = (options ?? new()).Clone();

Expand Down Expand Up @@ -208,4 +207,14 @@ private static bool SchemaRepresentsObject(JsonElement schemaElement)

return false;
}

private static JsonNode? JsonElementToJsonNode(JsonElement element)
{
return element.ValueKind switch
{
JsonValueKind.Array => JsonArray.Create(element),
SteveSandersonMS marked this conversation as resolved.
Show resolved Hide resolved
JsonValueKind.Object => JsonObject.Create(element),
_ => JsonValue.Create(element)
};
}
}