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

Package-level declarations

Types

@Serializable(with = AgentCheckpointDataSerializer::class)

Represents the checkpoint data for an agent's state during a session.

object AgentCheckpointDataSerializer : JsonTransformingSerializer<AgentCheckpointData>

Custom serializer for AgentCheckpointData that adds backward compatibility with the pre-refactoring format, where AgentCheckpointData.nodePath, AgentCheckpointData.lastInput, and AgentCheckpointData.lastOutput were top-level fields instead of entries in AgentCheckpointData.properties.

GraphCheckpointProperties

@Serializable

data class GraphCheckpointProperties(val nodePath: String, val lastInput: JSONElement = JSONNull, val lastOutput: JSONElement = JSONNull)

Specialized data for graph-based agents, including execution path and input/output states.

Persistence

class Persistence(persistenceStorageProvider: PersistenceStorageProvider<*>, serializer: JSONSerializer, clock: KoogClock = KoogClock.System)

A feature that provides checkpoint functionality for AI agents.

PersistenceFeatureConfig

class PersistenceFeatureConfig : FeatureConfig

Configuration class for the Snapshot feature.

Persistency

typealias ~~Persistency~~ = Persistence

PersistencyFeatureConfig

typealias ~~PersistencyFeatureConfig~~ = PersistenceFeatureConfig

PlannerCheckpointProperties

@Serializable

data class PlannerCheckpointProperties(val executionPoint: PlannerAgentExecutionPoint, val state: JSONElement, val plan: JSONElement)

Specialized data for planner agents, capturing state, plan, and current execution point.

Reverts

annotation class Reverts

Annotation used to mark a method that serves as a rollback or revert tool for a specified primary tool.

RollbackToolRegistry

class RollbackToolRegistry

A registry for managing and retrieving rollback tools associated with specific tools. This class allows for the association of tools that have rollback counterparts and provides mechanisms for retrieval and addition of such tools.

RollbackToolRegistryBuilder

actual open class RollbackToolRegistryBuilder : RollbackToolRegistryBuilderCommon<RollbackToolRegistryBuilder>

A builder class responsible for creating a RollbackToolRegistry while managing associations between tools and their corresponding rollback tools.

expect open class RollbackToolRegistryBuilder : RollbackToolRegistryBuilderCommon<RollbackToolRegistryBuilder>

A builder class responsible for creating a RollbackToolRegistry while managing associations between tools and their corresponding rollback tools.

actual open class RollbackToolRegistryBuilder : RollbackToolRegistryBuilderCommon<RollbackToolRegistryBuilder>

A builder class responsible for creating a RollbackToolRegistry while managing associations between tools and their corresponding rollback tools.

actual open class RollbackToolRegistryBuilder : RollbackToolRegistryBuilderCommon<RollbackToolRegistryBuilder>

A builder class responsible for creating a RollbackToolRegistry while managing associations between tools and their corresponding rollback tools.

RollbackToolRegistryBuilderCommon

abstract class RollbackToolRegistryBuilderCommon<Self : RollbackToolRegistryBuilderCommon<Self>>

API for RollbackToolRegistryBuilder

RollbackToolSet

interface RollbackToolSet

Represents a set of tools that can perform rollback or reversal operations for a given tool and toolset. This interface provides a mechanism to locate and retrieve tools that revert specific operations.

Functions

add

fun RollbackToolRegistry.add(toolFunction: KFunction<*>, rollbackToolFunction: KFunction<*>)

Adds a tool and its corresponding rollback tool to the registry. This convenience method converts both toolFunction and rollbackToolFunction into Tool objects before adding them.

isTombstone

fun AgentCheckpointData.isTombstone(): Boolean

Checks whether the AgentCheckpointData instance is marked as a tombstone.

persistence

fun AIAgentContext.persistence(): Persistence

Extension function to access the checkpoint feature from an agent context.

fun <Input, Output, TContext : AIAgentContext> AIAgentRunSession<Input, Output, TContext>.persistence(): Persistence

Extension function to access the checkpoint feature from a session.

serializeInput

inline fun <T> serializeInput(input: T?): String?

toAgentContextData

fun AgentCheckpointData.toAgentContextData(rollbackStrategy: RollbackStrategy, additionalRollbackActions: suspend (AIAgentContext) -> Unit = {}): AgentContextData?

Converts an instance of AgentCheckpointData to AgentContextData.

tombstoneCheckpoint

fun tombstoneCheckpoint(createdAt: Instant, version: Long): AgentCheckpointData

Creates a tombstone checkpoint for an agent's session.

withPersistence

suspend fun <T> AIAgentContext.withPersistence(action: suspend Persistence.(AIAgentContext) -> T): T

Executes the provided action within the context of the AI agent's persistence layer.

suspend fun <Input, Output, TContext : AIAgentContext, T> AIAgentRunSession<Input, Output, TContext>.withPersistence(action: suspend Persistence.(AIAgentContext) -> T): T

Executes the provided action within the context of the session's persistence layer if the session is in a running state.