mirror of
https://github.com/pydantic/pydantic-ai-harness.git
synced 2026-07-21 02:45:34 +00:00
* refactor: graduate capabilities out of `experimental` (ACP excepted) The `experimental` label suppressed the try->fail->report->improve loop we want from real usage, so drop it from the harness. Ten capabilities move to top-level submodules; ACP stays experimental (it may still be reshaped or moved to core, and can't be generic across agents). - Old `pydantic_ai_harness.experimental.<name>` paths keep working as DeprecationWarning shims (via `warn_moved`), so existing imports don't break. - Renames to match capability names: authoring -> runtime_authoring, overflow -> overflowing_tool_output. - Capabilities stay in individual submodules with no top-level re-export, so importing the root package never pulls in a capability's optional deps. - Docs drop the experimental framing and the "may be removed in any release" language in favor of "API subject to change". * docs: tell capability authors to ask the user when unsure about a name Per PR review: a name is a public commitment once shipped, so ask rather than guess.
124 lines
4.3 KiB
Python
124 lines
4.3 KiB
Python
"""`SlidingWindow` -- zero-cost trimming of the oldest messages."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from collections.abc import Callable
|
|
from dataclasses import dataclass
|
|
from typing import TYPE_CHECKING
|
|
|
|
from pydantic_ai._run_context import AgentDepsT
|
|
from pydantic_ai.capabilities import AbstractCapability
|
|
from pydantic_ai.messages import ModelMessage
|
|
from pydantic_ai.tools import RunContext
|
|
|
|
from pydantic_ai_harness.compaction._shared import (
|
|
compact_with_span,
|
|
exceeds,
|
|
find_safe_cutoff,
|
|
find_token_cutoff,
|
|
prepend_first_user_message,
|
|
)
|
|
|
|
if TYPE_CHECKING:
|
|
from pydantic_ai.models import ModelRequestContext
|
|
|
|
|
|
@dataclass
|
|
class SlidingWindow(AbstractCapability[AgentDepsT]):
|
|
"""Zero-cost sliding-window trimmer.
|
|
|
|
When the conversation exceeds a configurable threshold (message count or
|
|
estimated token count), the oldest messages are discarded while preserving
|
|
tool-call / tool-return pairs. No LLM calls are made.
|
|
|
|
Trimming happens in ``before_model_request`` so it is transparent to the
|
|
rest of the agent run.
|
|
|
|
Example:
|
|
```python
|
|
from pydantic_ai import Agent
|
|
from pydantic_ai_harness.compaction import SlidingWindow
|
|
|
|
agent = Agent(
|
|
'openai:gpt-4o',
|
|
capabilities=[SlidingWindow(max_messages=80, keep_messages=40)],
|
|
)
|
|
```
|
|
"""
|
|
|
|
max_messages: int | None = None
|
|
"""Trigger trimming when message count reaches this value. ``None`` disables."""
|
|
|
|
max_tokens: int | None = None
|
|
"""Trigger trimming when estimated token count reaches this value. ``None`` disables."""
|
|
|
|
keep_messages: int = 40
|
|
"""Number of tail messages to retain after trimming (message-count trigger)."""
|
|
|
|
keep_tokens: int | None = None
|
|
"""Target token budget after trimming (token-count trigger).
|
|
|
|
When ``None``, falls back to ``keep_messages``.
|
|
"""
|
|
|
|
tokenizer: Callable[[str], int] | None = None
|
|
"""Optional tokenizer for accurate token counting.
|
|
|
|
A callable that returns the token count for a given string.
|
|
When ``None``, uses a ~4 characters-per-token heuristic.
|
|
"""
|
|
|
|
preserve_first_user_message: bool = True
|
|
"""When ``True``, the first ``ModelRequest`` containing a ``UserPromptPart``
|
|
is always kept after trimming, in addition to system prompts.
|
|
"""
|
|
|
|
def __post_init__(self) -> None:
|
|
if self.max_messages is None and self.max_tokens is None:
|
|
raise ValueError('At least one of max_messages or max_tokens must be set.')
|
|
if self.max_messages is not None and self.max_messages < 1:
|
|
raise ValueError('max_messages must be positive.')
|
|
if self.max_tokens is not None and self.max_tokens < 1:
|
|
raise ValueError('max_tokens must be positive.')
|
|
if self.keep_messages < 0:
|
|
raise ValueError('keep_messages must be non-negative.')
|
|
if self.keep_tokens is not None and self.keep_tokens < 0:
|
|
raise ValueError('keep_tokens must be non-negative.')
|
|
|
|
async def compact(
|
|
self,
|
|
messages: list[ModelMessage],
|
|
ctx: RunContext[AgentDepsT],
|
|
) -> list[ModelMessage]:
|
|
"""Drop the oldest messages down to the configured tail."""
|
|
if self.keep_tokens is not None:
|
|
cutoff = find_token_cutoff(messages, self.keep_tokens, self.tokenizer)
|
|
else:
|
|
cutoff = find_safe_cutoff(messages, self.keep_messages)
|
|
|
|
if cutoff <= 0:
|
|
return messages
|
|
|
|
trimmed = messages[cutoff:]
|
|
if self.preserve_first_user_message:
|
|
trimmed = prepend_first_user_message(messages, cutoff, trimmed)
|
|
return trimmed
|
|
|
|
async def before_model_request(
|
|
self,
|
|
ctx: RunContext[AgentDepsT],
|
|
request_context: ModelRequestContext,
|
|
) -> ModelRequestContext:
|
|
"""Trim the message list if it exceeds the configured threshold."""
|
|
messages: list[ModelMessage] = list(request_context.messages)
|
|
if not exceeds(messages, self.max_messages, self.max_tokens, self.tokenizer):
|
|
return request_context
|
|
request_context.messages = await compact_with_span(
|
|
ctx,
|
|
strategy='SlidingWindow',
|
|
messages=messages,
|
|
compact=lambda: self.compact(messages, ctx),
|
|
tokenizer=self.tokenizer,
|
|
)
|
|
return request_context
|