首页
/ Microsoft.Extensions.AI.OpenAI 项目中 JSON Schema 严格模式支持解析

Microsoft.Extensions.AI.OpenAI 项目中 JSON Schema 严格模式支持解析

2025-06-27 04:54:54作者:薛曦旖Francesca

背景介绍

在人工智能应用开发中,JSON Schema 是一种常用的数据格式规范工具,它能够定义JSON数据的结构和约束条件。Microsoft.Extensions.AI.OpenAI 是一个.NET生态中用于集成OpenAI功能的扩展库,它为开发者提供了便捷的AI服务接入方式。

问题发现

在9.1.0-preview.1.25064.3版本中,开发者发现当使用OpenAIChatClient与Azure OpenAI服务交互时,虽然支持通过JSON Schema来约束AI模型的输出格式,但缺少对"strict"参数的支持。这个参数对于确保AI输出严格符合Schema定义至关重要。

技术细节

在OpenAI的API设计中,JSON Schema响应格式可以配置三个关键参数:

  1. schema_name - 模式名称标识
  2. schema - 实际的JSON Schema定义
  3. strict - 是否严格模式(控制是否允许不符合Schema的输出)

原实现中,当开发者通过ChatResponseFormat.ForJsonSchema方法创建响应格式时,虽然正确传递了schema_name和schema参数,但strict参数被默认设置为null,而不是更安全的true值。

解决方案

开发团队已经在新版本中修复了这个问题。现在代码实现如下:

if (options.ResponseFormat is ChatResponseFormatText)
{
    result.ResponseFormat = OpenAI.Chat.ChatResponseFormat.CreateTextFormat();
}
else if (options.ResponseFormat is ChatResponseFormatJson jsonFormat)
{
    result.ResponseFormat = jsonFormat.Schema is { } jsonSchema
        ? OpenAI.Chat.ChatResponseFormat.CreateJsonSchemaFormat(
            jsonFormat.SchemaName ?? "json_schema",
            BinaryData.FromString(jsonSchema),
            jsonFormat.SchemaDescription)
        : OpenAI.Chat.ChatResponseFormat.CreateJsonObjectFormat();
}

最佳实践建议

对于需要严格JSON Schema验证的场景,开发者应该:

  1. 确保使用最新版本的Microsoft.Extensions.AI.OpenAI库
  2. 明确检查AI输出是否符合预期格式
  3. 对于关键业务逻辑,建议添加额外的验证层
  4. 在开发阶段启用严格模式以尽早发现问题

总结

JSON Schema的严格模式支持是确保AI输出质量的重要机制。Microsoft.Extensions.AI.OpenAI库的这次改进,使得.NET开发者能够更好地控制AI模型的输出行为,特别是在需要精确数据格式的企业级应用中。开发者应当了解这一特性,并在适当场景中加以利用。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
178
262
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
868
513
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
183
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
268
308
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
373
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
note-gennote-gen
一款跨平台的 Markdown AI 笔记软件,致力于使用 AI 建立记录和写作的桥梁。
TSX
83
4
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
599
58
GitNextGitNext
基于可以运行在OpenHarmony的git,提供git客户端操作能力
ArkTS
10
3