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

AgentCheckpointData

@Serializable(with = AgentCheckpointDataSerializer::class)

data class AgentCheckpointData(source)

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

Constructors

AgentCheckpointData

constructor(checkpointId: String, createdAt: Instant, messageHistory: List<Message>, llmParams: LLMParams? = null, version: Long, graphProperties: GraphCheckpointProperties, properties: JSONObject? = null, llmModel: LLModel? = null, tools: List<String>? = null, storage: JSONObject? = null, agentIterations: Int = 0)

Creates an instance of AgentCheckpointData with graph properties.

constructor(checkpointId: String, createdAt: Instant, messageHistory: List<Message>, llmParams: LLMParams? = null, version: Long, plannerProperties: PlannerCheckpointProperties, properties: JSONObject? = null, llmModel: LLModel? = null, tools: List<String>? = null, storage: JSONObject? = null, agentIterations: Int = 0)

Creates an instance of AgentCheckpointData with planner properties.

Properties

agentIterations

val agentIterations: Int

val checkpointId: String

The unique identifier of the checkpoint. This allows tracking and restoring the agent's session to a specific state.

val createdAt: Instant

The timestamp when the checkpoint was created.

graphProperties

val graphProperties: GraphCheckpointProperties?

val llmModel: LLModel?

val llmParams: LLMParams?

val messageHistory: List<Message>

A list of messages exchanged in the session up to the checkpoint. Messages include interactions between the user, system, assistant, and tools.

plannerProperties

val plannerProperties: PlannerCheckpointProperties?

val properties: JSONObject?

Additional data associated with the checkpoint. This can be used to store additional information about the agent's state.

val storage: JSONObject?

Serialized ai.koog.agents.core.agent.entity.AIAgentStorage

val tools: List<String>?

val version: Long

The version of the checkpoint data structure

Functions

fun AgentCheckpointData.isTombstone(): Boolean

Checks whether the AgentCheckpointData instance is marked as a tombstone.

toAgentContextData

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

Converts an instance of AgentCheckpointData to AgentContextData.