Skip to content

API Reference

Quick Reference

Python
from pydantic_ai_summarization import (
    # Capabilities (recommended)
    ContextManagerCapability,
    SummarizationCapability,
    SlidingWindowCapability,
    LimitWarnerCapability,

    # Standalone processors
    SummarizationProcessor,
    SlidingWindowProcessor,
    LimitWarnerProcessor,
    create_summarization_processor,
    create_sliding_window_processor,
    create_limit_warner_processor,

    # Constants
    DEFAULT_SUMMARY_PROMPT,
    DEFAULT_CONTINUATION_PROMPT,
)

Modules

Module Description
Capabilities ContextManagerCapability, SummarizationCapability, SlidingWindowCapability, LimitWarnerCapability
Processor SummarizationProcessor class and factory function
Sliding Window SlidingWindowProcessor class and factory function
Limit Warner LimitWarnerProcessor class and factory function
Types Type definitions and aliases

Comparison

Feature ContextManagerCapability SummarizationCapability SlidingWindowCapability LimitWarnerCapability
LLM Cost Per compression High Zero Zero
Tool Output Truncation Yes No No No
Auto-detect max_tokens Yes No No No
compact() method Yes No No No
compact_conversation tool include_compact_tool No No No
Token Tracking Yes No No Warnings