1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
| from abc import ABC, abstractmethod
from typing import Any, Dict, List, Optional, Union
from uuid import UUID
class BaseCallbackHandler(ABC):
"""回调处理器的抽象基类。
回调处理器用于在Runnable执行过程中的关键点执行自定义逻辑。
设计特点:
1. 事件驱动:基于执行生命周期的事件
2. 可选实现:所有方法都有默认实现
3. 类型安全:明确的事件参数类型
4. 错误隔离:回调错误不影响主流程
"""
# === 忽略标志 ===
ignore_llm: bool = False
"""是否忽略LLM相关事件"""
ignore_chain: bool = False
"""是否忽略Chain相关事件"""
ignore_agent: bool = False
"""是否忽略Agent相关事件"""
ignore_retriever: bool = False
"""是否忽略Retriever相关事件"""
ignore_chat_model: bool = False
"""是否忽略ChatModel相关事件"""
raise_error: bool = False
"""回调出错时是否抛出异常"""
# === LLM事件 ===
def on_llm_start(
self,
serialized: Dict[str, Any],
prompts: List[str],
*,
run_id: UUID,
parent_run_id: Optional[UUID] = None,
tags: Optional[List[str]] = None,
metadata: Optional[Dict[str, Any]] = None,
**kwargs: Any,
) -> Any:
"""LLM开始执行时调用。
Args:
serialized: 序列化的LLM信息
prompts: 输入提示列表
run_id: 运行ID
parent_run_id: 父运行ID
tags: 标签列表
metadata: 元数据
**kwargs: 额外参数
"""
def on_llm_new_token(
self,
token: str,
*,
chunk: Optional[Union[GenerationChunk, ChatGenerationChunk]] = None,
run_id: UUID,
parent_run_id: Optional[UUID] = None,
tags: Optional[List[str]] = None,
**kwargs: Any,
) -> Any:
"""LLM生成新token时调用。
Args:
token: 新生成的token
chunk: 生成块(如果可用)
run_id: 运行ID
parent_run_id: 父运行ID
tags: 标签列表
**kwargs: 额外参数
"""
def on_llm_end(
self,
response: LLMResult,
*,
run_id: UUID,
parent_run_id: Optional[UUID] = None,
tags: Optional[List[str]] = None,
**kwargs: Any,
) -> Any:
"""LLM执行结束时调用。
Args:
response: LLM响应结果
run_id: 运行ID
parent_run_id: 父运行ID
tags: 标签列表
**kwargs: 额外参数
"""
def on_llm_error(
self,
error: Union[Exception, KeyboardInterrupt],
*,
run_id: UUID,
parent_run_id: Optional[UUID] = None,
tags: Optional[List[str]] = None,
**kwargs: Any,
) -> Any:
"""LLM执行出错时调用。
Args:
error: 异常对象
run_id: 运行ID
parent_run_id: 父运行ID
tags: 标签列表
**kwargs: 额外参数
"""
# === Chain事件 ===
def on_chain_start(
self,
serialized: Dict[str, Any],
inputs: Dict[str, Any],
*,
run_id: UUID,
parent_run_id: Optional[UUID] = None,
tags: Optional[List[str]] = None,
metadata: Optional[Dict[str, Any]] = None,
**kwargs: Any,
) -> Any:
"""Chain开始执行时调用。"""
def on_chain_end(
self,
outputs: Dict[str, Any],
*,
run_id: UUID,
parent_run_id: Optional[UUID] = None,
tags: Optional[List[str]] = None,
**kwargs: Any,
) -> Any:
"""Chain执行结束时调用。"""
def on_chain_error(
self,
error: Union[Exception, KeyboardInterrupt],
*,
run_id: UUID,
parent_run_id: Optional[UUID] = None,
tags: Optional[List[str]] = None,
**kwargs: Any,
) -> Any:
"""Chain执行出错时调用。"""
# === Tool事件 ===
def on_tool_start(
self,
serialized: Dict[str, Any],
input_str: str,
*,
run_id: UUID,
parent_run_id: Optional[UUID] = None,
tags: Optional[List[str]] = None,
metadata: Optional[Dict[str, Any]] = None,
inputs: Optional[Dict[str, Any]] = None,
**kwargs: Any,
) -> Any:
"""Tool开始执行时调用。"""
def on_tool_end(
self,
output: str,
*,
run_id: UUID,
parent_run_id: Optional[UUID] = None,
tags: Optional[List[str]] = None,
**kwargs: Any,
) -> Any:
"""Tool执行结束时调用。"""
def on_tool_error(
self,
error: Union[Exception, KeyboardInterrupt],
*,
run_id: UUID,
parent_run_id: Optional[UUID] = None,
tags: Optional[List[str]] = None,
**kwargs: Any,
) -> Any:
"""Tool执行出错时调用。"""
# === Agent事件 ===
def on_agent_action(
self,
action: AgentAction,
*,
run_id: UUID,
parent_run_id: Optional[UUID] = None,
tags: Optional[List[str]] = None,
**kwargs: Any,
) -> Any:
"""Agent执行动作时调用。"""
def on_agent_finish(
self,
finish: AgentFinish,
*,
run_id: UUID,
parent_run_id: Optional[UUID] = None,
tags: Optional[List[str]] = None,
**kwargs: Any,
) -> Any:
"""Agent完成时调用。"""
# === Retriever事件 ===
def on_retriever_start(
self,
serialized: Dict[str, Any],
query: str,
*,
run_id: UUID,
parent_run_id: Optional[UUID] = None,
tags: Optional[List[str]] = None,
metadata: Optional[Dict[str, Any]] = None,
**kwargs: Any,
) -> Any:
"""Retriever开始检索时调用。"""
def on_retriever_end(
self,
documents: List[Document],
*,
run_id: UUID,
parent_run_id: Optional[UUID] = None,
tags: Optional[List[str]] = None,
**kwargs: Any,
) -> Any:
"""Retriever检索结束时调用。"""
def on_retriever_error(
self,
error: Union[Exception, KeyboardInterrupt],
*,
run_id: UUID,
parent_run_id: Optional[UUID] = None,
tags: Optional[List[str]] = None,
**kwargs: Any,
) -> Any:
"""Retriever检索出错时调用。"""
# === 文本事件 ===
def on_text(
self,
text: str,
*,
run_id: UUID,
parent_run_id: Optional[UUID] = None,
tags: Optional[List[str]] = None,
**kwargs: Any,
) -> Any:
"""处理文本时调用。"""
class CallbackManager:
"""回调管理器,负责管理和调度回调处理器。
设计特点:
1. 集中管理:统一管理所有回调处理器
2. 错误隔离:单个回调错误不影响其他回调
3. 层次结构:支持父子回调管理器
4. 异步支持:同步和异步回调管理
"""
def __init__(
self,
handlers: List[BaseCallbackHandler],
inheritable_handlers: Optional[List[BaseCallbackHandler]] = None,
parent_run_id: Optional[UUID] = None,
*,
tags: Optional[List[str]] = None,
inheritable_tags: Optional[List[str]] = None,
metadata: Optional[Dict[str, Any]] = None,
inheritable_metadata: Optional[Dict[str, Any]] = None,
):
"""初始化回调管理器。
Args:
handlers: 当前级别的回调处理器
inheritable_handlers: 可继承的回调处理器
parent_run_id: 父运行ID
tags: 当前级别的标签
inheritable_tags: 可继承的标签
metadata: 当前级别的元数据
inheritable_metadata: 可继承的元数据
"""
self.handlers = handlers or []
self.inheritable_handlers = inheritable_handlers or []
self.parent_run_id = parent_run_id
self.tags = tags or []
self.inheritable_tags = inheritable_tags or []
self.metadata = metadata or {}
self.inheritable_metadata = inheritable_metadata or {}
@classmethod
def configure(
cls,
callbacks: Callbacks = None,
inheritable_callbacks: Callbacks = None,
verbose: bool = False,
tags: Optional[List[str]] = None,
inheritable_tags: Optional[List[str]] = None,
metadata: Optional[Dict[str, Any]] = None,
inheritable_metadata: Optional[Dict[str, Any]] = None,
) -> CallbackManager:
"""配置回调管理器。
Args:
callbacks: 回调处理器或管理器
inheritable_callbacks: 可继承的回调
verbose: 是否启用详细输出
tags: 标签
inheritable_tags: 可继承标签
metadata: 元数据
inheritable_metadata: 可继承元数据
Returns:
配置好的回调管理器
"""
# 处理回调参数
handlers = []
inheritable_handlers = []
# 处理主回调
if callbacks:
if isinstance(callbacks, list):
handlers.extend(callbacks)
elif isinstance(callbacks, BaseCallbackManager):
handlers.extend(callbacks.handlers)
inheritable_handlers.extend(callbacks.inheritable_handlers)
elif isinstance(callbacks, BaseCallbackHandler):
handlers.append(callbacks)
# 处理可继承回调
if inheritable_callbacks:
if isinstance(inheritable_callbacks, list):
inheritable_handlers.extend(inheritable_callbacks)
elif isinstance(inheritable_callbacks, BaseCallbackHandler):
inheritable_handlers.append(inheritable_callbacks)
# 添加默认处理器
if verbose:
from langchain_core.tracers import ConsoleCallbackHandler
handlers.append(ConsoleCallbackHandler())
return cls(
handlers=handlers,
inheritable_handlers=inheritable_handlers,
tags=tags,
inheritable_tags=inheritable_tags,
metadata=metadata,
inheritable_metadata=inheritable_metadata,
)
def on_llm_start(
self,
serialized: Dict[str, Any],
prompts: List[str],
*,
invocation_params: Optional[Dict[str, Any]] = None,
options: Optional[Dict[str, Any]] = None,
name: Optional[str] = None,
**kwargs: Any,
) -> CallbackManagerForLLMRun:
"""创建LLM运行的回调管理器。"""
from uuid import uuid4
run_id = uuid4()
# 合并标签和元数据
run_tags = (self.tags or []) + (self.inheritable_tags or [])
run_metadata = {**(self.inheritable_metadata or {}), **(self.metadata or {})}
if options:
run_tags.extend(options.get("tags", []))
run_metadata.update(options.get("metadata", {}))
# 通知所有处理器
for handler in self.handlers + self.inheritable_handlers:
if not handler.ignore_llm:
try:
handler.on_llm_start(
serialized,
prompts,
run_id=run_id,
parent_run_id=self.parent_run_id,
tags=run_tags,
metadata=run_metadata,
invocation_params=invocation_params,
name=name,
**kwargs,
)
except Exception as e:
if handler.raise_error:
raise e
else:
logger.warning(f"回调处理器出错: {e}")
return CallbackManagerForLLMRun(
run_id=run_id,
handlers=self.handlers,
inheritable_handlers=self.inheritable_handlers,
parent_run_id=self.parent_run_id,
tags=run_tags,
inheritable_tags=self.inheritable_tags,
metadata=run_metadata,
inheritable_metadata=self.inheritable_metadata,
)
def on_chain_start(
self,
serialized: Dict[str, Any],
inputs: Dict[str, Any],
*,
name: Optional[str] = None,
**kwargs: Any,
) -> CallbackManagerForChainRun:
"""创建Chain运行的回调管理器。"""
from uuid import uuid4
run_id = uuid4()
run_tags = (self.tags or []) + (self.inheritable_tags or [])
run_metadata = {**(self.inheritable_metadata or {}), **(self.metadata or {})}
for handler in self.handlers + self.inheritable_handlers:
if not handler.ignore_chain:
try:
handler.on_chain_start(
serialized,
inputs,
run_id=run_id,
parent_run_id=self.parent_run_id,
tags=run_tags,
metadata=run_metadata,
name=name,
**kwargs,
)
except Exception as e:
if handler.raise_error:
raise e
else:
logger.warning(f"回调处理器出错: {e}")
return CallbackManagerForChainRun(
run_id=run_id,
handlers=self.handlers,
inheritable_handlers=self.inheritable_handlers,
parent_run_id=self.parent_run_id,
tags=run_tags,
inheritable_tags=self.inheritable_tags,
metadata=run_metadata,
inheritable_metadata=self.inheritable_metadata,
)
def get_child(self, tag: Optional[str] = None) -> CallbackManager:
"""获取子回调管理器。
Args:
tag: 子管理器的标签
Returns:
子回调管理器
"""
child_tags = []
if tag:
child_tags.append(tag)
return CallbackManager(
handlers=[], # 子管理器不直接包含处理器
inheritable_handlers=self.handlers + self.inheritable_handlers,
parent_run_id=None, # 将在具体运行时设置
tags=child_tags,
inheritable_tags=self.tags + self.inheritable_tags,
metadata={},
inheritable_metadata={**self.inheritable_metadata, **self.metadata},
)
|