agents-core/ai.koog.agents.core.agent.entity/AIAgentStorageAPI

AIAgentStorageAPI

interface AIAgentStorageAPI(source)

API for AIAgentStorage

Inheritors

AIAgentStorage

Functions

clear

abstract suspend fun clear()

Clears all data from the storage.

copy

abstract suspend fun copy(): AIAgentStorage

Creates a copy of the current storage.

get

abstract suspend fun <T : Any> get(key: AIAgentStorageKey<T>): T?

Retrieves the value associated with the given key from the storage.

getValue

abstract suspend fun <T : Any> getValue(key: AIAgentStorageKey<T>): T

Retrieves the non-null value associated with the given key from the storage. If the key does not exist in the storage, a NoSuchElementException is thrown.

putAll

abstract suspend fun putAll(other: AIAgentStorage)

Puts the contents of the other storage instance into the current storage. This method combines key-value pairs from the specified storage with the current one. If a key exists in both storages, the value from the given storage will overwrite the existing value.

abstract suspend fun putAll(map: Map<AIAgentStorageKey<*>, Any>)

Adds all key-value pairs from the given map to the storage.

putAllSerialized

abstract suspend fun putAllSerialized(map: Map<String, JSONElement>)

Adds serialized storage entries from the given map.

remove

abstract suspend fun <T : Any> remove(key: AIAgentStorageKey<T>): T?

Removes the value associated with the given key from the storage.

set

abstract suspend fun <T : Any> set(key: AIAgentStorageKey<T>, value: T)

Sets the value associated with the given key in the storage.

toSerializedMap

abstract suspend fun toSerializedMap(): Map<String, JSONElement>

Returns serialized storage entries keyed by AIAgentStorageKey.name.