Skip to main content
通过实现在智能体执行流程中特定点运行的钩子来构建自定义中间件。

钩子

中间件提供两种风格的钩子来拦截智能体执行:

节点式钩子

在特定执行点按顺序运行。

包装式钩子

围绕每次模型或工具调用运行。

节点式钩子

在特定执行点按顺序运行。用于日志记录、验证和状态更新。 选择你的中间件需要的钩子。你可以在节点式钩子和包装式钩子之间选择。 节点式钩子在特定执行点运行: 包装式钩子围绕每次调用运行,让你控制执行: 示例:

包装式钩子

拦截执行并控制何时调用处理器。用于重试、缓存和转换。 你决定处理器被调用零次(短路)、一次(正常流程)或多次(重试逻辑)。 可用钩子:
  • wrapModelCall - 围绕每次模型调用
  • wrapToolCall - 围绕每次工具调用
示例:

状态更新

节点式和包装式钩子都可以更新智能体状态。机制有所不同:
  • 节点式钩子beforeAgentbeforeModelafterModelafterAgent):直接返回一个字典。该字典使用图的 reducer 应用到智能体状态。
  • 包装式钩子wrapModelCallwrapToolCall):对于模型调用,直接返回 Command 来在模型响应旁注入状态更新。对于工具调用,直接返回 Command。当你需要基于模型或工具调用期间运行的逻辑来跟踪或更新状态时使用这些,例如摘要触发点、使用元数据或从请求或响应计算的自定义字段。

节点式钩子

从节点式钩子返回字典以将更新合并到智能体状态中。字典键映射到状态字段。

包装式钩子

wrapModelCall 直接返回 Command 以从模型调用层注入状态更新:
Command 通过图的 reducer 流动,因此更新会被正确应用,消息是追加式的而非替换现有状态。

多个中间件的组合

当多个中间件层返回响应时,框架传递最后产生的 AIMessage
  • AIMessage 贯穿流动: 每个中间件的 handler() 接收来自上一层的 AIMessage。当中间件返回 AIMessage 时,它成为下一个中间件处理器的输入。
  • 不带消息更新的 Command 是透传的: 如果中间件返回的 Command 的状态更新没有触及 messages,框架将其视为消息流的空操作。下一个中间件的处理器接收来自返回 Command 的中间件之前的那个中间件的 AIMessage
  • Reducer 行为和重试安全性: Command 仍通过 reducer 应用(消息追加,冲突时外层优先)。重试逻辑会丢弃早期调用的 Command。

创建中间件

使用 createMiddleware 函数定义自定义中间件:

自定义状态模式

如果你的中间件需要跨钩子跟踪状态,中间件可以使用自定义属性扩展智能体的状态。这使中间件能够:
  • 跨执行跟踪状态:维护在智能体执行生命周期中持久化的计数器、标志或其他值
  • 在钩子之间共享数据:将信息从 beforeModel 传递到 afterModel 或在不同中间件实例之间传递
  • 实现横切关注点:添加速率限制、使用跟踪、用户上下文或审计日志等功能,无需修改核心智能体逻辑
  • 做出条件决策:使用累积的状态来确定是否继续执行、跳转到不同节点或动态修改行为
状态字段可以是公开的或私有的。以下划线(_)开头的字段被认为是私有的,不会包含在智能体的结果中。只有公开字段(没有前导下划线的)会被返回。 这对于存储不应暴露给调用者的内部中间件状态很有用,例如临时跟踪变量或内部标志:

自定义上下文

中间件可以定义自定义上下文模式来访问每次调用的元数据。与状态不同,上下文是只读的,不会在调用之间持久化。这使其非常适合:
  • 用户信息:传递在执行期间不会更改的用户 ID、角色或偏好
  • 配置覆盖:提供每次调用的设置,如速率限制或功能标志
  • 租户/工作区上下文:包含多租户应用的组织特定数据
  • 请求元数据:传递中间件需要的请求 ID、API 密钥或其他元数据
