AS AgentScopeAPI 手册 / API Reference

InMemoryAgentStateStore

public class InMemoryAgentStateStore implements AgentStateStore
源码Source io/agentscope/core/state/InMemoryAgentStateStore.java:46–267

In 记忆智能体状态存储,负责持久化与读取数据。位于 io.agentscope.core.state 包,实现 AgentStateStore。核心成员包括 save、supportsVersioning、getVersioned、saveIfVersion、get、getList。

In-memory implementation of the AgentStateStore interface.

This implementation stores agent state in memory using a ConcurrentHashMap. It is suitable for single-process applications where persistence across restarts is not required.

Slot key: the (userId, sessionId) pair is the storage slot. null userId is mapped to the literal "__anon__" bucket so anonymous sessions don't collide with users actually named "".

Thread Safety: this class is thread-safe.

Limitations:

  • State is lost when the JVM exits

  • Not suitable for distributed environments

  • Memory usage grows with the number of sessions

方法摘要Method Summary

方法Method说明Description
public void save(String userId, String sessionId, String key, State value)
保存数据到持久化存储。
Performs the save operation.
public boolean supportsVersioning()
返回 `supportsVersioning` 结果。
Returns the supports versioning.
public T extends State VersionedState<T> getVersioned(String userId, String sessionId, String key, Class<T> type)
获取 `getVersioned`。
Returns the versioned.
public long saveIfVersion(String userId, String sessionId, String key, State value, long expectedVersion)
保存If 版本。
Saves the if version.
public void save(String userId, String sessionId, String key, List<? extends State> values)
保存数据到持久化存储。
Performs the save operation.
public T extends State Optional<T> get(String userId, String sessionId, String key, Class<T> type)
按条件读取数据。
Performs the get operation.
public T extends State List<T> getList(String userId, String sessionId, String key, Class<T> itemType)
获取列表。
Returns the list.
public boolean exists(String userId, String sessionId)
判断数据是否存在。
Performs the exists operation.
public void delete(String userId, String sessionId)
删除数据。
Performs the delete operation.
public void delete(String userId, String sessionId, String key)
删除数据。
Performs the delete operation.
public Set<String> listSessionIds(String userId)
列出 `listSessionIds`。
Lists the session ids.
public int getSessionCount()
获取会话数量。
Total number of `(userId, sessionId)` slots currently stored.
public void clearAll()
清空所有。
Wipe everything (useful for testing).

方法详情Method Detail

save

public void save(String userId, String sessionId, String key, State value)

保存数据到持久化存储。

Performs the save operation.

参数Parameters
名称Name类型Type说明Description
userIdString用户标识(类型 `String`)。The user id.
sessionIdString会话标识(类型 `String`)。The session id.
keyString键(类型 `String`)。The key.
valueState值(类型 `State`)。The value.
源码Source io/agentscope/core/state/InMemoryAgentStateStore.java:54–58

supportsVersioning

public boolean supportsVersioning()

返回 supportsVersioning 结果。

Returns the supports versioning.

返回Returns boolean
返回布尔值,表示判断结果。Returns a boolean result.
源码Source io/agentscope/core/state/InMemoryAgentStateStore.java:60–63

getVersioned

public T extends State VersionedState<T> getVersioned(String userId, String sessionId, String key, Class<T> type)

获取 getVersioned。

Returns the versioned.

参数Parameters
名称Name类型Type说明Description
userIdString用户标识(类型 `String`)。The user id.
sessionIdString会话标识(类型 `String`)。The session id.
keyString键(类型 `String`)。The key.
typeClass<T>类型(类型 `Class`)。The type.
返回Returns VersionedState<T>
返回VersionedState。Returns versioned state.
源码Source io/agentscope/core/state/InMemoryAgentStateStore.java:65–87

saveIfVersion

public long saveIfVersion(String userId, String sessionId, String key, State value, long expectedVersion)

保存If 版本。

Saves the if version.

