ASP.NET Extensions项目中AIFunction参数验证问题的分析与解决

在ASP.NET Extensions项目的开发过程中，开发者MikeAlhayek遇到了一个关于AIFunction参数验证的典型问题。这个问题涉及到JSON Schema的严格验证模式，以及如何正确处理AI函数的调用流程。本文将深入分析问题本质，并提供完整的解决方案。

问题现象

开发者尝试创建一个名为ImportOrchardCoreRecipeTool的AIFunction，用于导入OrchardCore的JSON配方。该函数定义了一个必需的"recipe"参数，但在实际调用时遇到了验证错误：

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

根本原因分析

经过技术专家stephentoub的深入调查，发现这个问题实际上由两个关键因素导致：

1. OpenAI服务的严格验证模式：服务端默认启用了严格(strict)验证模式，对JSON Schema有额外的验证要求。

2. Schema定义不完整：原始实现中缺少了additionalProperties字段，且将recipe参数类型定义为"object"而非更合适的"string"类型。

解决方案

方案一：修正Schema定义

修正后的Schema应该包含以下关键元素：

{
    "type": "object",
    "properties": {
        "recipe": {
            "type": "string",
            "description": "A JSON object representing an OrchardCore recipe"
        }
    },
    "additionalProperties": false,
    "required": ["recipe"]
}

主要修改点：

• 将recipe的类型从"object"改为"string"
• 显式添加了additionalProperties字段
• 保持了required数组中的recipe参数

方案二：禁用严格验证模式

如果暂时需要保持原有Schema结构，可以通过设置AdditionalProperties来禁用严格验证：

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

函数调用处理

开发者还遇到了函数未被调用的现象，这是因为：

1. AI模型返回的是函数调用请求(function call request)，需要开发者手动处理或使用FunctionInvokingChatClient来自动处理。

2. 正确的调用流程应该包含对函数调用请求的响应处理，确保函数能够被正确触发。

最佳实践建议

1. Schema设计原则：

   • 明确定义所有参数类型
   • 包含additionalProperties声明
   • 为每个参数提供清晰的description

2. 函数调用处理：

   • 实现完整的函数调用生命周期处理
   • 考虑使用内置的FunctionInvokingChatClient简化流程
   • 添加适当的错误处理和日志记录

3. 版本兼容性：

   • 注意不同版本间的行为差异
   • 及时关注官方更新和修复

总结

这个问题展示了在ASP.NET Extensions项目中实现AIFunction时可能遇到的典型挑战。通过理解JSON Schema的验证规则和函数调用机制，开发者可以构建更健壮的AI集成功能。随着项目的不断演进，这类问题有望在框架层面得到更好的默认处理，但掌握这些底层原理对于开发复杂AI应用仍然至关重要。