JSON schema 怎样约束模型返回结构
来源:17golang原创
时间:2026-10-25 12:15:45 241浏览 收藏
JSON Schema 要真正约束模型返回结构,需要把它交给支持结构化输出的接口,而不只是写进提示词。以 OpenAI Responses API 为例,在 text.format 中设置 type 为 json_schema、提供 schema 并启用 strict,正常完成的结构化输出便按受支持的 Schema 生成。拒绝或未完成响应仍需单独处理。
官方文档:https://developers.openai.com/api/docs/guides/structured-outputs
先确定要约束的业务对象
假设应用需要把一段用户反馈整理成工单草稿:category 表示分类,summary 是简短概括,ticket_id 是已有编号,没有编号就返回 null。先定义这些字段的含义,再决定类型与可用值,能减少接口接入后不断改字段的返工。
完整接入可以拆成约定对象、提交结构、接收状态、交给业务处理四个阶段。本文只讨论模型面向应用的文本输出,不展开工具调用。代码为未执行的教学示例,不会实际请求 API;读者需自行准备 SDK、环境变量及具备该能力的模型。
把字段约定写成最小 Schema
{
"type": "object",
"properties": {
"category": {
"type": "string",
"enum": [
"bug",
"feature",
"question"
]
},
"summary": {
"type": "string"
},
"ticket_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"category",
"summary",
"ticket_id"
],
"additionalProperties": false
}
根对象使用 object。properties 定义字段,required 列出三个字段;ticket_id 允许 string 或 null,以“字段存在但值为空”表达未提供编号。additionalProperties 为 false,限制未声明字段;category 的 enum 将分类收敛为三个机器可识别值。JSON 本身不支持注释,因此字段说明放在代码旁边。

图中的 properties、required、additionalProperties、category、summary、ticket_id 对应正文的六个节点。三个字段归入业务字段边界,其余节点归入结构规则边界;连线说明规则的归属与约束对象。遇到嵌套 object 时,也需要为该对象配置不允许额外属性的规则。
在 Responses API 中绑定结构
把上一节 JSON 读入 Python 字典并命名为 ticket_schema;如果直接写成 Python 字面量,应把 false 改为 False。再配置 OPENAI_API_KEY 和 OPENAI_MODEL,模型名应取自账号当前可用且支持 Structured Outputs 的选项。下面不固定某个模型,以免把账号可用性误写成通用保证。
import os
from openai import OpenAI
# 提前在环境变量中配置密钥与支持结构化输出的模型;不要把密钥写进源码
client = OpenAI()
model_name = os.environ["OPENAI_MODEL"]
# ticket_schema 使用上一节的 Schema 对象
response = client.responses.create(
model=model_name,
input=[
{"role": "system", "content": "将反馈归类并概括。没有工单号时返回 null,不要编造编号。"},
{"role": "user", "content": "导出按钮点击后没反应,请协助处理。"},
],
text={"format": {
"type": "json_schema",
"name": "feedback_ticket",
"strict": True, # 启用支持范围内的严格结构约束
"schema": ticket_schema,
}},
)
name 是这份输出格式的名称,schema 才是业务字段约定;strict 是格式配置的一部分,不放在业务 properties 里面。Responses 的配置位置是 text.format,不能直接把其他接口的 response_format 外层结构原样搬过来。
提示词仍要说明任务和缺失信息处理方式。例如“没有编号返回 null”是在约束业务语义;Schema 只说明编号的类型允许空值,不能替应用决定来源可信不可信。
接收端区分完成、拒绝与未完成
import json
# 示例只展示非流式 Responses 返回后的处理;请求异常由调用方单独处理
if response.status != "completed":
raise RuntimeError(f"响应未完成,状态为 {response.status}")
for item in response.output:
if item.type != "message":
continue
for part in item.content:
if part.type == "refusal":
raise RuntimeError("模型拒绝了请求,应向用户展示相应状态")
if not response.output_text:
raise RuntimeError("响应没有可解析的文本")
# 这里只解析最终文本,不从整份响应信封中猜测业务字段
ticket = json.loads(response.output_text)
# 进入业务系统前核对编号来源、分类含义与用户权限
print(ticket["category"], ticket["summary"])

response 包含 status 和 output;output 中可能包含 message,message 的内容可包括 refusal。output_text 是 SDK 提供的文本汇总便利属性,不能据此忽略响应状态。图中的 response、status、output、message、refusal、output_text 六个节点分别归入响应信封、消息内容与文本便利属性三个边界。
接收代码先要求 completed,再检查拒绝内容,最后解析文本。网络失败、认证错误和 Schema 不受支持属于请求层异常,应在调用处记录并处理,不能编造一个“成功的空工单”掩盖失败。正式产品可将这些状态转为明确的用户提示。
避免把结构正确当成事实正确
category 只能取三个值,不代表模型分类必然符合团队标准;ticket_id 是字符串,也不代表编号真实存在。业务系统仍应确认编号来源与权限,并在需要时回查记录。不要让格式符合成为执行敏感写入的唯一依据。
Structured Outputs 使用的是 JSON Schema 的受支持子集。Schema 越复杂,越需要核实所用关键字与模型支持情况;strict 模式不支持的定义可能直接导致请求报错。可先用小对象接通流程,再逐步增加确实需要的字段。
接入速查与常见疑问
| 目标 | 配置或处理位置 |
|---|---|
| 规定字段与类型 | schema 的 properties |
| 所有字段必须出现 | required |
| 允许缺失业务值 | 字段类型联合 null,字段仍必填 |
| 禁止额外字段 | 每个 object 的 additionalProperties: false |
| 绑定 Responses 输出结构 | text.format |
| 处理拒绝或截断 | 响应状态及消息内容 |
只要求“返回 JSON”够吗?不能替代接口结构约束。JSON mode 主要保证 JSON 格式,不能保证字段、类型和枚举与这份 Schema 一致。
可选字段能从 required 中省掉吗?这里的严格结构化输出要求字段必填。需要表达可选业务信息时,可以让字段接收 null,而不是直接删除它。
解析成功就能写数据库吗?应先完成与业务有关的检查。解析解决的是数据形态问题,授权、记录真实性和业务规则仍由应用负责。
官方结构化输出指南:https://developers.openai.com/api/docs/guides/structured-outputs
-
501 收藏
-
501 收藏
-
501 收藏
-
501 收藏
-
501 收藏
-
439 收藏
-
208 收藏
-
420 收藏
-
418 收藏
-
313 收藏
-
101 收藏
-
126 收藏
-
418 收藏
-
185 收藏
-
307 收藏
-
250 收藏
-
397 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 立即学习 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 立即学习 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 立即学习 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 立即学习 485次学习