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

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

2025-06-27 22:38:15作者:薛曦旖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模型的输出行为,特别是在需要精确数据格式的企业级应用中。开发者应当了解这一特性,并在适当场景中加以利用。

登录后查看全文

项目优选

收起
kernelkernel
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
471
465
kernelkernel
deepin linux kernel
C
32
16
atomcodeatomcode
Claude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get Started
Rust
2.09 K
218
ops-nnops-nn
本项目是CANN提供的神经网络类计算算子库,实现网络在NPU上加速计算。
C++
700
1.4 K
docsdocs
暂无描述
Dockerfile
780
5.08 K
pytorchpytorch
Ascend Extension for PyTorch
Python
758
968
flutter_flutterflutter_flutter
本仓库是 Flutter SDK 与 Flutter Engine 的 OpenHarmony 适配版本,由 CPF-Flutter 团队维护。开发者可使用熟悉的 Flutter 技术栈开发 OpenHarmony 应用,3.35.7 及以后的适配版本可基于本仓库源码构建支持 OpenHarmony 的 Flutter Engine。
Dart
1.04 K
271
ops-transformerops-transformer
本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。
C++
880
2.03 K
mindquantummindquantum
MindQuantum is a general software library supporting the development of applications for quantum computation.
Python
183
111
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.11 K
682