参数Parameters
名称Name类型Type说明Description
userIdString用户标识(类型 `String`)。The user id.
sessionIdString会话标识(类型 `String`)。The session id.
keyString键(类型 `String`)。The key.
valueState值(类型 `State`)。The value.
expectedVersionlongexpected 版本(类型 `long`)。The expected version.
返回Returns long
返回数值结果。Returns a numeric result.
源码Source io/agentscope/core/state/InMemoryAgentStateStore.java:89–101

save

public void save(String userId, String sessionId, String key, List<? extends State> values)

保存数据到持久化存储。

Performs the save operation.

参数Parameters
名称Name类型Type说明Description
userIdString用户标识(类型 `String`)。The user id.
sessionIdString会话标识(类型 `String`)。The session id.
keyString键(类型 `String`)。The key.
valuesList<? extends State>值(类型 `List`)。The values.
源码Source io/agentscope/core/state/InMemoryAgentStateStore.java:103–107

get

public T extends State Optional<T> get(String userId, String sessionId, String key, Class<T> type)

按条件读取数据。

Performs the get operation.

参数Parameters
名称Name类型Type说明Description
userIdString用户标识(类型 `String`)。The user id.
sessionIdString会话标识(类型 `String`)。The session id.
keyString键(类型 `String`)。The key.
typeClass<T>类型(类型 `Class`)。The type.
返回Returns Optional<T>
返回可选。Returns optional.
源码Source io/agentscope/core/state/InMemoryAgentStateStore.java:109–130

getList

public T extends State List<T> getList(String userId, String sessionId, String key, Class<T> itemType)

获取列表。

Returns the list.

参数Parameters
名称Name类型Type说明Description
userIdString用户标识(类型 `String`)。The user id.
sessionIdString会话标识(类型 `String`)。The session id.
keyString键(类型 `String`)。The key.
itemTypeClass<T>条目类型(类型 `Class`)。The item type.
返回Returns List<T>
返回列出。Returns list.
源码Source io/agentscope/core/state/InMemoryAgentStateStore.java:132–145

exists

public boolean exists(String userId, String sessionId)

判断数据是否存在。

Performs the exists operation.

参数Parameters
名称Name类型Type说明Description
userIdString用户标识(类型 `String`)。The user id.
sessionIdString会话标识(类型 `String`)。The session id.
返回Returns boolean
返回布尔值,表示判断结果。Returns a boolean result.
源码Source io/agentscope/core/state/InMemoryAgentStateStore.java:147–150

delete

public void delete(String userId, String sessionId)

删除数据。

Performs the delete operation.

参数Parameters
名称Name类型Type说明Description
userIdString用户标识(类型 `String`)。The user id.
sessionIdString会话标识(类型 `String`)。The session id.
源码Source io/agentscope/core/state/InMemoryAgentStateStore.java:152–158

delete

public void delete(String userId, String sessionId, String key)

删除数据。

Performs the delete operation.

参数Parameters
名称Name类型Type说明Description
userIdString用户标识(类型 `String`)。The user id.
sessionIdString会话标识(类型 `String`)。The session id.
keyString键(类型 `String`)。The key.
源码Source io/agentscope/core/state/InMemoryAgentStateStore.java:160–166

listSessionIds

public Set<String> listSessionIds(String userId)

列出 listSessionIds。

Lists the session ids.

参数Parameters
名称Name类型Type说明Description
userIdString用户标识(类型 `String`)。The user id.
返回Returns Set<String>
返回设置。Returns set.
源码Source io/agentscope/core/state/InMemoryAgentStateStore.java:168–175

getSessionCount

public int getSessionCount()

获取会话数量。

Total number of (userId, sessionId) slots currently stored.

返回Returns int
返回数值结果。Returns a numeric result.
源码Source io/agentscope/core/state/InMemoryAgentStateStore.java:178–180

clearAll

public void clearAll()

清空所有。

Wipe everything (useful for testing).

源码Source io/agentscope/core/state/InMemoryAgentStateStore.java:183–185

继承成员Inherited Members

继承自Members inherited from AgentStateStore
基于官方固定版本源码静态生成Generated from pinned official sources · Python 2.0.11 · Java 2.0.4
签名与文档为静态抽取;如有疑问请以源码为准。Signatures and docs are extracted statically; verify against the source when in doubt.