AS AgentScopeAPI 手册 / API Reference

MemoryStoreFilesystem

public final class MemoryStoreFilesystem implements AbstractFilesystem
源码Source io/agentscope/builder/web/managed/MemoryStoreFilesystem.java:55–421

记忆存储文件系统,承载智能体的部署、调度与服务化运行。位于 io.agentscope.builder.web.managed 包,实现 AbstractFilesystem。核心成员包括 storeId、storeName、accessMode、isReadOnly、routePrefix、ls。

AbstractFilesystem view over a single MemoryStoreService store, mounted under memory-stores/{storeName}/ via io.agentscope.harness.agent.HarnessAgent.Builder#filesystemRoute.

Paths are relative to the store root (e.g. notes.md or /notes.md both address the same memory document). Writes/edits create a new versioned MemoryVersionEntity via MemoryStoreService#putMemory; reads/listing go against the live JPA-backed documents.

This is a pragmatic, flat-namespace implementation: the store has no real subdirectories, so ls/grep/glob operate over the full set of memory paths rather than honoring hierarchical directory semantics. Upload/download of binary content is not supported — memory documents are plain-text only.

构造器摘要Constructor Summary

构造器Constructor说明Description
public MemoryStoreFilesystem(MemoryStoreService memoryStoreService, String ownerId, String storeId, String storeName)
初始化 `MemoryStoreFilesystem` 实例。
Creates a new instance.
public MemoryStoreFilesystem(MemoryStoreService memoryStoreService, String ownerId, String storeId, String storeName, String accessMode)
初始化 `MemoryStoreFilesystem` 实例。
Creates a new instance.
public MemoryStoreFilesystem(MemoryDocumentStore documents, String ownerId, String storeId, String storeName, String accessMode)
初始化 `MemoryStoreFilesystem` 实例。
Creates a new instance.

方法摘要Method Summary

方法Method说明Description
public String storeId()
返回存储标识。
Returns the store id.
public String storeName()
返回存储名称。
Returns the store name.
public String accessMode()
返回访问模式。
Returns the access mode.
public boolean isReadOnly()
判断是否 `isReadOnly`。
Returns whether the read only.
public static String routePrefix(String storeName)
static
设置该参数。
Route prefix under which a memory store filesystem should be mounted.
public LsResult ls(RuntimeContext runtimeContext, String path)
执行 `ls` 方法。
Performs the ls operation.
public ReadResult read(RuntimeContext runtimeContext, String filePath, int offset, int limit)
执行读取相关操作。
Performs the read operation.
public WriteResult write(RuntimeContext runtimeContext, String filePath, String content)
执行写入相关操作。
Performs the write operation.
public EditResult edit(RuntimeContext runtimeContext, String filePath, String oldString, String newString, boolean replaceAll)
执行 `edit` 方法。
Performs the edit operation.
public GrepResult grep(RuntimeContext runtimeContext, String pattern, String path, String glob)
执行 `grep` 方法。
Performs the grep operation.
public GlobResult glob(RuntimeContext runtimeContext, String pattern, String path)
执行 `glob` 方法。
Performs the glob operation.
public List<FileUploadResponse> uploadFiles(RuntimeContext runtimeContext, List<Map.Entry<String, byte[]>> files)
执行上传文件相关操作。
Performs the upload files operation.
public List<FileDownloadResponse> downloadFiles(RuntimeContext runtimeContext, List<String> paths)
执行下载文件相关操作。
Performs the download files operation.
public WriteResult delete(RuntimeContext runtimeContext, String path)
删除数据。
Performs the delete operation.
public WriteResult move(RuntimeContext runtimeContext, String fromPath, String toPath)
执行 `move` 方法。
Performs the move operation.
public boolean exists(RuntimeContext runtimeContext, String path)
判断数据是否存在。
Performs the exists operation.

构造器详情Constructor Detail

MemoryStoreFilesystem

public MemoryStoreFilesystem(MemoryStoreService memoryStoreService, String ownerId, String storeId, String storeName)

初始化 MemoryStoreFilesystem 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
memoryStoreServiceMemoryStoreService记忆存储服务(类型 `MemoryStoreService`)。The memory store service.
ownerIdString所有者标识(类型 `String`)。The owner id.
storeIdString存储标识(类型 `String`)。The store id.
storeNameString存储名称(类型 `String`)。The store name.
源码Source io/agentscope/builder/web/managed/MemoryStoreFilesystem.java:62–68

MemoryStoreFilesystem

