Interface ICognitiveMemoryManager

interface ICognitiveMemoryManager {
    initialize(config): Promise<void>;
    encode(input, mood, gmiMood, options?): Promise<MemoryTrace>;
    retrieve(query, mood, options?): Promise<CognitiveRetrievalResult>;
    assembleForPrompt(query, tokenBudget, mood, options?): Promise<AssembledMemoryContext>;
    observe?(role, content, mood?): Promise<null | ObservationNote[]>;
    checkProspective?(context): Promise<ProspectiveMemoryItem[]>;
    registerProspective?(input): Promise<ProspectiveMemoryItem>;
    listProspective?(): Promise<ProspectiveMemoryItem[]>;
    removeProspective?(id): Promise<boolean>;
    runConsolidation?(): Promise<ConsolidationResult>;
    getMemoryHealth(): Promise<MemoryHealthReport>;
    getStore(): MemoryStore;
    getWorkingMemory(): CognitiveWorkingMemory;
    getConfig(): CognitiveMemoryConfig;
    getGraph(): null | IMemoryGraph;
    getObserver(): null | MemoryObserver;
    getProspective(): null | ProspectiveMemoryManager;
    setHydeRetriever?(retriever): void;
    getHydeRetriever?(): null | HydeRetriever;
    getContextWindowStats(): null | ContextWindowStats;
    getContextTransparencyReport(): null | string;
    shutdown(): Promise<void>;
}

Implemented by

Methods

initialize encode retrieve assembleForPrompt observe? checkProspective? registerProspective? listProspective? removeProspective? runConsolidation? getMemoryHealth getStore getWorkingMemory getConfig getGraph getObserver getProspective setHydeRetriever? getHydeRetriever? getContextWindowStats getContextTransparencyReport shutdown

Methods

initialize

encode

retrieve

assembleForPrompt

Optional observe

Optional checkProspective

  • checkProspective(context): Promise<ProspectiveMemoryItem[]>

  • Check prospective memory triggers (Batch 2).

    Parameters

    • context: {
          now?: number;
          events?: string[];
          queryText?: string;
          queryEmbedding?: number[];
      }
      • Optional now?: number
      • Optional events?: string[]
      • Optional queryText?: string
      • Optional queryEmbedding?: number[]

    Returns Promise<ProspectiveMemoryItem[]>

Optional registerProspective

Optional listProspective

Optional removeProspective

Optional runConsolidation

getMemoryHealth

getStore

getWorkingMemory

getConfig

getGraph

getObserver

getProspective

Optional setHydeRetriever

Optional getHydeRetriever

getContextWindowStats

getContextTransparencyReport

shutdown

Settings

Member Visibility

Theme

On This Page

initializeencoderetrieveassembleForPromptobservecheckProspectiveregisterProspectivelistProspectiveremoveProspectiverunConsolidationgetMemoryHealthgetStoregetWorkingMemorygetConfiggetGraphgetObservergetProspectivesetHydeRetrievergetHydeRetrievergetContextWindowStatsgetContextTransparencyReportshutdown