使用 Zod 定义上下文模式,并在中间件钩子中通过 runtime.context 访问。上下文模式中的必填字段将在 TypeScript 级别强制执行,确保你在调用 agent.invoke() 时必须提供它们。
必填上下文字段:当你在 contextSchema 中定义必填字段(没有 .optional().default() 的字段)时,TypeScript 将强制在 agent.invoke() 调用中必须提供这些字段。这确保了类型安全并防止缺少必需上下文的运行时错误。

执行顺序

使用多个中间件时,理解它们的执行方式:
Before 钩子按顺序运行:
  1. middleware1.before_agent()
  2. middleware2.before_agent()
  3. middleware3.before_agent()
智能体循环开始
  1. middleware1.before_model()
  2. middleware2.before_model()
  3. middleware3.before_model()
Wrap 钩子像函数调用一样嵌套:
  1. middleware1.wrap_model_call()middleware2.wrap_model_call()middleware3.wrap_model_call() → model
After 钩子按逆序运行:
  1. middleware3.after_model()
  2. middleware2.after_model()
  3. middleware1.after_model()
智能体循环结束
  1. middleware3.after_agent()
  2. middleware2.after_agent()
  3. middleware1.after_agent()
关键规则:
  • before_* 钩子:从前到后
  • after_* 钩子:从后到前(逆序)
  • wrap_* 钩子:嵌套(第一个中间件包装所有其他)

智能体跳转

要从中间件提前退出,返回带有 jump_to 的字典: 可用跳转目标:
  • 'end':跳到智能体执行的末尾(或第一个 after_agent 钩子)
  • 'tools':跳到工具节点
  • 'model':跳到模型节点(或第一个 before_model 钩子)

最佳实践

  1. 保持中间件聚焦——每个中间件应该做好一件事
  2. 优雅地处理错误——不要让中间件错误导致智能体崩溃
  3. 使用适当的钩子类型
    • 节点式用于顺序逻辑(日志记录、验证)
    • 包装式用于控制流(重试、回退、缓存)
  4. 清楚地记录任何自定义状态属性
  5. 在集成之前独立地对中间件进行单元测试
  6. 考虑执行顺序——将关键中间件放在列表前面
  7. 尽可能使用内置中间件

示例

动态提示词

在运行时动态修改系统提示词,在每次模型调用前注入上下文、用户特定指令或其他信息。这是最常见的中间件用例之一。 使用 ModelRequest 中的 systemMessage 字段来读取和修改系统提示词。它包含一个 SystemMessage 对象(即使智能体是用字符串 systemPrompt 创建的)。
使用 SystemMessage.concat 来保留其他中间件创建的缓存控制元数据或结构化内容块。

动态模型选择

动态选择工具

在运行时选择相关工具以提高性能和准确性。本节涵盖过滤预注册的工具。关于注册在运行时发现的工具(例如来自 MCP 服务器),请参阅运行时工具注册 好处:
  • 更短的提示词 - 通过只暴露相关工具来降低复杂性
  • 更好的准确性 - 模型从更少的选项中做出正确选择
  • 权限控制 - 根据用户访问权限动态过滤工具

工具调用监控

提示词缓存(Anthropic)

使用 Anthropic 模型时,使用带有缓存控制指令的结构化内容块来缓存大型系统提示词:
注意:
  • ModelRequest.system_message 始终是 SystemMessage 对象,即使智能体是用 system_prompt="string" 创建的
  • 使用 SystemMessage.content_blocks 以块列表形式访问内容,无论原始内容是字符串还是列表
  • 修改系统消息时,使用 content_blocks 并追加新块以保留现有结构
  • 你可以将 SystemMessage 对象直接传递给 create_agentsystem_prompt 参数以用于高级用例如缓存控制
::: 使用 ModelRequest 中的 systemMessage 字段在中间件中修改系统消息。它包含一个 SystemMessage 对象(即使智能体是用字符串 systemPrompt 创建的)。 示例:链接中间件 - 不同的中间件可以使用不同的方式:
生成的系统消息将是:
使用 SystemMessage.concat 来保留其他中间件创建的缓存控制元数据或结构化内容块。

其他资源