@daydreamsai/core

---

@daydreamsai/core / EpisodeHooks

Interface: EpisodeHooks<TContext>

Defined in: packages/core/src/memory/types.ts:438

Episode detection and creation hooks for contexts Allows developers to customize when and how episodes are stored

Type Parameters

TContext

TContext extends AnyContext = AnyContext

Methods

classifyEpisode()?

optional classifyEpisode(episodeData, contextState): string

Defined in: packages/core/src/memory/types.ts:488

Called to classify the type of episode (optional)

Parameters

episodeData

any

The episode data from createEpisode

contextState

ContextState<TContext>

Current context state

Returns

string

Episode type/classification string

---

createEpisode()?

optional createEpisode(logs, contextState, agent): any

Defined in: packages/core/src/memory/types.ts:476

Called to create episode data from collected logs

Parameters

logs

AnyRef[]

Array of logs that make up this episode

contextState

ContextState<TContext>

Current context state

agent

AnyAgent

Agent instance

Returns

any

Episode data to be stored

---

extractMetadata()?

optional extractMetadata(episodeData, logs, contextState): Record<string, any>

Defined in: packages/core/src/memory/types.ts:500

Called to extract additional metadata for the episode (optional)

Parameters

episodeData

any

The episode data from createEpisode

logs

AnyRef[]

The original logs for this episode

contextState

ContextState<TContext>

Current context state

Returns

Record<string, any>

Metadata object

---

shouldEndEpisode()?

optional shouldEndEpisode(ref, workingMemory, contextState, agent): boolean | Promise<boolean>

Defined in: packages/core/src/memory/types.ts:462

Called to determine if the current episode should be ended and stored

Parameters

ref

AnyRef

The current log reference being processed

workingMemory

WorkingMemory

Current working memory state

contextState

ContextState<TContext>

Current context state

agent

AnyAgent

Agent instance

Returns

boolean | Promise<boolean>

true if the current episode should be stored

---

shouldStartEpisode()?

optional shouldStartEpisode(ref, workingMemory, contextState, agent): boolean | Promise<boolean>

Defined in: packages/core/src/memory/types.ts:447

Called to determine if a new episode should be started

Parameters

ref

AnyRef

The current log reference being processed

workingMemory

WorkingMemory

Current working memory state

contextState

ContextState<TContext>

Current context state

agent

AnyAgent

Agent instance

Returns

boolean | Promise<boolean>

true if a new episode should start