Langchain LCEL链调试：激活中间步骤输出的实用指南

在使用langchain构建复杂链式应用时，尤其是在采用其强大的表达式语言（lcel）范式时，开发者常常需要查看链的内部运作，例如提示词的构建过程、模型调用参数以及中间结果。然而，旧有的langchain.globals.set_verbose(true)或在模型初始化时设置verbose=true的策略，在langchain 0.0.345及更高版本的lcel链中可能无法如预期般提供详细的中间输出。这主要是由于langchain api的演进，调试机制也随之更新。本教程将详细介绍当前版本langchain中激活中间步骤输出的推荐方法。

方法一：使用回调处理器（Callback Handlers）

对于LCEL链，获取中间步骤输出最直接且推荐的方法是利用回调处理器（Callback Handlers），并在链的invoke或stream方法中进行配置。ConsoleCallbackHandler是一个非常实用的内置回调处理器，它能将链的执行事件（如开始、结束、错误、中间结果等）打印到控制台。

要实现这一点，您需要在调用链时，通过config参数传入一个包含ConsoleCallbackHandler实例的列表。

代码示例：

from langchain.chat_models import ChatOpenAI
from langchain.prompts import ChatPromptTemplate
from langchain.schema.output_parser import StrOutputParser
from langchain.callbacks.tracers import ConsoleCallbackHandler # 导入回调处理器

# 定义链的组件
prompt = ChatPromptTemplate.from_template("讲一个关于{topic}的笑话")
model = ChatOpenAI()
output_parser = StrOutputParser()

# 构建LCEL链
chain = prompt | model | output_parser

# 调用链并配置ConsoleCallbackHandler以获取详细输出
chain.invoke(
    {"topic": "冰淇淋"},
    config={'callbacks': [ConsoleCallbackHandler()]}
)

通过这种方式，当chain.invoke被执行时，ConsoleCallbackHandler会捕获并打印出链中各个组件的输入、输出以及其他重要的事件信息，从而帮助您追踪链的执行流程。虽然其输出格式可能与早期版本的“verbose模式”略有不同，但这无疑是当前获取类似详细日志的最佳实践。

更精细的控制：组件级回调

在某些场景下，您可能只对链中特定组件（例如，仅对语言模型）的详细输出感兴趣，而不是整个链的日志。Langchain允许您将回调处理器附加到单个组件上，以实现更精细的调试控制。

这可以通过组件的.with_config()方法实现。

代码示例：

from langchain.chat_models import ChatOpenAI
from langchain.prompts import ChatPromptTemplate
from langchain.schema.output_parser import StrOutputParser
from langchain.callbacks.tracers import ConsoleCallbackHandler

# 定义链的组件
prompt = ChatPromptTemplate.from_template("讲一个关于{topic}的笑话")
# 将ConsoleCallbackHandler附加到模型上，只追踪模型的活动
model = ChatOpenAI().with_config({'callbacks': [ConsoleCallbackHandler()]})
output_parser = StrOutputParser()

# 构建LCEL链
chain = prompt | model | output_parser

# 调用链，此时只有模型的活动会被ConsoleCallbackHandler打印
chain.invoke({"topic": "冰淇淋"})

这种方法在调试复杂链中某个特定环节时尤其有用，可以避免日志信息过于庞杂，帮助您聚焦问题。

全局高详细度调试：set_debug

除了上述基于回调处理器的方法外，Langchain还提供了一个全局的调试模式，通过langchain.globals.set_debug(True)来激活。与set_verbose不同，set_debug通常会提供更高级别的、更底层的调试信息，并且它仍然适用于LCEL链。

多面-AI面试

猎聘推出的AI面试平台

32

查看详情

当您需要深入了解Langchain内部更详细的执行逻辑时，set_debug(True)会非常有用。

代码示例：

from langchain.chat_models import ChatOpenAI
from langchain.prompts import ChatPromptTemplate
from langchain.schema.output_parser import StrOutputParser
from langchain.globals import set_debug # 导入set_debug

# 激活全局调试模式
set_debug(True)

# 定义链的组件
prompt = ChatPromptTemplate.from_template("讲一个关于{topic}的笑话")
model = ChatOpenAI()
output_parser = StrOutputParser()

# 构建LCEL链
chain = prompt | model | output_parser

# 调用链，此时将输出全局调试信息
chain.invoke({"topic": "冰淇淋"})

请注意，set_debug(True)可能会产生大量的输出，因此建议在需要详细诊断问题时使用，并在调试完成后将其关闭以避免不必要的日志干扰。

可视化调试工具

对于更复杂的Langchain应用，或者当您需要更直观地理解链的执行流程和性能瓶颈时，可视化调试工具是不可或缺的。Langchain生态系统集成了一些强大的外部工具，例如LangSmith和Weights & Biases。

• LangSmith：作为Langchain官方推荐的调试和可观测性平台，LangSmith能够提供链的完整跟踪、输入/输出日志、延迟分析以及错误检测等功能，以图形化的方式展示链的执行路径。
• Weights & Biases：同样提供实验跟踪和可视化功能，可以帮助开发者监控和分析Langchain应用的运行情况。

这些工具通过提供丰富的UI界面，极大地简化了复杂链的调试和性能优化过程，是专业开发者的首选。

注意事项与总结

在Langchain中激活中间步骤输出和进行调试，关键在于理解其API的演进。以下是几点重要的总结和注意事项：

1. 首选ConsoleCallbackHandler：对于LCEL链的中间步骤输出，推荐在invoke方法的config参数中传入ConsoleCallbackHandler。这是获取类似“verbose模式”输出的现代方法。
2. 灵活控制日志粒度：您可以选择将回调处理器应用于整个链，也可以通过.with_config()将其附加到特定组件上，以控制日志的详细程度和范围。
3. set_debug(True)用于高详细度诊断：当需要更底层的全局调试信息时，langchain.globals.set_debug(True)仍然有效，但请注意其可能产生大量日志。
4. 可视化工具提升效率：对于生产环境或复杂项目，LangSmith和Weights & Biases等可视化工具能提供更强大的调试和监控能力。
5. 查阅最新文档：Langchain项目迭代迅速，API可能发生变化。始终建议查阅官方文档以获取最新的调试指南和最佳实践。

通过掌握这些调试技术，您将能够更有效地理解和优化您的Langchain LCEL应用，确保其稳定、高效地运行。

以上就是Langchain LCEL链调试：激活中间步骤输出的实用指南的详细内容，更多请关注php中文网其它相关文章！