agents-features-snapshot/ai.koog.agents.snapshot.feature/Persistence

Persistence

class Persistence(persistenceStorageProvider: PersistenceStorageProvider<*>, clock: Clock = Clock.System)(source)

A feature that provides checkpoint functionality for AI agents.

This class allows saving and restoring the state of an agent at specific points during execution. Checkpoints capture the agent's message history, current node, and input data, enabling:

Resuming agent execution from a specific point
Rolling back to previous states
Persisting agent state across sessions

The feature can be configured to automatically create checkpoints after each node execution using the PersistenceFeatureConfig.enableAutomaticPersistence option.

Constructors

Persistence

constructor(persistenceStorageProvider: PersistenceStorageProvider<*>, clock: Clock = Clock.System)

Types

Feature

object Feature : AIAgentGraphFeature<PersistenceFeatureConfig, Persistence>

Companion object implementing agent feature, handling Persistence creation and installation.

Properties

rollbackStrategy

var rollbackStrategy: RollbackStrategy

Determines the strategy to use during rollback operations for the agent's state.

rollbackToolRegistry

var rollbackToolRegistry: RollbackToolRegistry

A registry for managing rollback tools within the persistence system.

Functions

createCheckpoint

suspend fun createCheckpoint(agentContext: AIAgentContext, nodePath: String, lastInput: Any?, lastInputType: KType, version: Long, checkpointId: String? = null): AgentCheckpointData?

Creates a checkpoint of the agent's current state.

createTombstoneCheckpoint

suspend fun createTombstoneCheckpoint(agentId: String, time: Instant, parentId: Long): AgentCheckpointData

Creates and saves a tombstone checkpoint for an agent's session.

getCheckpointById

suspend fun getCheckpointById(agentId: String, checkpointId: String): AgentCheckpointData?

Retrieves a specific checkpoint by ID for the specified agent.

getLatestCheckpoint

suspend fun getLatestCheckpoint(agentId: String): AgentCheckpointData?

Retrieves the latest checkpoint for the specified agent.

rollbackToCheckpoint

suspend fun rollbackToCheckpoint(checkpointId: String, agentContext: AIAgentContext): AgentCheckpointData?

Rolls back an agent's state to a specific checkpoint.

rollbackToLatestCheckpoint

suspend fun rollbackToLatestCheckpoint(agentContext: AIAgentContext): AgentCheckpointData?

Rolls back an agent's state to the latest checkpoint.

saveCheckpoint

suspend fun saveCheckpoint(agentId: String, checkpointData: AgentCheckpointData)

Saves a checkpoint using the configured storage provider.

setExecutionPoint

fun setExecutionPoint(agentContext: AIAgentContext, nodePath: String, messageHistory: List<Message>, input: JsonElement)

Sets the execution point of an agent to a specific state.