Package akka.javasdk.agent

Interface MemoryProvider

All Known Implementing Classes:

MemoryProvider.CustomMemoryProvider, MemoryProvider.Disabled, MemoryProvider.FromConfig, MemoryProvider.InterceptedMemoryProvider, MemoryProvider.LimitedWindowMemoryProvider

public sealed interface MemoryProvider
permits MemoryProvider.FromConfig, MemoryProvider.Disabled, MemoryProvider.LimitedWindowMemoryProvider, MemoryProvider.CustomMemoryProvider, MemoryProvider.InterceptedMemoryProvider

Interface for configuring memory management in agent systems.

MemoryProvider defines how session history is stored and retrieved during agent interactions. It offers several implementation strategies:

• Configuration-based memory management via MemoryProvider.FromConfig
• Disabled memory (no history) via MemoryProvider.Disabled
• Limited window memory management via MemoryProvider.LimitedWindowMemoryProvider
• Custom memory implementation via MemoryProvider.CustomMemoryProvider
• Interceptor-wrapped memory via MemoryProvider.InterceptedMemoryProvider

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	MemoryProvider.CustomMemoryProvider	Memory provider that uses a custom SessionMemory implementation.
static final record	MemoryProvider.Disabled	Disabled memory provider, which does not store or retrieve contextual history.
static final record	MemoryProvider.FromConfig	Configuration-based memory provider that reads settings from the specified path.
static final class	MemoryProvider.InterceptedMemoryProvider	Memory provider that wraps another MemoryProvider with a SessionMemoryInterceptor.
static final record	MemoryProvider.LimitedWindowMemoryProvider	Memory provider that limits session history based on size or message count.

Method Summary

Modifier and Type	Method	Description
static MemoryProvider.CustomMemoryProvider	custom(SessionMemory sessionMemory)	Creates a custom memory provider using the specified SessionMemory implementation.
static MemoryProvider	fromConfig()	Creates a configuration-based memory provider based on configuration defaults.
static MemoryProvider	fromConfig(String configPath)	Creates a memory provider based on configuration settings.
static MemoryProvider.LimitedWindowMemoryProvider	limitedWindow()	Creates a limited window memory provider with default settings.
static MemoryProvider.Disabled	none()	Disabled memory provider, which does not store or retrieve contextual history.
default MemoryProvider	withInterceptor(SessionMemoryInterceptor interceptor)	Wraps this provider with a SessionMemoryInterceptor that intercepts addInteraction calls.

Method Details

fromConfig

static MemoryProvider fromConfig()

Creates a configuration-based memory provider based on configuration defaults.

Returns:

A configuration-based memory provider

fromConfig

static MemoryProvider fromConfig(String configPath)

Creates a memory provider based on configuration settings.

Parameters:

configPath - Path to the configuration. If empty, uses the default path "akka.javasdk.agent.memory"

Returns:

A configuration-based memory provider

withInterceptor

default MemoryProvider withInterceptor(SessionMemoryInterceptor interceptor)

Wraps this provider with a SessionMemoryInterceptor that intercepts addInteraction calls. The underlying read/write behavior of this provider is preserved on the delegate exposed to the interceptor.

Calling withInterceptor on a provider that already has an interceptor replaces the existing interceptor; interceptors are not chained.

Parameters:

interceptor - The interceptor to apply

Returns:

A memory provider that invokes the interceptor on writes

none

static MemoryProvider.Disabled none()

Disabled memory provider, which does not store or retrieve contextual history.

Returns:

A memory provider without memory.

limitedWindow

static MemoryProvider.LimitedWindowMemoryProvider limitedWindow()

Creates a limited window memory provider with default settings.

The default settings are:

• Include all session history in each interaction with the model
• Record all interactions into memory

Returns:

A new limited window memory provider with default settings

custom

static MemoryProvider.CustomMemoryProvider custom(SessionMemory sessionMemory)

Creates a custom memory provider using the specified SessionMemory implementation.

This allows for complete customization of memory management behavior.

Parameters:

sessionMemory - The custom SessionMemory implementation

Returns:

A new custom memory provider