003-JSON-Output-Control

JSON 格式输出控制如何让 AI 每次都返回完美的结构化数据摘要大模型天生不擅长输出严格的 JSON 格式。本文教你如何通过 Schema 验证、自动修复和提示工程确保 AI 每次都返回合法、可用的结构化数据。引言你让 AI 从一段文本中提取信息要求返回 JSON 格式。结果它给你返回了好的这是您要的结果 { name: 张三, age: 25, } 希望对你有帮助三个问题同时出现前后有多余文字——无法直接用json.loads()解析末尾多了一个逗号——JSON 不允许被 Markdown 代码块包裹——需要额外处理如果你在做 API 集成、工作流编排或工具调用这种差不多但不完全对的输出会让整个系统崩溃。为什么 AI 就是做不对一个简单的 JSON如何让 AI 稳定输出合法的结构化数据本文将提供一套完整的解决方案从提示工程到自动修复让你再也不用手动清洗 AI 的 JSON 输出。核心概念为什么 LLM 天然做不好 JSON语言模型本质上是基于概率的序列生成器逐 token 预测下一个词。它不理解语法只在做概率猜测。而 JSON 是一种严格的上下文无关格式需要匹配的括号{}双引号包裹的键名正确的逗号分隔且不能有末尾逗号合法的数值和字符串类型当模型自回归生成时极易在某一步猜错导致整个 JSON 结构崩溃。常见错误类型错误类型示例出现频率括号/引号不匹配{name: Alice⭐⭐⭐⭐⭐末尾逗号{a: 1, b: 2,}⭐⭐⭐⭐键名缺少引号{name: Alice}⭐⭐⭐Markdown 代码块 json {…} ⭐⭐⭐⭐⭐前后多余文字好的结果如下{...}⭐⭐⭐⭐⭐类型错误{age: 25}应为数字⭐⭐⭐关键术语JSON Schema描述 JSON 结构的标准格式定义字段类型、必填项、枚举值等自动修复通过规则或库修复轻微格式错误无需重新调用模型重试策略当修复失败时告知模型错误并要求重新生成Function CallingOpenAI 等厂商提供的结构化输出模式比纯 Prompt 更可靠原理深入三层防护体系要确保 JSON 输出的稳定性需要构建三层防护第一层提示工程预防 │ ├── 在 Prompt 中明确 Schema ├── 使用 Few-shot 示例 └── 强调只输出 JSON │ 第二层自动修复补救 │ ├── 移除 Markdown 标记 ├── 引号修复 ├── 提取 JSON 子串 └── 使用专用修复库 │ 第三层重试生成兜底 │ ├── 反馈错误信息给模型 └── 强化约束后重新调用核心原则先预防再修复最后重试。自动修复策略详解当模型返回的 JSON 有轻微错误时可以通过规则自动修复无需重新调用模型省钱省时间策略方法适用场景移除 Markdown正则替换 json 和 模型习惯加代码块标记引号修复单引号替换为双引号模型用 Python 风格字符串提取 JSON 子串找第一个{到最后一个}前后有多余解释文字专用修复库json_repair、demjson、json5复杂错误规则无法处理代码示例示例 1JSON Schema Prompt 构建importjsonclassJSONOutputController:JSON 格式输出控制器# 情感分析响应 SchemaSENTIMENT_SCHEMA{type:object,properties:{sentiment:{type:string,enum:[positive,negative,neutral]},confidence:{type:number,minimum:0,maximum:1},reasons:{type:array,items:{type:string}}},required:[sentiment,confidence,reasons]}staticmethoddefbuild_json_prompt(prompt:str,schema_name:strSENTIMENT)-str:构建要求 JSON 输出的 Promptschemas{SENTIMENT:JSONOutputController.SENTIMENT_SCHEMA}schemaschemas[schema_name]returnf请严格按照以下 JSON Schema 返回结果不要有任何其他文字{json.dumps(schema,indent2,ensure_asciiFalse)}用户输入{prompt}请只返回 JSON 格式的结果示例 2验证并自动修复 JSONimportreimportjsonfromtypingimportOptional,Dictdefvalidate_and_fix_json(raw_text:str)-Optional[Dict]:验证并尝试修复 JSON 格式# 1. 移除 Markdown 代码块标记cleanedre.sub(r(?:json)?\n?(.*?)\n?,r\1,raw_text,flagsre.DOTALL)cleanedcleaned.strip()# 2. 尝试直接解析try:returnjson.loads(cleaned)exceptjson.JSONDecodeError:pass# 3. 引号修复单引号 → 双引号try:returnjson.loads(cleaned.replace(,))exceptjson.JSONDecodeError:pass# 4. 提取 JSON 子串忽略前后多余文字try:matchre.search(r\{.*\},cleaned,re.DOTALL)ifmatch:returnjson.loads(match.group())exceptjson.JSONDecodeError:passreturnNone# 修复失败# 测试三种常见场景test_cases[# 场景 A标准 JSON{sentiment: positive, confidence: 0.95},# 场景 B带 Markdown 标记json\n{sentiment: positive, confidence: 0.88}\n,# 场景 C含前后多余文字好的这是您的结果\n\n{sentiment: neutral, confidence: 0.60}\n\n希望这对你有帮助,]fori,caseinenumerate(test_cases):resultvalidate_and_fix_json(case)print(f场景{i1}{result})输出场景 1{sentiment: positive, confidence: 0.95} 场景 2{sentiment: positive, confidence: 0.88} 场景 3{sentiment: neutral, confidence: 0.6}三种常见错误全部自动修复成功实战应用什么时候用自动修复什么时候重试错误严重程度处理方式原因轻微多余文字、引号、Markdown自动修复无需重新调用省钱中等缺少字段、类型错误视情况如果业务允许默认值可修复严重结构完全错误重试生成自动修不了必须让模型重来推荐工具库库名用途安装命令json_repair专门修复损坏的 JSONpip install json_repairdemjson容错的 JSON 解析器pip install demjson3json5支持更宽松的语法pip install json5Pydantic强类型验证 自动修复pip install pydantic最佳组合方案Prompt 中强调格式 → 调用模型 → json_repair 修复 → Pydantic 验证 → 失败重试这是生产环境中最稳定、最省钱的方案。最佳实践根据知识库和源码中的最佳实践总结出以下5 条核心技巧1. 明确要求输出格式✅ 只输出一个 JSON 对象不要包含任何解释或代码块标记。 ❌ 请以 JSON 格式返回。太模糊模型可能加解释2. 使用 JSON Schema 定义结构在 Prompt 中明确 Schema让模型知道需要什么字段和类型。Schema 就是你的合同。3. 提供 Few-shot 示例1-2 个正确格式的示例比任何解释都有效。4. 自动修复 重试策略# 伪代码resultcall_llm(prompt)fixedauto_fix_json(result)iffixedisNone:# 修复失败重试resultcall_llm(prompt\n\n格式错误请重新返回纯 JSON。)5. 优先使用 Function Calling如果你的平台支持如 OpenAIFunction Calling 比纯 Prompt 更可靠。它通过 API 级别的约束强制输出合法 JSON。总结大模型天生做不好 JSON但通过三层防护体系可以让它变得非常可靠Schema 定义 → 自动修复 → 重试兜底核心要点回顾LLM 是概率生成器不保证 JSON 语法正确性三层防护提示预防 → 自动修复 → 重试兜底自动修复处理 90% 的常见错误无需重新调用Function Calling 是最可靠的方案如果平台支持