JSON 模式与工具调用输出
使用 response_format={'type':'json_object'} 或单次工具调用,强制生成可由机器解析的输出。
JSON 模式与工具调用输出 是 CoddyKit 上的免费 AI Agents 课时。 这是第 1 节课,共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 AI Agents 学习路径的一部分,你的进度在网页和 CoddyKit 应用中同步。 AI Agents 课程共包含 4 节课。
对结构化输出的需求
LLM 生成的自由文本不适合代码处理。生产环境中的智能体需要可解析的输出:JSON、XML、函数参数——绝不能只是“答案是……”
JSON 模式(OpenAI)
告诉模型“始终返回 JSON”:
from openai import OpenAI
client = OpenAI()
response = client.chat.completions.create(
model='gpt-4o-mini',
messages=[
{'role': 'system', 'content': 'Return a JSON object with name and age.'},
{'role': 'user', 'content': 'Alice, 30 years old.'}
],
response_format={'type': 'json_object'}
)
import json
data = json.loads(response.choices[0].message.content)JSON 模式的注意事项
JSON 模式只能保证返回有效的 JSON,不能保证符合您的 SHAPE。模型可能返回 {} 或 {"foo": "bar"}。请始终同时验证结构是否正确。
结构化输出(严格模式)
OpenAI 结构化输出可确保响应符合 JSON 架构:
schema = {
'name': 'person',
'schema': {
'type': 'object',
'properties': {
'name': {'type': 'string'},
'age': {'type': 'integer'}
},
'required': ['name', 'age'],
'additionalProperties': False
},
'strict': True
}
response = client.chat.completions.create(
model='gpt-4o-2024-08-06',
messages=...,
response_format={'type': 'json_schema', 'json_schema': schema}
)严格模式的工作原理
严格模式会约束解码器,使模型实际上无法生成无效令牌。输出将 100% 符合架构。
将工具调用作为结构化输出
您可以强制执行特定的工具调用,以此提取结构化数据:
tools = [{'type': 'function', 'function': {
'name': 'submit_person',
'parameters': {
'type': 'object',
'properties': {'name': {'type': 'string'}, 'age': {'type': 'integer'}},
'required': ['name', 'age']
}
}}]
response = client.chat.completions.create(
model='gpt-4o-mini',
messages=...,
tools=tools,
tool_choice={'type': 'function', 'function': {'name': 'submit_person'}}
)
args = json.loads(response.choices[0].message.tool_calls[0].function.arguments)将 Anthropic 工具使用作为输出
Anthropic 也采用相同的模式,并使用 tool_choice="tool":
tool_choice = {'type': 'tool', 'name': 'submit_person'}
print(tool_choice)
通过预填充生成 JSON(Anthropic)
对于不使用工具的 Claude,请预先填充助手回合中的 {
messages = [
{'role': 'user', 'content': 'Give me JSON for Alice, 30.'},
{'role': 'assistant', 'content': '{'}
]
# Output starts with { and likely produces valid JSON.
for m in messages:
print(f"{m['role']}: {m['content']}")
print("Output starts with { and likely produces valid JSON.")
Pydantic + 严格模式
OpenAI Python SDK 提供了一个 Pydantic 快捷方式:
from pydantic import BaseModel
class Person(BaseModel):
name: str
age: int
response = client.beta.chat.completions.parse(
model='gpt-4o-2024-08-06',
messages=...,
response_format=Person
)
person = response.choices[0].message.parsed
# Pydantic instance, type-safe常见问题
- 不使用严格模式的 JSON 模式——模型可能返回错误的结构
- 在严格模式中忘记设置
additionalProperties: false - 必填字段没有列在 "required" 数组中
- 严格模式仅适用于 gpt-4o-2024-08-06 及更高版本
结构化输出的成本
严格模式会因语法约束解码而产生少量额外开销,但与质量收益相比可以忽略不计。只要结构很重要,就应始终启用。
结合验证
即使是严格输出,也应在之后通过 Pydantic 进行验证。这是纵深防御的一环,可以捕获超出范围的整数等边界情况。
严格模式的保证
OpenAI 结构化输出(严格模式)能保证什么?
回顾
JSON 模式适用于宽松的结构,严格输出适用于保证结构,工具调用可以达到相同效果,Anthropic 则可通过预填充支持 Claude。完成后始终进行验证。
用 AI 导师学习 AI Agents — 免费
在浏览器中编写并运行真实代码,获得全天候 AI 导师的即时帮助,并在网页或应用中继续学习。
- 课程
- 60
- 课程
- 239
常见问题解答
「JSON 模式与工具调用输出」课时是免费的吗?
是的 — 「JSON 模式与工具调用输出」的完整文本可在网页上免费阅读。要进行交互式练习(内置代码编辑器和全天候 AI 导师)并解锁 AI Agents 课程的其余内容,请升级到 CoddyKit PRO。 AI Agents 课程共包含 4 节课。
「JSON 模式与工具调用输出」这节课中我会学到什么?
使用 response_format={'type':'json_object'} 或单次工具调用,强制生成可由机器解析的输出。 你通过在浏览器中直接运行的动手代码来练习 AI Agents,全天候 AI 导师会在你学习这节课的过程中回答你的问题。
学习 AI Agents 需要有经验吗?
无需任何先前经验。CoddyKit 上的 AI Agents 课程适合初学者到高级学习者,你可以从这里开始或从头开始,按照自己的节奏学习。 这是第 1 节课,共 4 节。
「JSON 模式与工具调用输出」课时需要多长时间?
大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动,所以你能稳步进步,并在网页和应用中从离开的地方继续。
我能在这节 AI Agents 课中编写并运行代码吗?
能。每节 AI Agents 课都包含内置代码编辑器,你可以在浏览器中直接编写并运行真实代码,并获得即时 AI 反馈 — 无需本地设置。
此课程中的所有课时
- JSON 模式与工具调用输出
- Pydantic 模式验证
- 修复格式错误输出的循环
- Instructor / Outlines:保证结构