验证工具输出(Pydantic)
让每个工具输出都经过 Pydantic 模型解析——遇到格式错误的响应时立即明确失败。
验证工具输出(Pydantic) 是 CoddyKit 上的免费 AI Agents 课时。 这是第 4 节课,共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 AI Agents 学习路径的一部分,你的进度在网页和 CoddyKit 应用中同步。 AI Agents 课程共包含 4 节课。
本课时的部分内容尚未翻译,以英文显示。
信任但要验证
工具输出来自外部世界——API、网页和模型。格式错误或出乎意料的响应可能会导致代理崩溃,或者更糟糕的是,悄悄地将错误数据输入 LLM。
请根据模式验证每个工具输出。
Pydantic 模型
定义预期的数据结构:
from pydantic import BaseModel, HttpUrl
class SearchResult(BaseModel):
title: str
url: HttpUrl
snippet: str
score: float = 0.0Validate at the Boundary
from pydantic import ValidationError
def search(query):
raw = requests.post('https://api.tavily.com/search', json={'query': query}).json()
results = []
for r in raw.get('results', []):
try:
results.append(SearchResult.model_validate(r))
except ValidationError as e:
log.warning('Bad search result skipped: %s', e)
return results使用模型验证列表
验证整个响应:
from pydantic import BaseModel
class SearchResponse(BaseModel):
results: list[SearchResult]
response = SearchResponse.model_validate(raw)字段验证器
在字段内部执行自定义检查:
from pydantic import field_validator
class SearchResult(BaseModel):
score: float
@field_validator('score')
@classmethod
def score_in_range(cls, v):
if not 0 <= v <= 1:
raise ValueError('score out of [0,1]')
return v严格与宽松
默认情况下,Pydantic 会强制转换类型(如果可能,会将字符串转换为整数)。如需进行严格检查:
from pydantic import StrictInt
class User(BaseModel):
age: StrictInt # rejects '25' (string)Default Values for Missing Fields
class Tool(BaseModel):
name: str
description: str = 'No description provided' # fallback验证 LLM 结构化输出
强制模型返回符合 Pydantic 模式的 JSON——请参阅“结构化输出”课程。在边界处再次验证,以实现纵深防御。
验证工具参数
在执行之前验证模型的 tool_call.arguments:
class SearchArgs(BaseModel):
query: str
k: int = 5
args = SearchArgs.model_validate_json(tool_call.function.arguments)
results = search(args.query, args.k)将验证错误作为工具结果
如果验证失败,请将错误返回给模型,以便模型使用经过修正的参数进行重试:
try:
args = SearchArgs.model_validate_json(...)
except ValidationError as e:
return {'error': f'Invalid arguments: {e}'}模式版本控制
当工具的输出模式发生变化时,请为其设置版本:
class SearchResultV2(BaseModel):
title: str
url: HttpUrl
relevance: float # was 'score' in v1从 Pydantic 生成 JSON 模式
对于工具模式定义,请从您的 Pydantic 类派生:
schema = SearchArgs.model_json_schema()
# Use directly as the 'parameters' for an OpenAI tool definition.验证目标
为什么要对每个工具输出使用 Pydantic?
回顾
在每个边界使用 Pydantic:传入的工具参数、传出的工具输出以及 LLM 结构化输出。明确失败胜过悄无声息的数据损坏。
常见问题解答
「验证工具输出(Pydantic)」课时是免费的吗?
是的 — 「验证工具输出(Pydantic)」的完整文本可在网页上免费阅读。要进行交互式练习(内置代码编辑器和全天候 AI 导师)并解锁 AI Agents 课程的其余内容,请升级到 CoddyKit PRO。 AI Agents 课程共包含 4 节课。
「验证工具输出(Pydantic)」这节课中我会学到什么?
让每个工具输出都经过 Pydantic 模型解析——遇到格式错误的响应时立即明确失败。 你通过在浏览器中直接运行的动手代码来练习 AI Agents,全天候 AI 导师会在你学习这节课的过程中回答你的问题。
学习 AI Agents 需要有经验吗?
无需任何先前经验。CoddyKit 上的 AI Agents 课程适合初学者到高级学习者,你可以从这里开始或从头开始,按照自己的节奏学习。 这是第 4 节课,共 4 节。
「验证工具输出(Pydantic)」课时需要多长时间?
大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动,所以你能稳步进步,并在网页和应用中从离开的地方继续。
我能在这节 AI Agents 课中编写并运行代码吗?
能。每节 AI Agents 课都包含内置代码编辑器,你可以在浏览器中直接编写并运行真实代码,并获得即时 AI 反馈 — 无需本地设置。