public MemoryStoreFilesystem(MemoryStoreService memoryStoreService, String ownerId, String storeId, String storeName, String accessMode)

初始化 MemoryStoreFilesystem 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
memoryStoreServiceMemoryStoreService记忆存储服务(类型 `MemoryStoreService`)。The memory store service.
ownerIdString所有者标识(类型 `String`)。The owner id.
storeIdString存储标识(类型 `String`)。The store id.
storeNameString存储名称(类型 `String`)。The store name.
accessModeString访问模式(类型 `String`)。The access mode.
源码Source io/agentscope/builder/web/managed/MemoryStoreFilesystem.java:70–102

MemoryStoreFilesystem

public MemoryStoreFilesystem(MemoryDocumentStore documents, String ownerId, String storeId, String storeName, String accessMode)

初始化 MemoryStoreFilesystem 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
documentsMemoryDocumentStore文档列表(类型 `MemoryDocumentStore`)。The documents.
ownerIdString所有者标识(类型 `String`)。The owner id.
storeIdString存储标识(类型 `String`)。The store id.
storeNameString存储名称(类型 `String`)。The store name.
accessModeString访问模式(类型 `String`)。The access mode.
源码Source io/agentscope/builder/web/managed/MemoryStoreFilesystem.java:104–118

方法详情Method Detail

storeId

public String storeId()

返回存储标识。

Returns the store id.

返回Returns String
返回字符串结果。Returns a string.
源码Source io/agentscope/builder/web/managed/MemoryStoreFilesystem.java:122–124

storeName

public String storeName()

返回存储名称。

Returns the store name.

返回Returns String
返回字符串结果。Returns a string.
源码Source io/agentscope/builder/web/managed/MemoryStoreFilesystem.java:126–128

accessMode

public String accessMode()

返回访问模式。

Returns the access mode.

返回Returns String
返回字符串结果。Returns a string.
源码Source io/agentscope/builder/web/managed/MemoryStoreFilesystem.java:130–132

isReadOnly

public boolean isReadOnly()

判断是否 isReadOnly。

Returns whether the read only.

返回Returns boolean
返回布尔值,表示判断结果。Returns a boolean result.
源码Source io/agentscope/builder/web/managed/MemoryStoreFilesystem.java:134–136

routePrefix

public static String routePrefix(String storeName)
static

设置该参数。

Route prefix under which a memory store filesystem should be mounted.

参数Parameters
名称Name类型Type说明Description
storeNameString存储名称(类型 `String`)。The store name.
返回Returns String
返回字符串结果。Returns a string.
源码Source io/agentscope/builder/web/managed/MemoryStoreFilesystem.java:139–141

ls

public LsResult ls(RuntimeContext runtimeContext, String path)

执行 ls 方法。

Performs the ls operation.

参数Parameters
名称Name类型Type说明Description
runtimeContextRuntimeContext运行时上下文(类型 `RuntimeContext`)。The runtime context.
pathString路径(类型 `String`)。The path.
返回Returns LsResult
返回LsResult。Returns ls result.
源码Source io/agentscope/builder/web/managed/MemoryStoreFilesystem.java:161–172

read

public ReadResult read(RuntimeContext runtimeContext, String filePath, int offset, int limit)

执行读取相关操作。

Performs the read operation.

参数Parameters
名称Name类型Type说明Description
runtimeContextRuntimeContext运行时上下文(类型 `RuntimeContext`)。The runtime context.
filePathString文件路径(类型 `String`)。The file path.
offsetint偏移量(类型 `int`)。The offset.
limitint数量上限(类型 `int`)。The limit.
返回Returns ReadResult
返回ReadResult。Returns read result.
源码Source io/agentscope/builder/web/managed/MemoryStoreFilesystem.java:174–195

write

public WriteResult write(RuntimeContext runtimeContext, String filePath, String content)

执行写入相关操作。

Performs the write operation.

参数Parameters
名称Name类型Type说明Description
runtimeContextRuntimeContext运行时上下文(类型 `RuntimeContext`)。The runtime context.
filePathString文件路径(类型 `String`)。The file path.
contentString内容(类型 `String`)。The content.
返回Returns WriteResult
返回WriteResult。Returns write result.
源码Source io/agentscope/builder/web/managed/MemoryStoreFilesystem.java:207–230

edit

public EditResult edit(RuntimeContext runtimeContext, String filePath, String oldString, String newString, boolean replaceAll)

执行 edit 方法。

Performs the edit operation.

