ForgettableMemory
Auto-generated API reference for ForgettableMemory.
Interface: ForgettableMemory
Defined in: memory/src/forget.ts:19
GDPR / LGPD / CCPA data-subject deletion. ADR-0003 deferred retention; this module is the "forget the user" half.
Design: rather than mutate every memory contract (and break the
public API freeze, RFC-0007), we attach forgetSubject as a
capability on a memory instance. Backends that can implement it
declare a subjectFilter (how to recognise records belonging to a
subject) and deleteFn (how to remove them). forgetSubject(memory, subjectId) walks every backend the runtime is configured with and
runs the deletion, returning a per-backend report you can sign into
the audit log (#162).
Closes issue #798.
#Properties
#__agentskitBackend
__agentskitBackend:
string
Defined in: memory/src/forget.ts:24
Backend identifier ('pgvector', 'pinecone', 'sqlite', etc.).
Used for the audit-log entry and for the per-backend report.
#forgetSubject
forgetSubject: (
subjectId) =>Promise<ForgetReport>
Defined in: memory/src/forget.ts:26
Delete every record where metadata.subjectId === subjectId.
#Parameters
subjectId
string
#Returns
Promise<ForgetReport>