Class NarrativeMemory<T>

Type Parameters

T = Record<string, unknown>

Methods

`Static`create

create<T = Record<string, unknown>>(
opts?: NarrativeMemoryOptions<T>,
): NarrativeMemory<T>
Type Parameters
- T = Record<string, unknown>
Parameters
- opts: NarrativeMemoryOptions<T> = {}
Returns NarrativeMemory<T>
- Defined in runtime/narrative-memory.ts:163

defineKind

defineKind(spec: MemoryKindSpec): boolean
Parameters
- spec: MemoryKindSpec
Returns boolean
- Defined in runtime/narrative-memory.ts:170

hasKind

hasKind(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/narrative-memory.ts:186

kindIds

kindIds(): string[]
Returns string[]
- Defined in runtime/narrative-memory.ts:190

remember

remember(fact: MemoryFact<T>): boolean
Parameters
- fact: MemoryFact<T>
Returns boolean
- Defined in runtime/narrative-memory.ts:203

forget

forget(factId: string): boolean
Parameters
- factId: string
Returns boolean
- Defined in runtime/narrative-memory.ts:236

forgetAbout

forgetAbout(characterId: string, subjectId: string): number
Parameters
- characterId: string
- subjectId: string
Returns number
- Defined in runtime/narrative-memory.ts:248

has

has(factId: string): boolean
Parameters
- factId: string
Returns boolean
- Defined in runtime/narrative-memory.ts:272

get

get(factId: string): MemoryFact<T> | null
Parameters
- factId: string
Returns MemoryFact<T> | null
- Defined in runtime/narrative-memory.ts:276

adjustSalience

adjustSalience(factId: string, delta: number): number | null
Parameters
- factId: string
- delta: number
Returns number | null
- Defined in runtime/narrative-memory.ts:281

factsAbout

factsAbout(characterId: string, subjectId: string): MemoryFact<T>[]
Parameters
- characterId: string
- subjectId: string
Returns MemoryFact<T>[]
- Defined in runtime/narrative-memory.ts:292

factsBy

factsBy(characterId: string): MemoryFact<T>[]
Parameters
- characterId: string
Returns MemoryFact<T>[]
- Defined in runtime/narrative-memory.ts:306

factsAboutSubject

factsAboutSubject(subjectId: string): MemoryFact<T>[]
Parameters
- subjectId: string
Returns MemoryFact<T>[]
- Defined in runtime/narrative-memory.ts:318

recall

recall(
    characterId: string,
    subjectId: string,
    ctx?: RecallContext,
): RecallResult<T>[]
Parameters
- characterId: string
- subjectId: string
- ctx: RecallContext = {}
Returns RecallResult<T>[]
- Defined in runtime/narrative-memory.ts:334

topMemory

topMemory(
    characterId: string,
    subjectId: string,
    ctx?: RecallContext,
): RecallResult<T> | null
Parameters
- characterId: string
- subjectId: string
- ctx: RecallContext = {}
Returns RecallResult<T> | null
- Defined in runtime/narrative-memory.ts:395

size

size(): number
Returns number
- Defined in runtime/narrative-memory.ts:402

list

list(): MemoryFact<T>[]
Returns MemoryFact<T>[]
- Defined in runtime/narrative-memory.ts:404

tick

tick(dtMs: number): void
Parameters
- dtMs: number
Returns void
- Defined in runtime/narrative-memory.ts:417

exportSession

exportSession(characterId?: string): string
Parameters
- OptionalcharacterId: string
Returns string
- Defined in runtime/narrative-memory.ts:453

importSession

importSession(data: string): boolean
Parameters
- data: string
Returns boolean
- Defined in runtime/narrative-memory.ts:477

clear

clear(): void
Returns void
- Defined in runtime/narrative-memory.ts:506

dispose

dispose(): void
Returns void
- Defined in runtime/narrative-memory.ts:522