Spaces:
Running
Running
File size: 14,933 Bytes
3193174 | 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 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 | """
Base callback handlers (like LangChain BaseCallbackHandler).
Provides abstract base classes for sync and async callback handlers.
"""
from typing import Any
from uuid import UUID
__all__ = [
"AsyncCallbackHandler",
"BaseCallbackHandler",
"CallbackHandlerMixin",
]
class CallbackHandlerMixin:
"""Base mixin for callback handlers providing common attributes."""
raise_error: bool = False
run_inline: bool = True
# Ignore flags
ignore_agent: bool = False
ignore_retry: bool = False
ignore_budget: bool = False
ignore_memory: bool = False
ignore_llm: bool = False
ignore_tool: bool = False
@property
def is_async(self) -> bool:
"""Whether this handler is async."""
return False
class BaseCallbackHandler(CallbackHandlerMixin):
"""
Base callback handler for sync operations.
Subclass this to create custom handlers. Override only the methods
you need - all methods have default no-op implementations.
Attributes:
raise_error: If True, exceptions in handlers will propagate.
run_inline: If True, handlers run in the same thread.
ignore_agent: If True, skip agent lifecycle events.
ignore_retry: If True, skip retry events.
ignore_budget: If True, skip budget events.
ignore_memory: If True, skip memory events.
ignore_llm: If True, skip token streaming events.
"""
# === Run lifecycle ===
def on_run_start(
self,
*,
run_id: UUID,
query: str,
num_agents: int = 0,
execution_order: list[str] | None = None,
parent_run_id: UUID | None = None,
tags: list[str] | None = None,
metadata: dict[str, Any] | None = None,
**kwargs: Any,
) -> None:
"""Called when execution run starts."""
def on_run_end(
self,
*,
run_id: UUID,
output: str,
success: bool = True,
error: BaseException | None = None,
total_tokens: int = 0,
total_time_ms: float = 0.0,
executed_agents: list[str] | None = None,
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
"""Called when execution run ends."""
# === Agent lifecycle ===
def on_agent_start(
self,
*,
run_id: UUID,
agent_id: str,
agent_name: str = "",
step_index: int = 0,
prompt: str = "",
predecessors: list[str] | None = None,
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
"""Called when an agent starts processing."""
def on_agent_end(
self,
*,
run_id: UUID,
agent_id: str,
output: str,
agent_name: str = "",
step_index: int = 0,
tokens_used: int = 0,
duration_ms: float = 0.0,
is_final: bool = False,
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
"""Called when an agent completes processing."""
def on_agent_error(
self,
error: BaseException,
*,
run_id: UUID,
agent_id: str,
error_type: str = "",
will_retry: bool = False,
attempt: int = 0,
max_attempts: int = 0,
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
"""Called when an agent encounters an error."""
# === Retry ===
def on_retry(
self,
*,
run_id: UUID,
agent_id: str,
attempt: int,
max_attempts: int = 0,
delay_ms: float = 0.0,
error: str = "",
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
"""Called when an agent is being retried."""
# === Token streaming ===
def on_llm_new_token(
self,
token: str,
*,
run_id: UUID,
agent_id: str,
token_index: int = 0,
is_first: bool = False,
is_last: bool = False,
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
"""Called for each token during streaming LLM output."""
# === Planning ===
def on_plan_created(
self,
*,
run_id: UUID,
num_steps: int,
execution_order: list[str],
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
"""Called when execution plan is created."""
def on_topology_changed(
self,
*,
run_id: UUID,
reason: str,
old_remaining: list[str],
new_remaining: list[str],
change_count: int = 0,
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
"""Called when execution plan is modified by topology hooks."""
# === Pruning/Fallback ===
def on_prune(
self,
*,
run_id: UUID,
agent_id: str,
reason: str,
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
"""Called when an agent is pruned from execution."""
def on_fallback(
self,
*,
run_id: UUID,
failed_agent_id: str,
fallback_agent_id: str,
reason: str = "",
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
"""Called when fallback agent is activated."""
# === Parallel execution ===
def on_parallel_start(
self,
*,
run_id: UUID,
agent_ids: list[str],
group_index: int = 0,
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
"""Called when parallel execution group starts."""
def on_parallel_end(
self,
*,
run_id: UUID,
agent_ids: list[str],
group_index: int = 0,
successful: list[str] | None = None,
failed: list[str] | None = None,
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
"""Called when parallel execution group completes."""
# === Memory ===
def on_memory_read(
self,
*,
run_id: UUID,
agent_id: str,
entries_count: int = 0,
keys: list[str] | None = None,
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
"""Called when agent reads from memory."""
def on_memory_write(
self,
*,
run_id: UUID,
agent_id: str,
key: str,
value_size: int = 0,
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
"""Called when agent writes to memory."""
# === Budget ===
def on_budget_warning(
self,
*,
run_id: UUID,
budget_type: str,
current: float,
limit: float,
ratio: float = 0.0,
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
"""Called when budget threshold is approached."""
def on_budget_exceeded(
self,
*,
run_id: UUID,
budget_type: str,
current: float,
limit: float,
action_taken: str = "",
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
"""Called when budget is exceeded."""
# === Tool lifecycle ===
def on_tool_start(
self,
*,
run_id: UUID,
agent_id: str = "",
tool_name: str,
action: str = "",
arguments: dict[str, Any] | None = None,
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
"""Called when a tool starts execution."""
def on_tool_end(
self,
*,
run_id: UUID,
agent_id: str = "",
tool_name: str,
action: str = "",
success: bool = True,
output_size: int = 0,
duration_ms: float = 0.0,
result_summary: str = "",
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
"""Called when a tool completes execution."""
def on_tool_error(
self,
*,
run_id: UUID,
agent_id: str = "",
tool_name: str,
action: str = "",
error_type: str = "",
error_message: str = "",
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
"""Called when a tool encounters an error."""
class AsyncCallbackHandler(CallbackHandlerMixin):
"""
Async callback handler for async operations.
All methods are async versions of BaseCallbackHandler methods.
"""
@property
def is_async(self) -> bool:
return True
# === Run lifecycle ===
async def on_run_start(
self,
*,
run_id: UUID,
query: str,
num_agents: int = 0,
execution_order: list[str] | None = None,
parent_run_id: UUID | None = None,
tags: list[str] | None = None,
metadata: dict[str, Any] | None = None,
**kwargs: Any,
) -> None:
pass
async def on_run_end(
self,
*,
run_id: UUID,
output: str,
success: bool = True,
error: BaseException | None = None,
total_tokens: int = 0,
total_time_ms: float = 0.0,
executed_agents: list[str] | None = None,
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
pass
# === Agent lifecycle ===
async def on_agent_start(
self,
*,
run_id: UUID,
agent_id: str,
agent_name: str = "",
step_index: int = 0,
prompt: str = "",
predecessors: list[str] | None = None,
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
pass
async def on_agent_end(
self,
*,
run_id: UUID,
agent_id: str,
output: str,
agent_name: str = "",
step_index: int = 0,
tokens_used: int = 0,
duration_ms: float = 0.0,
is_final: bool = False,
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
pass
async def on_agent_error(
self,
error: BaseException,
*,
run_id: UUID,
agent_id: str,
error_type: str = "",
will_retry: bool = False,
attempt: int = 0,
max_attempts: int = 0,
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
pass
# === Retry ===
async def on_retry(
self,
*,
run_id: UUID,
agent_id: str,
attempt: int,
max_attempts: int = 0,
delay_ms: float = 0.0,
error: str = "",
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
pass
# === Token streaming ===
async def on_llm_new_token(
self,
token: str,
*,
run_id: UUID,
agent_id: str,
token_index: int = 0,
is_first: bool = False,
is_last: bool = False,
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
pass
# === Planning ===
async def on_plan_created(
self,
*,
run_id: UUID,
num_steps: int,
execution_order: list[str],
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
pass
async def on_topology_changed(
self,
*,
run_id: UUID,
reason: str,
old_remaining: list[str],
new_remaining: list[str],
change_count: int = 0,
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
pass
# === Pruning/Fallback ===
async def on_prune(
self,
*,
run_id: UUID,
agent_id: str,
reason: str,
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
pass
async def on_fallback(
self,
*,
run_id: UUID,
failed_agent_id: str,
fallback_agent_id: str,
reason: str = "",
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
pass
# === Parallel execution ===
async def on_parallel_start(
self,
*,
run_id: UUID,
agent_ids: list[str],
group_index: int = 0,
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
pass
async def on_parallel_end(
self,
*,
run_id: UUID,
agent_ids: list[str],
group_index: int = 0,
successful: list[str] | None = None,
failed: list[str] | None = None,
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
pass
# === Memory ===
async def on_memory_read(
self,
*,
run_id: UUID,
agent_id: str,
entries_count: int = 0,
keys: list[str] | None = None,
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
pass
async def on_memory_write(
self,
*,
run_id: UUID,
agent_id: str,
key: str,
value_size: int = 0,
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
pass
# === Budget ===
async def on_budget_warning(
self,
*,
run_id: UUID,
budget_type: str,
current: float,
limit: float,
ratio: float = 0.0,
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
pass
async def on_budget_exceeded(
self,
*,
run_id: UUID,
budget_type: str,
current: float,
limit: float,
action_taken: str = "",
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
pass
# === Tool lifecycle ===
async def on_tool_start(
self,
*,
run_id: UUID,
agent_id: str = "",
tool_name: str,
action: str = "",
arguments: dict[str, Any] | None = None,
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
pass
async def on_tool_end(
self,
*,
run_id: UUID,
agent_id: str = "",
tool_name: str,
action: str = "",
success: bool = True,
output_size: int = 0,
duration_ms: float = 0.0,
result_summary: str = "",
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
pass
async def on_tool_error(
self,
*,
run_id: UUID,
agent_id: str = "",
tool_name: str,
action: str = "",
error_type: str = "",
error_message: str = "",
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> None:
pass
|