参数Parameters
名称Name类型Type说明Description
runtimeContextRuntimeContext运行时上下文(类型 `RuntimeContext`)。The runtime context.
filePathString文件路径(类型 `String`)。The file path.
oldStringString旧的 String(类型 `String`)。The old string.
newStringString新建 String(类型 `String`)。The new string.
replaceAllbooleanreplace 所有(类型 `boolean`)。The replace all.
返回Returns EditResult
返回EditResult。Returns edit result.
源码Source io/agentscope/builder/web/managed/MemoryStoreFilesystem.java:232–273

grep

public GrepResult grep(RuntimeContext runtimeContext, String pattern, String path, String glob)

执行 grep 方法。

Performs the grep operation.

参数Parameters
名称Name类型Type说明Description
runtimeContextRuntimeContext运行时上下文(类型 `RuntimeContext`)。The runtime context.
patternStringpattern(类型 `String`)。The pattern.
pathString路径(类型 `String`)。The path.
globStringglob(类型 `String`)。The glob.
返回Returns GrepResult
返回GrepResult。Returns grep result.
源码Source io/agentscope/builder/web/managed/MemoryStoreFilesystem.java:288–310

glob

public GlobResult glob(RuntimeContext runtimeContext, String pattern, String path)

执行 glob 方法。

Performs the glob operation.

参数Parameters
名称Name类型Type说明Description
runtimeContextRuntimeContext运行时上下文(类型 `RuntimeContext`)。The runtime context.
patternStringpattern(类型 `String`)。The pattern.
pathString路径(类型 `String`)。The path.
返回Returns GlobResult
返回GlobResult。Returns glob result.
源码Source io/agentscope/builder/web/managed/MemoryStoreFilesystem.java:312–326

uploadFiles

public List<FileUploadResponse> uploadFiles(RuntimeContext runtimeContext, List<Map.Entry<String, byte[]>> files)

执行上传文件相关操作。

Performs the upload files operation.

参数Parameters
名称Name类型Type说明Description
runtimeContextRuntimeContext运行时上下文(类型 `RuntimeContext`)。The runtime context.
filesList<Map.Entry<String, byte[]>>文件(类型 `List >`)。The files.
返回Returns List<FileUploadResponse>
返回列出。Returns list.
源码Source io/agentscope/builder/web/managed/MemoryStoreFilesystem.java:340–351

downloadFiles

public List<FileDownloadResponse> downloadFiles(RuntimeContext runtimeContext, List<String> paths)

执行下载文件相关操作。

Performs the download files operation.

参数Parameters
名称Name类型Type说明Description
runtimeContextRuntimeContext运行时上下文(类型 `RuntimeContext`)。The runtime context.
pathsList<String>paths(类型 `List`)。The paths.
返回Returns List<FileDownloadResponse>
返回列出。Returns list.
源码Source io/agentscope/builder/web/managed/MemoryStoreFilesystem.java:353–363

delete

public WriteResult delete(RuntimeContext runtimeContext, String path)

删除数据。

Performs the delete operation.

参数Parameters
名称Name类型Type说明Description
runtimeContextRuntimeContext运行时上下文(类型 `RuntimeContext`)。The runtime context.
pathString路径(类型 `String`)。The path.
返回Returns WriteResult
返回WriteResult。Returns write result.
源码Source io/agentscope/builder/web/managed/MemoryStoreFilesystem.java:365–381

move

public WriteResult move(RuntimeContext runtimeContext, String fromPath, String toPath)

执行 move 方法。

Performs the move operation.

参数Parameters
名称Name类型Type说明Description
runtimeContextRuntimeContext运行时上下文(类型 `RuntimeContext`)。The runtime context.
fromPathString来自路径(类型 `String`)。The from path.
toPathString到路径(类型 `String`)。The to path.
返回Returns WriteResult
返回WriteResult。Returns write result.
源码Source io/agentscope/builder/web/managed/MemoryStoreFilesystem.java:383–400

exists

public boolean exists(RuntimeContext runtimeContext, String path)

判断数据是否存在。

Performs the exists operation.

参数Parameters
名称Name类型Type说明Description
runtimeContextRuntimeContext运行时上下文(类型 `RuntimeContext`)。The runtime context.
pathString路径(类型 `String`)。The path.
返回Returns boolean
返回布尔值,表示判断结果。Returns a boolean result.
源码Source io/agentscope/builder/web/managed/MemoryStoreFilesystem.java:402–406

继承成员Inherited Members

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