Interface: ForgetUserMemoryOptions
Defined in: packages/agentos/src/cognition/memory/io/forgetUserMemory.ts:44
Properties
agentId
agentId:
string
Defined in: packages/agentos/src/cognition/memory/io/forgetUserMemory.ts:57
The agent whose store this is: its key for the subject is always deleted, with every other agent's key of the subject the store's registry holds.
alsoIncomplete?
optionalalsoIncomplete:boolean
Defined in: packages/agentos/src/cognition/memory/io/forgetUserMemory.ts:71
The caller's own stores failed: the report is incomplete.
drain()?
optionaldrain: () =>Promise<{drained:number;pendingAtDeadline:number; }>
Defined in: packages/agentos/src/cognition/memory/io/forgetUserMemory.ts:59
Waits for the subject's pending writes and compiles, up to the caller's deadline. Unset: nothing is pending.
Returns
Promise<{ drained: number; pendingAtDeadline: number; }>
extraStores?
optionalextraStores: ({deleted:number;reached:true;store:string; } | {reached:false;reason:string;store:string; })[] | () => ({deleted:number;reached:true;store:string; } | {reached:false;reason:string;store:string; })[]
Defined in: packages/agentos/src/cognition/memory/io/forgetUserMemory.ts:69
Entries the caller adds to the report: stores it reached itself, and stores it knows are not reached. They do not
change complete. A function is called once the tombstone is written and the deletes are done, so what it
deletes stays while the tombstone cannot be written.
ledger?
optionalledger:ForgottenLedger
Defined in: packages/agentos/src/cognition/memory/io/forgetUserMemory.ts:48
Defaults to memory.forgotten.
legacy?
optionallegacy:LegacyDeletion
Defined in: packages/agentos/src/cognition/memory/io/forgetUserMemory.ts:83
The memory from before per-user scope a single person's install attributed to one user (legacyMemory). When
ownerKey is the subject's key for this agent, the deletion also deletes the legacy traces under each of forms
and each legacy compiled page, and then, once every such page is gone, the attribution. Any other subject never
touches it.
legacyUnattributed()?
optionallegacyUnattributed: () =>Promise<boolean>
Defined in: packages/agentos/src/cognition/memory/io/forgetUserMemory.ts:76
Whether the store holds memory from before per-user scope that nobody attributed, read when the deletes are done.
Returns
Promise<boolean>
memory
memory:
Memory
Defined in: packages/agentos/src/cognition/memory/io/forgetUserMemory.ts:46
The store, opened with a forgotten-user ledger.
onChain()?
optionalonChain: <T>(work) =>Promise<T>
Defined in: packages/agentos/src/cognition/memory/io/forgetUserMemory.ts:61
Runs the deletes in the subject's turn, after its writes and compiles. Unset: they run at once.
Type Parameters
T
T
Parameters
work
() => Promise<T>
Returns
Promise<T>
subject
subject:
SuppressionSubject
Defined in: packages/agentos/src/cognition/memory/io/forgetUserMemory.ts:52
A user, or an anonymous session.
wiki
wiki:
object
Defined in: packages/agentos/src/cognition/memory/io/forgetUserMemory.ts:50
The page store of one subject, by its conversation key.
storeFor()
storeFor(
scopeId):SubjectPages
Parameters
scopeId
string
Returns
writeTombstone?
optionalwriteTombstone:boolean
Defined in: packages/agentos/src/cognition/memory/io/forgetUserMemory.ts:63
False when a tombstone that is already written is being applied again, at open or on demand. Default true.