AS AgentScopeAPI 手册 / API Reference

MemoryService

public interface MemoryService extends Service
源码Source io/agentscope/runtime/engine/services/memory/service/MemoryService.java:34–80

定义记忆服务契约的接口。位于 io.agentscope.runtime.engine.services.memory.service 包,实现 Service。核心成员包括 addMemory、searchMemory、listMemory、deleteMemory、getAllUsers。

Memory service interface Used for storing and retrieving long-term memories, supports database or in-memory storage Memory is organized by user ID and supports two management strategies: 1. Messages grouped by session ID (session ID under user ID) 2. Messages grouped only by user ID

方法摘要Method Summary

方法Method说明Description
public CompletableFuture<Void> addMemory(String userId, List<Message> messages, Optional<String> sessionId)
添加记忆。
Add messages to memory service
public CompletableFuture<List<Message>> searchMemory(String userId, List<Message> messages, Optional<Map<String, Object>> filters)
搜索记忆。
Search messages from memory service
public CompletableFuture<List<Message>> listMemory(String userId, Optional<Map<String, Object>> filters)
列出记忆。
List memory items for specified user, supports pagination and other filters
public CompletableFuture<Void> deleteMemory(String userId, Optional<String> sessionId)
删除记忆。
Delete memory items for specified user
public CompletableFuture<List<String>> getAllUsers()
获取所有用户列出。
Get all users list

方法详情Method Detail

addMemory

public CompletableFuture<Void> addMemory(String userId, List<Message> messages, Optional<String> sessionId)

添加记忆。

Add messages to memory service

参数Parameters
名称Name类型Type说明Description
userIdString用户标识(类型 `String`)。user ID
messagesList<Message>消息到添加的列出。list of messages to add
sessionIdOptional<String>会话标识(类型 `Optional`)。optional session ID
返回Returns CompletableFuture<Void>
返回CompletableFuture。CompletableFuture asynchronous addition result
源码Source io/agentscope/runtime/engine/services/memory/service/MemoryService.java:44

searchMemory

public CompletableFuture<List<Message>> searchMemory(String userId, List<Message> messages, Optional<Map<String, Object>> filters)

搜索记忆。

Search messages from memory service

参数Parameters
名称Name类型Type说明Description
userIdString用户标识(类型 `String`)。user ID
messagesList<Message>消息列表(类型 `List`)。user query or query with history messages, all in message list format
filtersOptional<Map<String, Object>>filters(类型 `Optional >`)。filters for searching memory
返回Returns CompletableFuture<List<Message>>
返回CompletableFuture>。CompletableFuture asynchronous search result
源码Source io/agentscope/runtime/engine/services/memory/service/MemoryService.java:54

listMemory

public CompletableFuture<List<Message>> listMemory(String userId, Optional<Map<String, Object>> filters)

列出记忆。

List memory items for specified user, supports pagination and other filters

参数Parameters
名称Name类型Type说明Description
userIdString用户标识(类型 `String`)。user ID
filtersOptional<Map<String, Object>>filters(类型 `Optional >`)。filters for memory items, such as page_num, page_size, etc.
返回Returns CompletableFuture<List<Message>>
返回CompletableFuture>。CompletableFuture asynchronous list result
源码Source io/agentscope/runtime/engine/services/memory/service/MemoryService.java:63

deleteMemory

public CompletableFuture<Void> deleteMemory(String userId, Optional<String> sessionId)

删除记忆。

Delete memory items for specified user

参数Parameters
名称Name类型Type说明Description
userIdString用户标识(类型 `String`)。user ID
sessionIdOptional<String>会话标识(类型 `Optional`)。optional session ID, if provided only delete messages for that session, otherwise delete all messages for the user
返回Returns CompletableFuture<Void>
返回CompletableFuture。CompletableFuture asynchronous deletion result
源码Source io/agentscope/runtime/engine/services/memory/service/MemoryService.java:72

getAllUsers

public CompletableFuture<List<String>> getAllUsers()

获取所有用户列出。

Get all users list

返回Returns CompletableFuture<List<String>>
返回CompletableFuture>。CompletableFuture asynchronous user list result
源码Source io/agentscope/runtime/engine/services/memory/service/MemoryService.java:79

继承成员Inherited Members

继承自Methods inherited from Service
基于官方固定版本源码静态生成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.