Freeform Tool 允许模型输出一段受 Grammar 约束的文本,而不是 JSON 对象;Grammar 属于模型合同,完整文本仍必须由客户端 Parser 重新验证。
这里处理的是工具计划的编译阶段:输入是候选规格与当前 Step 能力,输出是不可再漂移的模型合同或 Registry 快照。它没有业务副作用,但一旦规划错误,后续路由会稳定地执行错误合同。 本节只追踪“Grammar 约束生成形状,Parser 决定文本是否真的可执行”以内的机制;相邻工具的业务行为不在这里混写。
启用条件与所有权
| 维度 | 当前实现 | 不满足时 |
|---|---|---|
| 门控 | Provider capability、模型能力、Feature 与当前 ToolMode 共同决定是否进入本 Step 工具计划 | 不建立候选、从模型工具面移除,或转成模型可读拒绝 |
| 输入 | ToolSpec 与 PlannedRuntime 候选 | 在进入状态所有者前拒绝错误 Payload/参数 |
| 状态所有者 | StepContext 中冻结的 ToolRouter / ToolRegistry | 不允许临时 Handler 私自复制长期状态 |
| 输出 | model_visible_specs 和同快照 Registry | 必须保持调用关联后才能进入 History |
这里最容易出现的误解,是把“规格里写了什么”当作 Runtime 已经强制了什么。description、Schema 和自然语言提示只帮助模型生成更好的调用;真正的名称查找、类型校验、审批、资源约束和取消收尾仍由客户端完成。
机制调用链
构造 FreeformTool
→ 附加 syntax 与 definition
→ 序列化进模型请求
→ 接收 CustomToolCall
→ 本地 Parser 二次验证
图中的箭头代表控制权转移,不只是数据复制。每越过一步,下一层只接收已经满足上一层合同的数据;若该层拥有异步状态,它还必须保留原 Step、call_id 或环境身份,避免晚到结果被新一轮配置解释。
源码机制拆解
Format 是显式协议字段
自定义格式携带 type、syntax 和 definition,使 Provider 知道这不是普通字符串补全。
这条约束位于“附加 syntax 与 definition”附近。把它前移会缺少必要状态,把它后移则可能让错误数据或副作用先穿过边界。
Payload 形状是 Custom
ToolRouter 把 CustomToolCall.input 保存为 ToolPayload::Custom,不尝试把它伪装成 JSON Function arguments。
这条约束位于“序列化进模型请求”附近。把它前移会缺少必要状态,把它后移则可能让错误数据或副作用先穿过边界。
Parser 是最终权威
模型即使声称遵循 Grammar,客户端仍处理截断、非法标记和语义错误。
这条约束位于“接收 CustomToolCall”附近。把它前移会缺少必要状态,把它后移则可能让错误数据或副作用先穿过边界。
Python 风格伪代码
伪代码保留会改变结果的门控、状态读取、异步等待和协议编码;省略 Rust 所有权样板、日志字段以及与本机制无关的 Provider 适配。它不是源码翻译,也不能替代平台级安全实现。
def build_freeform_grammar(candidates, step):
# 1. 构造 FreeformTool
# 2. 附加 syntax 与 definition
# 3. 序列化进模型请求
# 4. 接收 CustomToolCall
# 5. 本地 Parser 二次验证
planned, visible, registry = [], [], {}
for candidate in candidates:
if not candidate.capabilities.issubset(step.capabilities):
continue
if candidate.tool_name not in registry:
registry[candidate.tool_name] = candidate.runtime
planned.append(candidate)
if candidate.exposure.is_direct and not step.mode.hides(candidate):
visible.append(candidate.spec_for(step.mode))
return ToolPlan(visible=visible, registry=registry, step_id=step.id)
逐行理解时要抓住三个不变量:输入先验证,状态由明确对象持有,输出用原调用身份编码。任何“先执行,之后再补关联”的简化都会在并发、取消或 Step 更新时产生悬空结果。
失败、取消与恢复
| 故障点 | 已发生的状态或副作用 | 对模型/调用方的结果 | 恢复动作 |
|---|---|---|---|
| Grammar 与 Parser 漂移 | 模型能生成但客户端拒绝 | 模型收到可恢复解析错误 | 同一实现包同步维护规格与 Parser 测试 |
| Provider 不支持自定义格式 | 规格不能按预期约束生成 | 工具不应暴露 | 由模型能力门控或改用 Function Schema |
| Turn 取消 | 可能已经注册等待者、启动任务或提交部分副作用 | 生成 Aborted/Failed 终态,不能留下无结果调用 | 由 StepContext 中冻结的 ToolRouter / ToolRegistry 注销等待者、终止资源并保持 Call/Output 配对 |
取消不是删除历史。模型已经发出的调用先进入转录;Runtime 必须补上可编码的终态。若副作用已经提交,Aborted 也不表示回滚。需要事务性的功能必须在自己的写入协议里实现原子提交或补偿。
设计思路与代价
当前设计保护的核心不变量是:Freeform 的 name/description/format 被序列化,Runtime 绝不把语法约束当成已校验输入。它让模型合同、执行状态和安全边界能够分别演进,却增加了快照、适配器和终态处理代码。更短的实现可以少一层对象,但会把“可见”“可执行”“获准”“已完成”压成同一个布尔值,无法解释延迟工具、审批拒绝、沙箱失败或晚到结果。
本节的设计动机有一部分是从类型边界和测试行为推断出来的;源码没有把所有取舍写成设计文档。可以直接证明的是字段、分支、状态所有者和失败结果,不能从这些证据外推服务端内部实现。
测试与复现实验
| 可验证契约 | 复现方式 | 预期结果 |
|---|---|---|
| codex-rs/core/src/tools/spec_plan_tests.rs | 构造正常值、边界值和拒绝值 | 结果与调用 ID/状态所有者保持一致 |
本地复核应同时搜索生产符号和相邻测试,不能只跑快乐路径。推荐先对源码执行 rg -n 查找本节索引中的类型/函数,再构造一个合法调用、一个类型错误和一个取消或拒绝场景。当前环境没有 Cargo,因此本轮以锁定提交下的源码—测试静态对读、博客构建和图形渲染为验证边界,不伪报 Rust 测试执行。
Mini Codex 对照
Mini Codex 可以复刻本节的纯协议或状态机不变量,例如名称去重、调用配对、Head/Tail 缓冲与单次升级;不能用 Python 模拟结果证明 Seatbelt、seccomp、Restricted Token、远程 Exec Server 或 Provider Hosted Tool 的真实安全性质。
本节边界
本节已经证明 Freeform 的 name/description/format 被序列化,Runtime 绝不把语法约束当成已校验输入。它没有把相邻机制折叠进来:Grammar 约束生成形状,Parser 决定文本是否真的可执行 之外的判断仍由其各自单元负责。
阅读导航
上一节:6.2 ToolSpec::Namespace 的合并与 Provider 能力门控 · 下一节:6.4 ToolSpec::ToolSearch 的客户端执行协议
评论
登录后即可评论