Spaces:
Build error
Build error
File size: 36,462 Bytes
9c7d451 bb04104 9c7d451 bb04104 9c7d451 175746c 31c4f19 9c7d451 31c4f19 9c7d451 bb04104 9c7d451 31c4f19 bb04104 3ab0a5d 9c7d451 bb04104 9c7d451 bb04104 9c7d451 c14b9ac 126b60e 9c7d451 bb04104 9c7d451 bb04104 9c7d451 bb04104 9c7d451 bb04104 9c7d451 31c4f19 9c7d451 bb04104 9c7d451 bb04104 9c7d451 bb04104 9c7d451 bf779b5 9c7d451 e4a41fa 9c7d451 126b60e 9c7d451 126b60e 9c7d451 e4a41fa 9c7d451 e4a41fa 9c7d451 e4a41fa 9c7d451 31c4f19 9c7d451 e4a41fa 9c7d451 e4a41fa 9c7d451 bb04104 9c7d451 bf779b5 9c7d451 bf779b5 9c7d451 e4a41fa 9c7d451 bf779b5 9c7d451 bb04104 9c7d451 31c4f19 9c7d451 bb04104 31c4f19 9c7d451 bb04104 9c7d451 bb04104 31c4f19 bb04104 31c4f19 bb04104 9c7d451 bb04104 9c7d451 e4a41fa 9c7d451 bb04104 9c7d451 bb04104 9c7d451 bb04104 9c7d451 e4a41fa 9c7d451 bb04104 9c7d451 e4a41fa 9c7d451 31c4f19 9c7d451 e4a41fa 9c7d451 bb04104 9c7d451 e4a41fa 9c7d451 bb04104 9c7d451 e4a41fa 9c7d451 bb04104 9c7d451 e4a41fa 9c7d451 e4a41fa 9c7d451 e4a41fa 9c7d451 31c4f19 9c7d451 e4a41fa 9c7d451 126b60e 9c7d451 126b60e 9c7d451 e4a41fa 9c7d451 31c4f19 9c7d451 31c4f19 e4a41fa 9c7d451 e4a41fa 31c4f19 e4a41fa 9c7d451 e4a41fa 9c7d451 | 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 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 | """LangChain integration for Headroom SDK.
This module provides seamless integration with LangChain, enabling automatic
context optimization for any LangChain chat model.
Key insight: LangChain callbacks CANNOT modify messages (by design - see
https://github.com/langchain-ai/langchain/issues/8725). Therefore, we wrap
the chat model itself to intercept and transform messages.
Components:
1. HeadroomChatModel - Wraps any BaseChatModel to apply Headroom transforms
2. HeadroomCallbackHandler - Tracks metrics and token usage (observability only)
3. HeadroomRunnable - LCEL-compatible Runnable for chain composition
4. optimize_messages() - Standalone function for manual optimization
Example:
from langchain_openai import ChatOpenAI
from headroom.integrations import HeadroomChatModel
# Wrap any LangChain chat model
llm = ChatOpenAI(model="gpt-4o")
optimized_llm = HeadroomChatModel(llm)
# Use normally - Headroom automatically optimizes context
response = optimized_llm.invoke("What is 2+2?")
"""
from __future__ import annotations
import asyncio
import json
import logging
from collections.abc import AsyncIterator, Iterator, Sequence
from dataclasses import dataclass
from datetime import datetime
from typing import Any
from uuid import UUID, uuid4
# LangChain imports - these are optional dependencies
try:
from langchain_core.callbacks import BaseCallbackHandler
from langchain_core.language_models import BaseChatModel
from langchain_core.messages import (
AIMessage,
BaseMessage,
HumanMessage,
SystemMessage,
ToolMessage,
)
from langchain_core.outputs import ChatGeneration, ChatGenerationChunk, ChatResult # noqa: F401
from langchain_core.runnables import RunnableLambda
from pydantic import ConfigDict, Field, PrivateAttr
LANGCHAIN_AVAILABLE = True
except ImportError:
LANGCHAIN_AVAILABLE = False
BaseChatModel = object # type: ignore[misc,assignment]
BaseCallbackHandler = object # type: ignore[misc,assignment]
ConfigDict = lambda **kwargs: {} # type: ignore[assignment,misc] # noqa: E731
Field = lambda **kwargs: None # type: ignore[assignment] # noqa: E731
PrivateAttr = lambda **kwargs: None # type: ignore[assignment] # noqa: E731
from headroom import HeadroomConfig, HeadroomMode
from headroom.providers import OpenAIProvider
from headroom.transforms import TransformPipeline
from .providers import get_headroom_provider, get_model_name_from_langchain
logger = logging.getLogger(__name__)
def _check_langchain_available() -> None:
"""Raise ImportError if LangChain is not installed."""
if not LANGCHAIN_AVAILABLE:
raise ImportError(
"LangChain is required for this integration. "
"Install with: pip install headroom[langchain] "
"or: pip install langchain-core langchain-openai"
)
def _tool_call_args_to_json(tc: dict[str, Any] | Any) -> str:
"""Normalize tool call arguments to JSON string for OpenAI format.
LangChain can provide 'args' (dict) or 'arguments' (str) depending on source.
"""
if "args" in tc:
val = tc["args"]
return json.dumps(val) if isinstance(val, dict) else str(val)
if "arguments" in tc:
val = tc["arguments"]
return val if isinstance(val, str) else json.dumps(val)
if "function" in tc and isinstance(tc["function"], dict):
return str(tc["function"].get("arguments", "{}"))
return "{}"
def langchain_available() -> bool:
"""Check if LangChain is installed."""
return LANGCHAIN_AVAILABLE
@dataclass
class OptimizationMetrics:
"""Metrics from a single optimization pass."""
request_id: str
timestamp: datetime
tokens_before: int
tokens_after: int
tokens_saved: int
savings_percent: float
transforms_applied: list[str]
model: str
class HeadroomChatModel(BaseChatModel):
"""LangChain chat model wrapper that applies Headroom optimizations.
Wraps any LangChain BaseChatModel and automatically optimizes the context
before each API call. This is the recommended way to use Headroom with
LangChain because:
1. Callbacks cannot modify messages (LangChain design limitation)
2. Wrapping ensures ALL calls go through optimization
3. Works with streaming, tools, and all LangChain features
Example:
from langchain_openai import ChatOpenAI
from headroom.integrations import HeadroomChatModel
# Basic usage
llm = ChatOpenAI(model="gpt-4o")
optimized = HeadroomChatModel(llm)
response = optimized.invoke([HumanMessage("Hello!")])
# With custom config
from headroom import HeadroomConfig, HeadroomMode
config = HeadroomConfig(default_mode=HeadroomMode.OPTIMIZE)
optimized = HeadroomChatModel(llm, config=config)
# Access metrics
print(f"Saved {optimized.total_tokens_saved} tokens")
Attributes:
wrapped_model: The underlying LangChain chat model
headroom_client: HeadroomClient instance for optimization
metrics_history: List of OptimizationMetrics from recent calls
total_tokens_saved: Running total of tokens saved
"""
# Pydantic model fields
wrapped_model: Any = Field(description="The wrapped LangChain chat model")
headroom_config: Any = Field(default=None, description="Headroom configuration")
mode: HeadroomMode = Field(default=HeadroomMode.OPTIMIZE, description="Headroom mode")
auto_detect_provider: bool = Field(
default=True,
description="Auto-detect provider from wrapped model (OpenAI, Anthropic, Google)",
)
# Private attributes (not serialized)
_metrics_history: list = PrivateAttr(default_factory=list)
_total_tokens_saved: int = PrivateAttr(default=0)
_pipeline: Any = PrivateAttr(default=None)
_provider: Any = PrivateAttr(default=None)
# Pydantic v2 config for LangChain compatibility
model_config = ConfigDict(arbitrary_types_allowed=True)
def __init__(
self,
wrapped_model: BaseChatModel,
config: HeadroomConfig | None = None,
mode: HeadroomMode = HeadroomMode.OPTIMIZE,
auto_detect_provider: bool = True,
**kwargs: Any,
) -> None:
"""Initialize HeadroomChatModel.
Args:
wrapped_model: Any LangChain BaseChatModel to wrap
config: HeadroomConfig for optimization settings
mode: HeadroomMode (AUDIT, OPTIMIZE, or SIMULATE)
auto_detect_provider: Auto-detect provider from wrapped model.
When True (default), automatically detects if the wrapped model
is OpenAI, Anthropic, Google, etc. and uses the appropriate
Headroom provider for accurate token counting.
**kwargs: Additional arguments passed to BaseChatModel
"""
_check_langchain_available()
super().__init__( # type: ignore[call-arg]
wrapped_model=wrapped_model,
headroom_config=config or HeadroomConfig(),
mode=mode,
auto_detect_provider=auto_detect_provider,
**kwargs,
)
self._metrics_history = []
self._total_tokens_saved = 0
self._pipeline = None
self._provider = None
@property
def _llm_type(self) -> str:
"""Return identifier for this LLM type."""
return f"headroom-{self.wrapped_model._llm_type}"
@property
def _identifying_params(self) -> dict[str, Any]:
"""Return identifying parameters."""
return {
"wrapped_model": self.wrapped_model._identifying_params,
"headroom_mode": self.mode.value,
}
@property
def pipeline(self) -> TransformPipeline:
"""Lazily initialize TransformPipeline.
When auto_detect_provider is True, automatically detects the provider
from the wrapped model's class path (e.g., ChatAnthropic -> AnthropicProvider).
"""
if self._pipeline is None:
if self.auto_detect_provider:
self._provider = get_headroom_provider(self.wrapped_model)
logger.debug(f"Auto-detected provider: {self._provider.__class__.__name__}")
else:
self._provider = OpenAIProvider()
self._pipeline = TransformPipeline(
config=self.headroom_config,
provider=self._provider,
)
pipeline: TransformPipeline = self._pipeline
return pipeline
@property
def total_tokens_saved(self) -> int:
"""Total tokens saved across all calls."""
return self._total_tokens_saved
@property
def metrics_history(self) -> list[OptimizationMetrics]:
"""History of optimization metrics."""
return self._metrics_history.copy()
def _convert_messages_to_openai(self, messages: list[BaseMessage]) -> list[dict[str, Any]]:
"""Convert LangChain messages to OpenAI format for Headroom."""
result = []
for msg in messages:
if isinstance(msg, SystemMessage):
result.append({"role": "system", "content": msg.content})
elif isinstance(msg, HumanMessage):
result.append({"role": "user", "content": msg.content})
elif isinstance(msg, AIMessage):
entry = {"role": "assistant", "content": msg.content}
if msg.tool_calls:
entry["tool_calls"] = [
{
"id": tc.get("id", ""),
"type": "function",
"function": {
"name": tc.get("name", ""),
"arguments": _tool_call_args_to_json(tc),
},
}
for tc in msg.tool_calls
]
result.append(entry)
elif isinstance(msg, ToolMessage):
result.append(
{
"role": "tool",
"tool_call_id": msg.tool_call_id,
"content": msg.content,
}
)
else:
# Generic fallback
result.append(
{
"role": getattr(msg, "type", "user"),
"content": msg.content,
}
)
return result
def _convert_messages_from_openai(self, messages: list[dict[str, Any]]) -> list[BaseMessage]:
"""Convert OpenAI format messages back to LangChain format."""
result: list[BaseMessage] = []
for msg in messages:
role = msg.get("role", "user")
content = msg.get("content", "")
if role == "system":
result.append(SystemMessage(content=content))
elif role == "user":
result.append(HumanMessage(content=content))
elif role == "assistant":
tool_calls = []
if "tool_calls" in msg:
for tc in msg["tool_calls"]:
tool_calls.append(
{
"id": tc["id"],
"name": tc["function"]["name"],
"args": json.loads(tc["function"]["arguments"]),
}
)
result.append(AIMessage(content=content, tool_calls=tool_calls))
elif role == "tool":
result.append(
ToolMessage(
content=content,
tool_call_id=msg.get("tool_call_id", ""),
)
)
return result
def _optimize_messages(
self, messages: list[BaseMessage]
) -> tuple[list[BaseMessage], OptimizationMetrics]:
"""Apply Headroom optimization to messages."""
request_id = str(uuid4())
# Convert to OpenAI format
openai_messages = self._convert_messages_to_openai(messages)
# Get model name from wrapped model
model = get_model_name_from_langchain(self.wrapped_model)
# Ensure pipeline is initialized (this also sets up provider)
_ = self.pipeline
# Get model context limit from provider
model_limit = self._provider.get_context_limit(model) if self._provider else 128000
# Ensure model is a string
model_str = str(model) if model else "gpt-4o"
# Apply Headroom transforms via pipeline
result = self.pipeline.apply(
messages=openai_messages,
model=model_str,
model_limit=model_limit,
)
# Create metrics
metrics = OptimizationMetrics(
request_id=request_id,
timestamp=datetime.now(),
tokens_before=result.tokens_before,
tokens_after=result.tokens_after,
tokens_saved=result.tokens_before - result.tokens_after,
savings_percent=(
(result.tokens_before - result.tokens_after) / result.tokens_before * 100
if result.tokens_before > 0
else 0
),
transforms_applied=result.transforms_applied,
model=model_str,
)
# Track metrics
self._metrics_history.append(metrics)
self._total_tokens_saved += metrics.tokens_saved
# Keep only last 100 metrics
if len(self._metrics_history) > 100:
self._metrics_history = self._metrics_history[-100:]
# Convert back to LangChain format
optimized_messages = self._convert_messages_from_openai(result.messages)
return optimized_messages, metrics
def _generate(
self,
messages: list[BaseMessage],
stop: list[str] | None = None,
run_manager: Any = None,
**kwargs: Any,
) -> ChatResult:
"""Generate response with Headroom optimization.
This is the core method called by invoke(), batch(), etc.
"""
# Optimize messages
optimized_messages, metrics = self._optimize_messages(messages)
logger.info(
f"Headroom optimized: {metrics.tokens_before} -> {metrics.tokens_after} tokens "
f"({metrics.savings_percent:.1f}% saved)"
)
# Call wrapped model with optimized messages
result: ChatResult = self.wrapped_model._generate(
optimized_messages,
stop=stop,
run_manager=run_manager,
**kwargs,
)
return result
def _stream(
self,
messages: list[BaseMessage],
stop: list[str] | None = None,
run_manager: Any = None,
**kwargs: Any,
) -> Iterator[ChatGenerationChunk]:
"""Stream response with Headroom optimization."""
# Optimize messages
optimized_messages, metrics = self._optimize_messages(messages)
logger.info(
f"Headroom optimized (streaming): {metrics.tokens_before} -> "
f"{metrics.tokens_after} tokens"
)
# Stream from wrapped model
yield from self.wrapped_model._stream(
optimized_messages,
stop=stop,
run_manager=run_manager,
**kwargs,
)
async def _agenerate(
self,
messages: list[BaseMessage],
stop: list[str] | None = None,
run_manager: Any = None,
**kwargs: Any,
) -> ChatResult:
"""Async generate response with Headroom optimization.
This enables `await model.ainvoke(messages)` to work correctly.
The optimization step runs in a thread executor since it's CPU-bound.
"""
# Run optimization in executor (CPU-bound)
loop = asyncio.get_event_loop()
optimized_messages, metrics = await loop.run_in_executor(
None, self._optimize_messages, messages
)
logger.info(
f"Headroom optimized (async): {metrics.tokens_before} -> {metrics.tokens_after} tokens "
f"({metrics.savings_percent:.1f}% saved)"
)
# Call wrapped model's async generate
result: ChatResult = await self.wrapped_model._agenerate(
optimized_messages,
stop=stop,
run_manager=run_manager,
**kwargs,
)
return result
async def _astream(
self,
messages: list[BaseMessage],
stop: list[str] | None = None,
run_manager: Any = None,
**kwargs: Any,
) -> AsyncIterator[ChatGenerationChunk]:
"""Async stream response with Headroom optimization.
This enables `async for chunk in model.astream(messages)` to work correctly.
"""
# Run optimization in executor (CPU-bound)
loop = asyncio.get_event_loop()
optimized_messages, metrics = await loop.run_in_executor(
None, self._optimize_messages, messages
)
logger.info(
f"Headroom optimized (async streaming): {metrics.tokens_before} -> "
f"{metrics.tokens_after} tokens"
)
# Async stream from wrapped model
async for chunk in self.wrapped_model._astream(
optimized_messages,
stop=stop,
run_manager=run_manager,
**kwargs,
):
yield chunk
def bind_tools(self, tools: Sequence[Any], **kwargs: Any) -> HeadroomChatModel:
"""Bind tools to the wrapped model."""
new_wrapped = self.wrapped_model.bind_tools(tools, **kwargs)
return HeadroomChatModel(
wrapped_model=new_wrapped,
config=self.headroom_config,
mode=self.mode,
auto_detect_provider=self.auto_detect_provider,
)
def get_savings_summary(self) -> dict[str, Any]:
"""Get summary of token savings."""
if not self._metrics_history:
return {
"total_requests": 0,
"total_tokens_saved": 0,
"average_savings_percent": 0,
}
return {
"total_requests": len(self._metrics_history),
"total_tokens_saved": self._total_tokens_saved,
"average_savings_percent": sum(m.savings_percent for m in self._metrics_history)
/ len(self._metrics_history),
"total_tokens_before": sum(m.tokens_before for m in self._metrics_history),
"total_tokens_after": sum(m.tokens_after for m in self._metrics_history),
}
class HeadroomCallbackHandler(BaseCallbackHandler):
"""LangChain callback handler for Headroom metrics and observability.
NOTE: Callbacks CANNOT modify messages in LangChain (by design).
Use HeadroomChatModel for actual optimization. This handler is for:
1. Tracking token usage across chains
2. Logging optimization metrics
3. Alerting on high token usage
4. Integration with observability platforms
Example:
from langchain_openai import ChatOpenAI
from headroom.integrations import HeadroomCallbackHandler
handler = HeadroomCallbackHandler(
log_level="INFO",
token_alert_threshold=10000,
)
llm = ChatOpenAI(model="gpt-4o", callbacks=[handler])
response = llm.invoke("Hello!")
# Check metrics
print(f"Total tokens: {handler.total_tokens}")
print(f"Alerts: {handler.alerts}")
"""
def __init__(
self,
log_level: str = "INFO",
token_alert_threshold: int | None = None,
cost_alert_threshold: float | None = None,
):
"""Initialize callback handler.
Args:
log_level: Logging level for metrics ("DEBUG", "INFO", "WARNING")
token_alert_threshold: Alert if request exceeds this many tokens
cost_alert_threshold: Alert if estimated cost exceeds this amount
"""
_check_langchain_available()
self.log_level = log_level
self.token_alert_threshold = token_alert_threshold
self.cost_alert_threshold = cost_alert_threshold
# Metrics tracking
self._requests: list[dict[str, Any]] = []
self._total_tokens = 0
self._alerts: list[str] = []
self._current_request: dict[str, Any] | None = None
@property
def total_tokens(self) -> int:
"""Total tokens used across all requests."""
return self._total_tokens
@property
def total_requests(self) -> int:
"""Total number of requests tracked."""
return len(self._requests)
@property
def alerts(self) -> list[str]:
"""List of alerts triggered."""
return self._alerts.copy()
@property
def requests(self) -> list[dict[str, Any]]:
"""List of request metrics."""
return self._requests.copy()
def on_llm_start(
self,
serialized: dict[str, Any],
prompts: list[str],
**kwargs: Any,
) -> None:
"""Called when LLM starts processing."""
self._current_request = {
"start_time": datetime.now(),
"model": serialized.get("name", "unknown"),
"prompt_count": len(prompts),
"estimated_input_tokens": sum(len(p) // 4 for p in prompts), # Rough estimate
}
if self.log_level == "DEBUG":
logger.debug(f"LLM request started: {self._current_request}")
def on_chat_model_start(
self,
serialized: dict[str, Any],
messages: list[list[BaseMessage]],
**kwargs: Any,
) -> None:
"""Called when chat model starts processing."""
# Estimate tokens from messages
total_content = ""
for msg_list in messages:
for msg in msg_list:
content = msg.content if isinstance(msg.content, str) else str(msg.content)
total_content += content
estimated_tokens = len(total_content) // 4 # Rough estimate
self._current_request = {
"start_time": datetime.now(),
"model": serialized.get("name", serialized.get("id", ["unknown"])[-1]),
"message_count": sum(len(ml) for ml in messages),
"estimated_input_tokens": estimated_tokens,
}
# Check token alert
if self.token_alert_threshold and estimated_tokens > self.token_alert_threshold:
alert = (
f"Token alert: {estimated_tokens} tokens exceeds "
f"threshold {self.token_alert_threshold}"
)
self._alerts.append(alert)
logger.warning(alert)
if self.log_level in ("DEBUG", "INFO"):
logger.log(
logging.DEBUG if self.log_level == "DEBUG" else logging.INFO,
f"Chat model request: ~{estimated_tokens} input tokens",
)
def on_llm_end(self, response: Any, **kwargs: Any) -> None:
"""Called when LLM finishes processing."""
if self._current_request is None:
return
# Extract token usage from response if available
token_usage = {}
if hasattr(response, "llm_output") and response.llm_output:
token_usage = response.llm_output.get("token_usage", {})
self._current_request["end_time"] = datetime.now()
self._current_request["duration_ms"] = (
self._current_request["end_time"] - self._current_request["start_time"]
).total_seconds() * 1000
if token_usage:
self._current_request["input_tokens"] = token_usage.get("prompt_tokens", 0)
self._current_request["output_tokens"] = token_usage.get("completion_tokens", 0)
self._current_request["total_tokens"] = token_usage.get("total_tokens", 0)
self._total_tokens += self._current_request["total_tokens"]
self._requests.append(self._current_request)
# Keep only last 1000 requests
if len(self._requests) > 1000:
self._requests = self._requests[-1000:]
if self.log_level in ("DEBUG", "INFO"):
tokens_info = f"{self._current_request.get('total_tokens', 'unknown')} tokens"
duration = f"{self._current_request['duration_ms']:.0f}ms"
logger.log(
logging.DEBUG if self.log_level == "DEBUG" else logging.INFO,
f"LLM request completed: {tokens_info} in {duration}",
)
self._current_request = None
def on_llm_error(
self,
error: BaseException,
*,
run_id: UUID,
parent_run_id: UUID | None = None,
**kwargs: Any,
) -> Any:
"""Called when LLM encounters an error."""
if self._current_request:
self._current_request["error"] = str(error)
self._current_request["end_time"] = datetime.now()
self._requests.append(self._current_request)
self._current_request = None
logger.error(f"LLM error: {error}")
def get_summary(self) -> dict[str, Any]:
"""Get summary of all tracked requests."""
if not self._requests:
return {
"total_requests": 0,
"total_tokens": 0,
"average_tokens": 0,
"average_duration_ms": 0,
"errors": 0,
"alerts": len(self._alerts),
}
successful = [r for r in self._requests if "error" not in r]
total_tokens = sum(r.get("total_tokens", 0) for r in successful)
return {
"total_requests": len(self._requests),
"successful_requests": len(successful),
"total_tokens": total_tokens,
"average_tokens": total_tokens / len(successful) if successful else 0,
"average_duration_ms": (
sum(r.get("duration_ms", 0) for r in successful) / len(successful)
if successful
else 0
),
"errors": len(self._requests) - len(successful),
"alerts": len(self._alerts),
}
def reset(self) -> None:
"""Reset all tracked metrics."""
self._requests = []
self._total_tokens = 0
self._alerts = []
self._current_request = None
class HeadroomRunnable:
"""LCEL-compatible Runnable for Headroom optimization.
Use this to add Headroom optimization to any LangChain chain using LCEL.
Example:
from langchain_openai import ChatOpenAI
from langchain_core.prompts import ChatPromptTemplate
from headroom.integrations import HeadroomRunnable
prompt = ChatPromptTemplate.from_messages([
("system", "You are a helpful assistant."),
("user", "{input}"),
])
llm = ChatOpenAI(model="gpt-4o")
# Add Headroom optimization to chain
chain = prompt | HeadroomRunnable() | llm
response = chain.invoke({"input": "Hello!"})
"""
def __init__(
self,
config: HeadroomConfig | None = None,
mode: HeadroomMode = HeadroomMode.OPTIMIZE,
):
"""Initialize HeadroomRunnable.
Args:
config: HeadroomConfig for optimization settings
mode: HeadroomMode (AUDIT, OPTIMIZE, or SIMULATE)
"""
_check_langchain_available()
self.config = config or HeadroomConfig()
self.mode = mode
self._pipeline: TransformPipeline | None = None
self._provider: OpenAIProvider | None = None
self._metrics_history: list[OptimizationMetrics] = []
@property
def pipeline(self) -> TransformPipeline:
"""Lazily initialize TransformPipeline."""
if self._pipeline is None:
self._provider = OpenAIProvider()
self._pipeline = TransformPipeline(
config=self.config,
provider=self._provider,
)
return self._pipeline
def __or__(self, other: Any) -> Any:
"""Support pipe operator for LCEL composition."""
from langchain_core.runnables import RunnableSequence
return RunnableSequence(first=self.as_runnable(), last=other)
def __ror__(self, other: Any) -> Any:
"""Support reverse pipe operator."""
from langchain_core.runnables import RunnableSequence
return RunnableSequence(first=other, last=self.as_runnable())
def as_runnable(self) -> RunnableLambda:
"""Convert to LangChain Runnable."""
return RunnableLambda(self._optimize)
def _optimize(self, input_data: Any) -> Any:
"""Optimize input messages."""
# Handle different input types
if isinstance(input_data, list):
messages = input_data
elif hasattr(input_data, "messages"):
messages = input_data.messages
elif hasattr(input_data, "to_messages"):
messages = input_data.to_messages()
else:
# Can't optimize, pass through
return input_data
# Convert messages to OpenAI format
openai_messages = []
for msg in messages:
if isinstance(msg, SystemMessage):
openai_messages.append({"role": "system", "content": msg.content})
elif isinstance(msg, HumanMessage):
openai_messages.append({"role": "user", "content": msg.content})
elif isinstance(msg, AIMessage):
openai_messages.append({"role": "assistant", "content": msg.content})
elif isinstance(msg, ToolMessage):
openai_messages.append(
{
"role": "tool",
"tool_call_id": msg.tool_call_id,
"content": msg.content,
}
)
elif hasattr(msg, "type") and hasattr(msg, "content"):
openai_messages.append(
{
"role": msg.type,
"content": msg.content,
}
)
# Get model context limit
model = "gpt-4o" # Default model for estimation
model_limit = self._provider.get_context_limit(model) if self._provider else 128000
# Apply Headroom transforms via pipeline
result = self.pipeline.apply(
messages=openai_messages,
model=model,
model_limit=model_limit,
)
# Track metrics
metrics = OptimizationMetrics(
request_id=str(uuid4()),
timestamp=datetime.now(),
tokens_before=result.tokens_before,
tokens_after=result.tokens_after,
tokens_saved=result.tokens_before - result.tokens_after,
savings_percent=(
(result.tokens_before - result.tokens_after) / result.tokens_before * 100
if result.tokens_before > 0
else 0
),
transforms_applied=result.transforms_applied,
model="gpt-4o",
)
self._metrics_history.append(metrics)
# Convert back to LangChain messages
output_messages: list[BaseMessage] = []
for msg in result.messages:
role = msg.get("role", "user")
content = msg.get("content", "")
if role == "system":
output_messages.append(SystemMessage(content=content))
elif role == "user":
output_messages.append(HumanMessage(content=content))
elif role == "assistant":
output_messages.append(AIMessage(content=content))
elif role == "tool":
output_messages.append(
ToolMessage(
content=content,
tool_call_id=msg.get("tool_call_id", ""),
)
)
return output_messages
def optimize_messages(
messages: list[BaseMessage],
config: HeadroomConfig | None = None,
mode: HeadroomMode = HeadroomMode.OPTIMIZE,
model: str = "gpt-4o",
) -> tuple[list[BaseMessage], dict[str, Any]]:
"""Standalone function to optimize LangChain messages.
Use this for manual optimization when you need fine-grained control.
Args:
messages: List of LangChain BaseMessage objects
config: HeadroomConfig for optimization settings
mode: HeadroomMode (AUDIT, OPTIMIZE, or SIMULATE)
model: Model name for token estimation
Returns:
Tuple of (optimized_messages, metrics_dict)
Example:
from langchain_core.messages import HumanMessage, SystemMessage
from headroom.integrations import optimize_messages
messages = [
SystemMessage(content="You are helpful."),
HumanMessage(content="What is 2+2?"),
]
optimized, metrics = optimize_messages(messages)
print(f"Saved {metrics['tokens_saved']} tokens")
"""
_check_langchain_available()
config = config or HeadroomConfig()
provider = OpenAIProvider()
pipeline = TransformPipeline(config=config, provider=provider)
# Convert to OpenAI format
openai_messages = []
for msg in messages:
if isinstance(msg, SystemMessage):
openai_messages.append({"role": "system", "content": msg.content})
elif isinstance(msg, HumanMessage):
openai_messages.append({"role": "user", "content": msg.content})
elif isinstance(msg, AIMessage):
entry = {"role": "assistant", "content": msg.content}
if hasattr(msg, "tool_calls") and msg.tool_calls:
entry["tool_calls"] = [
{
"id": tc.get("id", ""),
"type": "function",
"function": {
"name": tc.get("name", ""),
"arguments": _tool_call_args_to_json(tc),
},
}
for tc in msg.tool_calls
]
openai_messages.append(entry)
elif isinstance(msg, ToolMessage):
openai_messages.append(
{
"role": "tool",
"tool_call_id": msg.tool_call_id,
"content": msg.content,
}
)
# Get model context limit
model_limit = provider.get_context_limit(model)
# Apply transforms via pipeline
result = pipeline.apply(
messages=openai_messages,
model=model,
model_limit=model_limit,
)
# Convert back
output_messages: list[BaseMessage] = []
for openai_msg in result.messages:
role = openai_msg.get("role", "user")
content = openai_msg.get("content", "")
if role == "system":
output_messages.append(SystemMessage(content=content))
elif role == "user":
output_messages.append(HumanMessage(content=content))
elif role == "assistant":
tool_calls = []
if "tool_calls" in openai_msg:
for tc in openai_msg["tool_calls"]:
tool_calls.append(
{
"id": tc["id"],
"name": tc["function"]["name"],
"args": json.loads(tc["function"]["arguments"]),
}
)
output_messages.append(AIMessage(content=content, tool_calls=tool_calls))
elif role == "tool":
output_messages.append(
ToolMessage(
content=content,
tool_call_id=openai_msg.get("tool_call_id", ""),
)
)
metrics = {
"tokens_before": result.tokens_before,
"tokens_after": result.tokens_after,
"tokens_saved": result.tokens_before - result.tokens_after,
"savings_percent": (
(result.tokens_before - result.tokens_after) / result.tokens_before * 100
if result.tokens_before > 0
else 0
),
"transforms_applied": result.transforms_applied,
}
return output_messages, metrics
|