Memory API¶
Generated from the typed public surface.
tesserix_adk.memory.Admission¶
Stability: alpha
One decision about one candidate fact.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.AdmissionPolicy¶
Stability: alpha
What this deployment allows to become a durable fact.
class AdmissionPolicy(AdkModel) {decide(self, record: 'MemoryRecord', provenance: 'Provenance', *, at: 'float | None' = None) -> 'Admission'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.AssembledContext¶
Stability: alpha
A prompt that fits, and the account of what it took to make it fit.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.Belief¶
Stability: alpha
What a scope holds about one key at one instant, including what it will not say.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.COMPRESSED¶
Stability: alpha
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.CodeCompressor¶
Stability: alpha
Signatures, types and errors kept; bodies elided.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.CompactionOutcome¶
Stability: alpha
What a strategy did, in terms a section report can repeat.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.CompactionStrategy¶
Stability: alpha · Kind: Protocol
How a section is reduced when it does not fit the tokens allowed for it.
class CompactionStrategy(Protocol) {compact(self, entries: 'Sequence[ContextEntry]', *, budget_tokens: 'int', count: 'Callable[[Sequence[Message]], int]') -> 'CompactionOutcome'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.Compressed¶
Stability: alpha
One admission: what went in, what came out, and by what.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.Compressor¶
Stability: alpha · Kind: Protocol
Something that makes one kind of content smaller without losing what it carries.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.ConfidenceFloor¶
Stability: alpha
Recall only what was written with at least minimum confidence.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.ContentKind¶
Stability: alpha
What admitted content turned out to be.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.ContentRouter¶
Stability: alpha
Classifies admitted content and hands it to the compressor that understands it.
class ContentRouter(object) {admit(self, content: 'str', *, budget_tokens: 'int', untrusted: 'bool' = False) -> 'Compressed'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.ContextAssembler¶
Stability: alpha
Builds a prompt from a plan, a provider's token count and a set of strategies.
class ContextAssembler(object) {assemble(self, sections: 'Mapping[str, Sequence[Message]]') -> 'AssembledContext'}
Typed errors: ValueError
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.ContextEntry¶
Stability: alpha
One candidate message, with the identity a report can name it by.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.ContextPlan¶
Stability: alpha
What the prompt is made of, and how much room there is for it.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.Contradiction¶
Stability: alpha
Live records about one subject that disagree, and that nothing may resolve alone.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.ContradictionPolicy¶
Stability: alpha · Kind: Protocol
Decides what an incoming record does to the one already held.
class ContradictionPolicy(Protocol) {resolve(self, existing: 'MemoryRecord', incoming: 'MemoryRecord') -> 'Resolution'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.DEFAULT_COMPRESSORS¶
Stability: alpha
dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.DEFAULT_REDACTOR¶
Stability: alpha
Masks anything shaped like a secret, wherever it sits inside the value.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.DecayPolicy¶
Stability: alpha · Kind: Protocol
How much of a record survives the passage of time, or its own uncertainty.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.Derivation¶
Stability: alpha
An artefact built from a record, and therefore erased with it.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.DerivedIndex¶
Stability: alpha · Kind: Protocol
Something holding artefacts derived from records, which erasure must reach into.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.DropOldest¶
Stability: alpha
Drop unpinned entries from the front until what is left fits.
class DropOldest(object) {compact(self, entries: 'Sequence[ContextEntry]', *, budget_tokens: 'int', count: 'TokenCounter') -> 'CompactionOutcome'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.EXPAND_TOOL¶
Stability: alpha
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.ErasureReceipt¶
Stability: alpha
What an erasure actually removed, in a form somebody can be shown.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.Expansion¶
Stability: alpha
What a handle resolved to.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.FrozenPrefix¶
Stability: alpha
One context's boundary between cached history and content that just arrived.
class FrozenPrefix(object) {advance(self, messages: 'Sequence[Message]', *, turn: 'int') -> 'PrefixBoundary'; compressible(self, messages: 'Sequence[Message]') -> 'tuple[int, ...]'; live(self, messages: 'Sequence[Message]') -> 'tuple[Message, ...]'; reset(self, reason: 'str') -> 'PrefixBoundary'; verify(self, messages: 'Sequence[Message]') -> 'None'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.HalfLife¶
Stability: alpha
Exponential decay by age, ignored below floor.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.HeadroomMcpOptimizer¶
Stability: alpha
Headroom's MCP contract bound to exactly one tenant and run.
class HeadroomMcpOptimizer(object) {compress(self, content: 'str', *, tenant: 'str', run_id: 'str', untrusted: 'bool' = False) -> 'OptimizationResult'; retrieve(self, handle: 'str', *, tenant: 'str', run_id: 'str') -> 'str'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.INSTRUCTION_SIGNATURES¶
Stability: alpha
Built-in immutable sequence.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.MemoryCapabilities¶
Stability: alpha
What a store supports, in its own words.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.MemoryGuard¶
Stability: alpha · Kind: Protocol
The narrow part of a guard that a recall needs: judge this text as an input.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.MemoryHit¶
Stability: alpha
A record a query matched, and how well.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.MemoryKind¶
Stability: alpha
What kind of remembering a record is, which decides where it is kept.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.MemoryNeeds¶
Stability: alpha
What a consumer's plan requires of whatever store it is given.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.MemoryQuery¶
Stability: alpha
What to look for, in one of the four kinds.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.MemoryRecord¶
Stability: alpha
One remembered thing, with everything needed to decide whether to believe it.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.MemoryRedactor¶
Stability: alpha · Kind: Protocol
What decides whether a value is fit to be stored, and masks it where it is not.
class MemoryRedactor(Protocol) {redact(self, value: 'JsonValue') -> 'tuple[JsonValue, tuple[str, ...]]'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.MemoryScope¶
Stability: alpha
The addressing of a memory: tenant, then who and what within it.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.MemoryStore¶
Stability: alpha · Kind: Protocol
Working, profile, episodic and semantic memory behind one substitutable dependency.
class MemoryStore(Protocol) {append(self, scope: 'MemoryScope', key: 'str', value: 'JsonValue') -> 'int'; belief(self, scope: 'MemoryScope', key: 'str', *, as_of: 'float | None' = None) -> 'Belief'; derivations(self, scope: 'MemoryScope', *, source_id: 'str | None' = None) -> 'Sequence[Derivation]'; derived(self, scope: 'MemoryScope', derivation: 'Derivation') -> 'None'; episodes(self, scope: 'MemoryScope', query: 'MemoryQuery') -> 'Sequence[MemoryHit]'; erase(self, scope: 'MemoryScope', *, kinds: 'tuple[MemoryKind, ...]' = (), dry_run: 'bool' = False) -> 'ErasureReceipt'; expire(self, scope: 'MemoryScope', key: 'str', *, ttl_seconds: 'float') -> 'None'; history(self, scope: 'MemoryScope', key: 'str | None' = None) -> 'Sequence[MemoryRecord]'; index(self, scope: 'MemoryScope', record: 'MemoryRecord') -> 'None'; log(self, scope: 'MemoryScope', record: 'MemoryRecord') -> 'None'; profile(self, scope: 'MemoryScope', key: 'str', *, as_of: 'float | None' = None) -> 'MemoryRecord | None'; read(self, scope: 'MemoryScope', key: 'str') -> 'MemoryRecord | None'; search(self, scope: 'MemoryScope', query: 'MemoryQuery') -> 'Sequence[MemoryHit]'; supersede(self, scope: 'MemoryScope', record: 'MemoryRecord', *, expected_version: 'int | None' = None, resolves: 'tuple[str, ...]' = ()) -> 'Supersession'; upsert(self, scope: 'MemoryScope', record: 'MemoryRecord') -> 'None'; write(self, scope: 'MemoryScope', record: 'MemoryRecord') -> 'None'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.OptimizationBackend¶
Stability: alpha
The component selected for one optimisation decision.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.OptimizationChannel¶
Stability: alpha
Where content came from, which is the safe routing signal.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.OptimizationDecision¶
Stability: alpha
Which backend applies and why.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.OptimizationError¶
Stability: alpha
An optimiser response was unavailable, invalid, or outside its bound scope.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.OptimizationPolicy¶
Stability: alpha
The explicit matrix used for every optimiser decision.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.OptimizationResult¶
Stability: alpha
Content after optimisation, with enough data to meter the decision.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.Origin¶
Stability: alpha
Who or what produced a fact, which is what decides how far it is trusted.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.POSITION_METRIC¶
Stability: alpha
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.PassThrough¶
Stability: alpha
The terminal fallback: content admitted exactly as it arrived.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.PatternRedactor¶
Stability: alpha
Masks anything shaped like a secret, wherever it sits inside the value.
class PatternRedactor(object) {redact(self, value: 'JsonValue') -> 'tuple[JsonValue, tuple[str, ...]]'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.PinAndFold¶
Stability: alpha
Keep pinned entries verbatim and fold the rest into one short note.
class PinAndFold(object) {compact(self, entries: 'Sequence[ContextEntry]', *, budget_tokens: 'int', count: 'TokenCounter') -> 'CompactionOutcome'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.PrefixBoundary¶
Stability: alpha
Where the frozen region ends, and what it was when it was frozen.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.ProseCompressor¶
Stability: alpha
Whitespace collapsed and repeated sentences dropped, in the order first seen.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.Provenance¶
Stability: alpha
The write this fact came from, carried on the record for as long as it is kept.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.RESETS_METRIC¶
Stability: alpha
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.Recall¶
Stability: alpha
What survived a read, and what did not.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.Resolution¶
Stability: alpha
What a policy decided to do with a write that met an existing record.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.ReversibleRouter¶
Stability: alpha
A ContentRouter that keeps the original and hands back a way to reach it.
class ReversibleRouter(object) {admit(self, content: 'str', *, budget_tokens: 'int', tenant: 'str', run_id: 'str', untrusted: 'bool' = False) -> 'Compressed'; expand(self, handle: 'str', *, tenant: 'str', run_id: 'str', budget_tokens: 'int | None' = None, user: 'str | None' = None) -> 'Expansion'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.RtkCommandPlan¶
Stability: alpha
A command argv after policy selection, never a shell string.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.SECTION¶
Stability: alpha
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.SectionOutcome¶
Stability: alpha
What became of one section, in terms a reader can act on.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.SectionPlan¶
Stability: alpha
One part of the prompt, and what may happen to it under pressure.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.SizeCounter¶
Stability: alpha
Type alias.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.StructuredCompressor¶
Stability: alpha
JSON, factored: shared fields hoisted, rows deduplicated, whitespace gone.
class StructuredCompressor(object) {compress(self, content: 'str', *, budget_tokens: 'int') -> 'str'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.SummariseSpan¶
Stability: alpha
Replace the oldest unpinned span with a model-written summary of it.
class SummariseSpan(object) {compact(self, entries: 'Sequence[ContextEntry]', *, budget_tokens: 'int', count: 'TokenCounter') -> 'CompactionOutcome'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.SupersedeMatching¶
Stability: alpha
The default: replace what says the same thing, branch on a partial overlap.
class SupersedeMatching(object) {resolve(self, existing: 'MemoryRecord', incoming: 'MemoryRecord') -> 'Resolution'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.Supersession¶
Stability: alpha
What a supersessive write did.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.TabularCompressor¶
Stability: alpha
Aligned columns, unaligned: single-space delimiters and no repeated rows.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.TokenCounter¶
Stability: alpha
Type alias.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.TokenOptimizer¶
Stability: alpha
Select RTK for commands and Headroom for shared content.
class TokenOptimizer(object) {optimize(self, content: 'str', *, channel: 'OptimizationChannel', tenant: 'str', run_id: 'str', headroom_allowed: 'bool' = False, untrusted: 'bool' = False) -> 'OptimizationResult'; plan_command(self, argv: 'Sequence[str]') -> 'RtkCommandPlan'; retrieve(self, handle: 'str', *, tenant: 'str', run_id: 'str') -> 'str'; select(self, channel: 'OptimizationChannel', *, command: 'Sequence[str]' = (), headroom_allowed: 'bool' = False) -> 'OptimizationDecision'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.Verdict¶
Stability: alpha
What an admission policy decided about one candidate fact.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.WriteGate¶
Stability: alpha
Both boundaries around a memory store: what gets in, and what comes back out.
class WriteGate(object) {admit(self, record: 'MemoryRecord', provenance: 'Provenance', *, tenant: 'str', user: 'str | None' = None) -> 'MemoryRecord'; recall(self, records: 'Iterable[MemoryRecord]', *, guard: 'MemoryGuard | None' = None) -> 'Recall'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.admission.Admission¶
Stability: alpha
One decision about one candidate fact.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.admission.AdmissionPolicy¶
Stability: alpha
What this deployment allows to become a durable fact.
class AdmissionPolicy(AdkModel) {decide(self, record: 'MemoryRecord', provenance: 'Provenance', *, at: 'float | None' = None) -> 'Admission'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.admission.INSTRUCTION_SIGNATURES¶
Stability: alpha
Built-in immutable sequence.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.admission.MemoryGuard¶
Stability: alpha · Kind: Protocol
The narrow part of a guard that a recall needs: judge this text as an input.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.admission.Recall¶
Stability: alpha
What survived a read, and what did not.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.admission.Verdict¶
Stability: alpha
What an admission policy decided about one candidate fact.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.admission.WriteGate¶
Stability: alpha
Both boundaries around a memory store: what gets in, and what comes back out.
class WriteGate(object) {admit(self, record: 'MemoryRecord', provenance: 'Provenance', *, tenant: 'str', user: 'str | None' = None) -> 'MemoryRecord'; recall(self, records: 'Iterable[MemoryRecord]', *, guard: 'MemoryGuard | None' = None) -> 'Recall'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.admission.instruction_shaped¶
Stability: alpha
Return the instruction-shaped phrase inside value, or an empty string.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.beliefs.Belief¶
Stability: alpha
What a scope holds about one key at one instant, including what it will not say.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.beliefs.ConfidenceFloor¶
Stability: alpha
Recall only what was written with at least minimum confidence.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.beliefs.Contradiction¶
Stability: alpha
Live records about one subject that disagree, and that nothing may resolve alone.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.beliefs.ContradictionPolicy¶
Stability: alpha · Kind: Protocol
Decides what an incoming record does to the one already held.
class ContradictionPolicy(Protocol) {resolve(self, existing: 'MemoryRecord', incoming: 'MemoryRecord') -> 'Resolution'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.beliefs.DecayPolicy¶
Stability: alpha · Kind: Protocol
How much of a record survives the passage of time, or its own uncertainty.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.beliefs.HalfLife¶
Stability: alpha
Exponential decay by age, ignored below floor.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.beliefs.Resolution¶
Stability: alpha
What a policy decided to do with a write that met an existing record.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.beliefs.SupersedeMatching¶
Stability: alpha
The default: replace what says the same thing, branch on a partial overlap.
class SupersedeMatching(object) {resolve(self, existing: 'MemoryRecord', incoming: 'MemoryRecord') -> 'Resolution'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.beliefs.Supersession¶
Stability: alpha
What a supersessive write did.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.capabilities.MemoryCapabilities¶
Stability: alpha
What a store supports, in its own words.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.capabilities.MemoryNeeds¶
Stability: alpha
What a consumer's plan requires of whatever store it is given.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.capabilities.require_memory¶
Stability: alpha
Check store against needs, or raise naming everything it is missing.
Typed errors: CapabilityError
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.classify¶
Stability: alpha
Decide what content is, or decline to.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.compaction.CompactionOutcome¶
Stability: alpha
What a strategy did, in terms a section report can repeat.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.compaction.CompactionStrategy¶
Stability: alpha · Kind: Protocol
How a section is reduced when it does not fit the tokens allowed for it.
class CompactionStrategy(Protocol) {compact(self, entries: 'Sequence[ContextEntry]', *, budget_tokens: 'int', count: 'Callable[[Sequence[Message]], int]') -> 'CompactionOutcome'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.compaction.ContextEntry¶
Stability: alpha
One candidate message, with the identity a report can name it by.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.compaction.DropOldest¶
Stability: alpha
Drop unpinned entries from the front until what is left fits.
class DropOldest(object) {compact(self, entries: 'Sequence[ContextEntry]', *, budget_tokens: 'int', count: 'TokenCounter') -> 'CompactionOutcome'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.compaction.PinAndFold¶
Stability: alpha
Keep pinned entries verbatim and fold the rest into one short note.
class PinAndFold(object) {compact(self, entries: 'Sequence[ContextEntry]', *, budget_tokens: 'int', count: 'TokenCounter') -> 'CompactionOutcome'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.compaction.SummariseSpan¶
Stability: alpha
Replace the oldest unpinned span with a model-written summary of it.
class SummariseSpan(object) {compact(self, entries: 'Sequence[ContextEntry]', *, budget_tokens: 'int', count: 'TokenCounter') -> 'CompactionOutcome'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.compaction.TokenCounter¶
Stability: alpha
Type alias.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.compaction.pinned¶
Stability: alpha
Return message marked non-evictable.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.compressed¶
Stability: alpha
Return message marked as already compressed, so no later turn compresses it again.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.compression.CodeCompressor¶
Stability: alpha
Signatures, types and errors kept; bodies elided.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.compression.Compressed¶
Stability: alpha
One admission: what went in, what came out, and by what.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.compression.Compressor¶
Stability: alpha · Kind: Protocol
Something that makes one kind of content smaller without losing what it carries.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.compression.ContentKind¶
Stability: alpha
What admitted content turned out to be.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.compression.ContentRouter¶
Stability: alpha
Classifies admitted content and hands it to the compressor that understands it.
class ContentRouter(object) {admit(self, content: 'str', *, budget_tokens: 'int', untrusted: 'bool' = False) -> 'Compressed'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.compression.PassThrough¶
Stability: alpha
The terminal fallback: content admitted exactly as it arrived.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.compression.ProseCompressor¶
Stability: alpha
Whitespace collapsed and repeated sentences dropped, in the order first seen.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.compression.SizeCounter¶
Stability: alpha
Type alias.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.compression.StructuredCompressor¶
Stability: alpha
JSON, factored: shared fields hoisted, rows deduplicated, whitespace gone.
class StructuredCompressor(object) {compress(self, content: 'str', *, budget_tokens: 'int') -> 'str'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.compression.TabularCompressor¶
Stability: alpha
Aligned columns, unaligned: single-space delimiters and no repeated rows.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.compression.classify¶
Stability: alpha
Decide what content is, or decline to.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.compression.estimate_tokens¶
Stability: alpha
Approximate the tokens in content without a tokeniser.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.context.AssembledContext¶
Stability: alpha
A prompt that fits, and the account of what it took to make it fit.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.context.ContextAssembler¶
Stability: alpha
Builds a prompt from a plan, a provider's token count and a set of strategies.
class ContextAssembler(object) {assemble(self, sections: 'Mapping[str, Sequence[Message]]') -> 'AssembledContext'}
Typed errors: ValueError
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.context.ContextPlan¶
Stability: alpha
What the prompt is made of, and how much room there is for it.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.context.SectionOutcome¶
Stability: alpha
What became of one section, in terms a reader can act on.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.context.SectionPlan¶
Stability: alpha
One part of the prompt, and what may happen to it under pressure.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.erasure.DEFAULT_REDACTOR¶
Stability: alpha
Masks anything shaped like a secret, wherever it sits inside the value.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.erasure.Derivation¶
Stability: alpha
An artefact built from a record, and therefore erased with it.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.erasure.DerivedIndex¶
Stability: alpha · Kind: Protocol
Something holding artefacts derived from records, which erasure must reach into.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.erasure.ErasureReceipt¶
Stability: alpha
What an erasure actually removed, in a form somebody can be shown.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.erasure.MemoryRedactor¶
Stability: alpha · Kind: Protocol
What decides whether a value is fit to be stored, and masks it where it is not.
class MemoryRedactor(Protocol) {redact(self, value: 'JsonValue') -> 'tuple[JsonValue, tuple[str, ...]]'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.erasure.PIIRedactor¶
Stability: alpha
Stands a placeholder in for each identifier, at any depth inside the value.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.erasure.PatternRedactor¶
Stability: alpha
Masks anything shaped like a secret, wherever it sits inside the value.
class PatternRedactor(object) {redact(self, value: 'JsonValue') -> 'tuple[JsonValue, tuple[str, ...]]'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.estimate_tokens¶
Stability: alpha
Approximate the tokens in content without a tokeniser.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.instruction_shaped¶
Stability: alpha
Return the instruction-shaped phrase inside value, or an empty string.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.optimization.HeadroomMcpOptimizer¶
Stability: alpha
Headroom's MCP contract bound to exactly one tenant and run.
class HeadroomMcpOptimizer(object) {compress(self, content: 'str', *, tenant: 'str', run_id: 'str', untrusted: 'bool' = False) -> 'OptimizationResult'; retrieve(self, handle: 'str', *, tenant: 'str', run_id: 'str') -> 'str'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.optimization.OptimizationBackend¶
Stability: alpha
The component selected for one optimisation decision.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.optimization.OptimizationChannel¶
Stability: alpha
Where content came from, which is the safe routing signal.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.optimization.OptimizationDecision¶
Stability: alpha
Which backend applies and why.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.optimization.OptimizationError¶
Stability: alpha
An optimiser response was unavailable, invalid, or outside its bound scope.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.optimization.OptimizationPolicy¶
Stability: alpha
The explicit matrix used for every optimiser decision.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.optimization.OptimizationResult¶
Stability: alpha
Content after optimisation, with enough data to meter the decision.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.optimization.RtkCommandPlan¶
Stability: alpha
A command argv after policy selection, never a shell string.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.optimization.TokenOptimizer¶
Stability: alpha
Select RTK for commands and Headroom for shared content.
class TokenOptimizer(object) {optimize(self, content: 'str', *, channel: 'OptimizationChannel', tenant: 'str', run_id: 'str', headroom_allowed: 'bool' = False, untrusted: 'bool' = False) -> 'OptimizationResult'; plan_command(self, argv: 'Sequence[str]') -> 'RtkCommandPlan'; retrieve(self, handle: 'str', *, tenant: 'str', run_id: 'str') -> 'str'; select(self, channel: 'OptimizationChannel', *, command: 'Sequence[str]' = (), headroom_allowed: 'bool' = False) -> 'OptimizationDecision'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.pinned¶
Stability: alpha
Return message marked non-evictable.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.prefix.COMPRESSED¶
Stability: alpha
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.prefix.FrozenPrefix¶
Stability: alpha
One context's boundary between cached history and content that just arrived.
class FrozenPrefix(object) {advance(self, messages: 'Sequence[Message]', *, turn: 'int') -> 'PrefixBoundary'; compressible(self, messages: 'Sequence[Message]') -> 'tuple[int, ...]'; live(self, messages: 'Sequence[Message]') -> 'tuple[Message, ...]'; reset(self, reason: 'str') -> 'PrefixBoundary'; verify(self, messages: 'Sequence[Message]') -> 'None'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.prefix.POSITION_METRIC¶
Stability: alpha
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.prefix.PrefixBoundary¶
Stability: alpha
Where the frozen region ends, and what it was when it was frozen.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.prefix.RESETS_METRIC¶
Stability: alpha
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.prefix.SECTION¶
Stability: alpha
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.prefix.compressed¶
Stability: alpha
Return message marked as already compressed, so no later turn compresses it again.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.protocol.MemoryStore¶
Stability: alpha · Kind: Protocol
Working, profile, episodic and semantic memory behind one substitutable dependency.
class MemoryStore(Protocol) {append(self, scope: 'MemoryScope', key: 'str', value: 'JsonValue') -> 'int'; belief(self, scope: 'MemoryScope', key: 'str', *, as_of: 'float | None' = None) -> 'Belief'; derivations(self, scope: 'MemoryScope', *, source_id: 'str | None' = None) -> 'Sequence[Derivation]'; derived(self, scope: 'MemoryScope', derivation: 'Derivation') -> 'None'; episodes(self, scope: 'MemoryScope', query: 'MemoryQuery') -> 'Sequence[MemoryHit]'; erase(self, scope: 'MemoryScope', *, kinds: 'tuple[MemoryKind, ...]' = (), dry_run: 'bool' = False) -> 'ErasureReceipt'; expire(self, scope: 'MemoryScope', key: 'str', *, ttl_seconds: 'float') -> 'None'; history(self, scope: 'MemoryScope', key: 'str | None' = None) -> 'Sequence[MemoryRecord]'; index(self, scope: 'MemoryScope', record: 'MemoryRecord') -> 'None'; log(self, scope: 'MemoryScope', record: 'MemoryRecord') -> 'None'; profile(self, scope: 'MemoryScope', key: 'str', *, as_of: 'float | None' = None) -> 'MemoryRecord | None'; read(self, scope: 'MemoryScope', key: 'str') -> 'MemoryRecord | None'; search(self, scope: 'MemoryScope', query: 'MemoryQuery') -> 'Sequence[MemoryHit]'; supersede(self, scope: 'MemoryScope', record: 'MemoryRecord', *, expected_version: 'int | None' = None, resolves: 'tuple[str, ...]' = ()) -> 'Supersession'; upsert(self, scope: 'MemoryScope', record: 'MemoryRecord') -> 'None'; write(self, scope: 'MemoryScope', record: 'MemoryRecord') -> 'None'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.provenance.Origin¶
Stability: alpha
Who or what produced a fact, which is what decides how far it is trusted.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.provenance.Provenance¶
Stability: alpha
The write this fact came from, carried on the record for as long as it is kept.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.records.MemoryHit¶
Stability: alpha
A record a query matched, and how well.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.records.MemoryKind¶
Stability: alpha
What kind of remembering a record is, which decides where it is kept.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.records.MemoryQuery¶
Stability: alpha
What to look for, in one of the four kinds.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.records.MemoryRecord¶
Stability: alpha
One remembered thing, with everything needed to decide whether to believe it.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.require_memory¶
Stability: alpha
Check store against needs, or raise naming everything it is missing.
Typed errors: CapabilityError
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.reversible.EXPAND_TOOL¶
Stability: alpha
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.reversible.Expansion¶
Stability: alpha
What a handle resolved to.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.reversible.ReversibleRouter¶
Stability: alpha
A ContentRouter that keeps the original and hands back a way to reach it.
class ReversibleRouter(object) {admit(self, content: 'str', *, budget_tokens: 'int', tenant: 'str', run_id: 'str', untrusted: 'bool' = False) -> 'Compressed'; expand(self, handle: 'str', *, tenant: 'str', run_id: 'str', budget_tokens: 'int | None' = None, user: 'str | None' = None) -> 'Expansion'}
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.
tesserix_adk.memory.scope.MemoryScope¶
Stability: alpha
The addressing of a memory: tenant, then who and what within it.
Typed errors: None declared.
Runnable recipe: examples/getting_started.py — the public starting point is typed and fail closed.