I think 'CreateJsonSchemaFormat()' is not working

[helloSalmon]

Hello!
I know this should be in the bug issue. But before I try it there, I want to make sure I'm not doing something wrong.

        ChatCompletionOptions jsonOptions = new()
        {
            ResponseFormat = ChatResponseFormat.CreateJsonSchemaFormat(
                name: "Character_Sheet",
                jsonSchema: data,
                description: "This is about json schema format",
                strictSchemaEnabled: true)
        };

When I try this code and check jsonOptions.ResponseFormat.ToString(), it only returns '{"type":"json_schema"}'.
Of course, I already check that 'data' variable has correct value.

If I try chatCompletion with that jsonOptions like,

ChatCompletion chatCompletion = await chatClient.CompleteChatAsync(        
            superMessages
            ,jsonOptions);

it return HTTP 400 error that response_format.json_schema is missing.

Is there something that I missed?

Thank you for your time.

[trrwilson]

Hello, @helloSalmon !

Could you share a bit more of your code that includes the creation of the data variable used for the schema? We're unfortunately unable to reproduce this right now on our end; as an example, the following snippet:

ChatResponseFormat format = ChatResponseFormat.CreateJsonSchemaFormat(
    "Character_Sheet",
    BinaryData.FromString("""
        {
            "type": "object",
            "properties": {
            },
            "additionalProperties": false
        }
        """),
    "test description",
    strictSchemaEnabled: true);
ChatCompletionOptions options = ModelReaderWriter.Read<ChatCompletionOptions>(BinaryData.FromString("""
    {
        "messages": [ { "role": "user", "content": "hello world" } ]
    }
    """));
options.ResponseFormat = format;
Console.WriteLine(ModelReaderWriter.Write(options).ToString());

Outputs the expected (albeit unformatted) JSON:

    {"messages":[{"role":"user","content":"hello world"}],"model":null,"response_format":{"json_schema":{"description":"This is about json schema format","name":"Character_Sheet","schema":{
        "type": "object",
        "properties": {
        },
        "additionalProperties": false
    },"strict":true},"type":"json_schema"}}

options.ResponseFormat.ToString() also generates the expected subset of the above (the object under response_format).

If you can share a bit more of the code context, we'd love to take a look!

[helloSalmon]

First of all, thank you very much for your help.

Let me explain my situation in a little more detail.
I use Newtonsoft.Json library to create JSON Schema. And my project is being built with Unity, so I use C# 9.0 and .NET Framework 4.7.1 version.
Below is my code aboud JSON schema:

using System.Collections.Generic;
using UnityEngine;
using System;
using OpenAI.Chat;
using System.Text;
using System.IO;
using System.ClientModel;
using System.Text.Json;
using System.ComponentModel;
using Newtonsoft.Json.Schema;
using Newtonsoft.Json.Schema.Generation;
using Newtonsoft.Json;
using OpenAI;

[System.Serializable]
public class ExploererFormat
{
    public string name { get; set; }
    public int age { get; set; }

    [Description("The character's background story.")]
    public string background { get; set; }
}
---
    public void CreateSchema() //This is function to create json schema from ExploererFormat class
    {
        JSchemaGenerator generator = new JSchemaGenerator();
        generator.DefaultRequired = Required.Always; // required by OpenAI

        JSchema schema = generator.Generate(typeof(ExploererFormat));
        schema.AllowAdditionalProperties = false; // required by OpenAI
        schema.SchemaVersion = new Uri("https://json-schema.org/draft/2020-12/schema");

        schemaString = schema.ToString();

        Debug.Log(schemaString); //This is similar to Console.Writeline. This returns JSON schema correctly.
    }

    public async void CreateRandom()
    {
        BinaryData data = BinaryData.FromString(schemaString);
        if (data == null ) { Debug.Log("Why this is empty?"); }
        
        ChatCompletionOptions jsonOptions = new()
        {
            ResponseFormat = ChatResponseFormat.CreateJsonSchemaFormat(
                name: "Character_Sheet",
                jsonSchema: data,
                description: "This is about json schema format",
                strictSchemaEnabled: true)
        };
        Debug.Log(jsonOptions.ResponseFormat.ToString()); // This only returns '{"type":"json_schema"}'

        var superMessages = new List<ChatMessage>
        {
            ChatMessage.CreateUserMessage("As a novel writer, create a random novel character with the following instructions: 1. All outputs must be written in English. 2. Genre of the novel is Ocean Adventure.")
        };

        ChatCompletion chatCompletion = await chatClient.CompleteChatAsync(        
            superMessages
            ,jsonOptions);

        Debug.Log(chatCompletion.ToString());

        using JsonDocument jsonDocument = JsonDocument.Parse(chatCompletion.ToString());
        string finalContent = jsonDocument.RootElement
            .GetProperty(Encoding.UTF8.GetBytes("choices"))[0]
            .GetProperty(Encoding.UTF8.GetBytes("message"))
            .GetProperty(Encoding.UTF8.GetBytes("content"))
            .GetString();
}

I hope this is enough to check the problem.

Again, thank you for your help.

---

P.S.
Trying to change schema's type value from object to json_schema by string.Replace has been failed.

And when I try Debug.Log(ModelReaderWriter.Write(jsonOptions).ToString());, it returns this:
{"messages":[{"role":"user","content":"hello world"}],"model":null,"response_format":{"type":"json_schema"}}

[joseharriaga]

Just to follow up, here's a link to the GitHub Issue where this was resolved: 🔗 #193

Thanks!