Class EventsCompactionConfig

src/google/adk/apps/_configs.py:50–95

The config of event compaction for an application.

@experimental
class EventsCompactionConfig(BaseModel):
  """The config of event compaction for an application."""

  model_config = ConfigDict(
      arbitrary_types_allowed=True,
      extra="forbid",
  )

  summarizer: Optional[BaseEventsSummarizer] = None
  """The event summarizer to use for compaction."""

  compaction_interval: int
  """The number of *new* user-initiated invocations that, once
  fully represented in the session's events, will trigger a compaction."""

  overlap_size: int
  """The number of preceding invocations to include from the
  end of the last compacted range. This creates an overlap between consecutive
  compacted summaries, maintaining context."""

  token_threshold: Optional[int] = Field(
      default=None,
      gt=0,
  )
  """Post-invocation token threshold trigger.

  If set, ADK will attempt a post-invocation compaction when the most recently
  observed prompt token count meets or exceeds this threshold.
  """

  event_retention_size: Optional[int] = Field(default=None, ge=0)
  """Post-invocation raw event retention size.

  If token-based post-invocation compaction is triggered, this keeps the last N
  raw events un-compacted.
  """

  @model_validator(mode="after")
  def _validate_token_params(self) -> EventsCompactionConfig:
    token_threshold_set = self.token_threshold is not None
    retention_size_set = self.event_retention_size is not None
    if token_threshold_set != retention_size_set:
      raise ValueError(
          "token_threshold and event_retention_size must be set together."
      )
    return self