Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.maximem.ai/llms.txt

Use this file to discover all available pages before exploring further.

await sdk.conversation.context.get_compacted(
    conversation_id: str,
    version: Optional[int] = None,
    format: str = "structured",
) -> Optional[CompactionResponse]
Fetches the most recent compacted summary for a conversation. Local SDK cache is checked first (5 minute TTL); on miss the SDK fetches from Synap and caches the result. Returns None if no compacted summary exists yet — call compact first in that case. When a specific version is requested the local cache is bypassed and the value is fetched fresh from Synap.

​
Parameters

​
conversation_id
str
required
The conversation whose compacted summary you want to read.
​
version
int
Specific compaction version. Defaults to the latest. When supplied, the SDK always fetches from the cloud and skips the local cache.
​
format
str
default:"structured"
Output format:
  • "structured" — structured fields (facts, decisions, preferences, current_state)
  • "narrative" — prose summary
  • "injection" — preformatted for direct prompt injection

​
Returns

A CompactionResponse if a compacted summary exists, otherwise None.
​
compacted_context
str
The formatted compacted context.
​
original_token_count
int
Token count of the original conversation.
​
compacted_token_count
int
Token count after compaction.
​
compression_ratio
float
Compaction ratio (compacted / original).
​
level_applied
CompactionLevel
Strategy actually applied (e.g., adaptive, balanced).
​
compaction_id
str | None
Identifier of the compaction run that produced this summary.
​
strategy_used
str | None
Strategy used for this compaction.
​
validation_score
float | None
Quality validation score, when available.
​
validation_passed
bool | None
Whether the validation check passed.
​
facts
List[str]
Extracted facts (structured format).
​
decisions
List[str]
Extracted decisions (structured format).
​
preferences
List[str]
Extracted preferences (structured format).
​
current_state
Dict[str, Any] | None
Snapshot of current conversation state (structured format).
​
quality_warning
str | None
Optional warning when validation flagged a concern.
​
metadata
ResponseMetadata
Correlation id, source (cache or cloud), TTL, and retrieval timestamp.

​
Example

from maximem_synap import MaximemSynapSDK

sdk = MaximemSynapSDK(api_key="synap_your_key_here")
await sdk.initialize()

compacted = await sdk.conversation.context.get_compacted(
    conversation_id="conv_2026_05_16_alice",
    format="structured",
)

if compacted is None:
    print("No compaction yet — trigger one with sdk.conversation.context.compact()")
else:
    print(f"Compressed {compacted.original_token_count} -> {compacted.compacted_token_count} tokens")
    for fact in compacted.facts:
        print("-", fact)

​
Raises

  • AuthenticationError — when the API key is missing or invalid.
  • NetworkError — when the SDK cannot reach Synap.

​
See also