Class SettingsMemoryScope

Abstract base class for all memory scopes.

Hierarchy (View Summary)

MemoryScope
- SettingsMemoryScope

Index

Constructors

Properties

includeInSnapshot name

Methods

delete getMemory load saveChanges setMemory loadSettings

Constructors

constructor

new SettingsMemoryScope(
initialSettings?: Record<string, unknown>,
): SettingsMemoryScope
Initializes a new instance of the SettingsMemoryScope class.
Parameters
- OptionalinitialSettings: Record<string, unknown>
  initial set of settings to supply
Returns SettingsMemoryScope
Overrides MemoryScope.constructor
- Defined in packages/agents-hosting-dialogs/src/memory/scopes/settingsMemoryScope.ts:41

Properties

`Readonly`includeInSnapshot

includeInSnapshot: boolean

`Readonly`name

name: string

Methods

delete

delete(_dialogContext: DialogContext): Promise<void>
Deletes the backing memory for a scope.
Parameters
- _dialogContext: DialogContext
  Current dialog context.
Returns Promise<void>
Inherited from MemoryScope.delete
- Defined in packages/agents-hosting-dialogs/src/memory/scopes/memoryScope.ts:74

getMemory

getMemory(dialogContext: DialogContext): Record<string, unknown>
Gets the backing memory for this scope.
Parameters
- dialogContext: DialogContext
  The DialogContext object for this turn.
Returns Record<string, unknown>
The memory for the scope.
Overrides MemoryScope.getMemory
- Defined in packages/agents-hosting-dialogs/src/memory/scopes/settingsMemoryScope.ts:51

load

load(dialogContext: DialogContext): Promise<void>
Loads a scopes backing memory at the start of a turn.
Parameters
- dialogContext: DialogContext
  Current dialog context.
Returns Promise<void>
Overrides MemoryScope.load
- Defined in packages/agents-hosting-dialogs/src/memory/scopes/settingsMemoryScope.ts:72

saveChanges

saveChanges(_dialogContext: DialogContext): Promise<void>
Saves a scopes backing memory at the end of a turn.
Parameters
- _dialogContext: DialogContext
  Current dialog context.
Returns Promise<void>
Inherited from MemoryScope.saveChanges
- Defined in packages/agents-hosting-dialogs/src/memory/scopes/memoryScope.ts:65

setMemory

setMemory(_dialogContext: DialogContext, _memory: object): void
Changes the backing object for the memory scope.
Parameters
- _dialogContext: DialogContext
  Current dialog context
- _memory: object
  memory to assign
Returns void
Inherited from MemoryScope.setMemory
- Defined in packages/agents-hosting-dialogs/src/memory/scopes/memoryScope.ts:42

`Protected` `Static`loadSettings

loadSettings(configuration: Record<string, string>): Record<string, unknown>
Build a dictionary view of configuration providers.
Parameters
- configuration: Record<string, string>
  The configuration that we are running with.
Returns Record<string, unknown>
Projected dictionary for settings.
- Defined in packages/agents-hosting-dialogs/src/memory/scopes/settingsMemoryScope.ts:88