Unable to define an AIFunction with a required parameter.

[MikeAlhayek]

Description

I'm trying to create an AIFunction that allows the user to import a JSON recipe. However, during the chat request, I encounter the following error:

Invalid schema for function 'import_recipe': In context=(), 'required' must be an array that includes every key in properties. Extra required key 'recipe' supplied.

It seems a bit misleading, as I am providing the recipe parameter and including it in the required array. Could this be a misinterpretation of the schema requirements, or is there something I'm missing?

Reproduction Steps

Define the AIFunction provided above and invoke it in a chat request using a prompt like the one below.

public sealed class ImportOrchardCoreRecipeTool : AIFunction
{
    public override string Name => "import_recipe";

    public override string Description => "Imports a dynamic OrchardCore JSON recipe";

    public override JsonElement JsonSchema { get; }

    public ImportOrchardCoreRecipeTool()
    {
        var metadata = new JsonObject
        {
            {"type", "object"},
            {"properties", new JsonObject
                {
                    { "recipe", new JsonObject
                        {
                            {"type", "object" },
                            {"description", "A JSON object representing an OrchardCore recipe" },
                        }
                    }
                }
            },
            {"required", new JsonArray("recipe") },
            {"return_type", new JsonObject
                {
                    {"type", "boolean"},
                    {"description", "The result of the import process. True representing a successful import while false failed."},
                }
            },
        };

        JsonSchema = JsonSerializer.Deserialize<JsonElement>(metadata);
    }

    protected override ValueTask<object?> InvokeCoreAsync(AIFunctionArguments arguments, CancellationToken cancellationToken)
    {
        ArgumentNullException.ThrowIfNull(arguments);

        if (!arguments.TryGetValue("recipe", out var data))
        {
            return ValueTask.FromResult<object?>(false);
        }

        var recipe = ConvertToJsonObject(data!);

        if (recipe == null)
        {
            return ValueTask.FromResult<object?>(false);
        }

        Console.WriteLine($"The {Name} function was invoked.");

        return ValueTask.FromResult<object?>(true);
    }

    private static JsonObject? ConvertToJsonObject(object data)
    {
        JsonObject? recipe = null;

        if (data is JsonObject obj)
        {
            recipe = obj;
        }
        else
        {
            string? json;

            if (data is JsonElement jsonElement)
            {
                json = jsonElement.GetString();
            }
            else
            {
                json = data.ToString();
            }

            try
            {
                recipe = JsonSerializer.Deserialize<JsonObject>(json);
            }
            catch { }
        }

        return recipe;
    }
}

Create a OrchardCore content type named "Employee" with fields for First Name, Last Name, Biography, and Email Address.

Expected behavior

I expect that the AI model would invoke my tool by providing recipe as a argument.

Actual behavior

Exception:

Invalid schema for function 'import_recipe': In context=(), 'required' must be an array that includes every key in properties. Extra required key 'recipe' supplied.

Regression?

No response

Known Workarounds

No response

Configuration

No response

Other information

I am using 9.4.0-preview.1.25207.5 packages.

[stephentoub]

Can you share a minimal but complete repro?

[MikeAlhayek]

@stephentoub I just realized that I forgot to share the function in the issue above. It's there now.

But here is a repo https://github.com/MikeAlhayek/AIToolCallingSample

[stephentoub]

Seems like the service is sending down a bogus error message. I think what it's really complaining about is a) the lack of an additionalProperties property on your object, and b) the "object" type on recipe. When I change your example's ctor to this:

    public ImportOrchardCoreRecipeTool()
    {
        JsonSchema = JsonSerializer.Deserialize<JsonElement>("""
            {
                "type": "object",
                "properties": {
                    "recipe": {
                        "type": "string",
                        "description": "A JSON object representing an OrchardCore recipe"
                    }
                },
                "additionalProperties": false,
                "required": ["recipe"]
            }
            """);
    }

it runs fine.

[stephentoub]

That said, the extra validation in the OpenAI service is happening because of a change made that sets "strict" to true by default. That change is being reverted in #6285, but in the meantime you can add this to your AIFunction-derived type and it'll get turned off:

    public override IReadOnlyDictionary<string, object?> AdditionalProperties { get; } = new Dictionary<string, object?>()
    {
        ["Strict"] = false,
    };

cc: @eiriktsarpalis, @SteveSandersonMS

[MikeAlhayek]

@stephentoub thanks for your feedback!

For some reason, the response to the prompt which should be calling the function is null and the function is never invoked.

My prompt is this

Create a OrchardCore content type named "Employee" with fields for First Name, Last Name, Biography, and Email Address.

At this point I expect the InvokeCoreAsync method to be called and recipe property to be passed.

[stephentoub]

Most likely it's because you're getting back a function call request. You either need to handle that manually, or you need to add a FunctionInvokingChatClient into your pipeline to do it for you automatically.

[MikeAlhayek]

Indeed that was it. I updated the repo to the working version. I am not sure if you want to close this issue or keep it open until #6285 is merged. Feel free to close it if that is the recommendation.

[stephentoub]

Glad you got it working.