AS AgentScopeAPI 手册 / API Reference

CompositeFilesystem

public class CompositeFilesystem implements AbstractFilesystem
源码Source io/agentscope/harness/agent/filesystem/CompositeFilesystem.java:64–526

Composite 文件系统,承载智能体的部署、调度与服务化运行。位于 io.agentscope.harness.agent.filesystem 包,实现 AbstractFilesystem。核心成员包括 filesystemFor、ls、read、write、edit、grep。

Routes file operations to different AbstractFilesystem stores by path prefix.

Paths are matched against route prefixes (longest first). Unmatched paths fall through to the default store.

Composite deliberately implements only AbstractFilesystem — it is the unified, non-sandbox view that blends a local workspace with remote-store-backed paths. Shell execution is intentionally not supported in this mode: routing shell commands across stores is ambiguous, and the primary use case (distributed memory with per-user/session isolation) does not need it. If you need shell execution, use a sandbox-backed filesystem (AbstractSandboxFilesystem) or LocalFilesystemWithShell directly instead.

Example:

`CompositeFilesystem fs = new CompositeFilesystem(
localFs,
Map.of("/memories/", storeFs, "/cache/", inMemoryFs)
);
fs.read(RuntimeContext.empty(), "/memories/notes.md", 0, 100); // → storeFs.read(...)
fs.read(RuntimeContext.empty(), "/src/Main.java", 0, 100); // → localFs.read(...)
`

构造器摘要Constructor Summary

构造器Constructor说明Description
public CompositeFilesystem(AbstractFilesystem defaultBackend, Map<String, AbstractFilesystem> routes)
初始化 `CompositeFilesystem` 实例。
Creates a composite filesystem with a default backend and prefix-based routes.

方法摘要Method Summary

方法Method说明Description
public AbstractFilesystem filesystemFor(String path)
设置文件系统用于。
Returns the backend filesystem that would serve `path`: the longest matching prefix route, or the default backend when no route matches.
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.
public AbstractFilesystem getDefaultBackend()
返回默认存储。
Returns the default store.

构造器详情Constructor Detail

CompositeFilesystem

public CompositeFilesystem(AbstractFilesystem defaultBackend, Map<String, AbstractFilesystem> routes)

初始化 CompositeFilesystem 实例。

Creates a composite filesystem with a default backend and prefix-based routes.

参数Parameters
名称Name类型Type说明Description
defaultBackendAbstractFilesystem默认 Backend(类型 `AbstractFilesystem`)。backend for paths that don't match any route
routesMap<String, AbstractFilesystem>路由(类型 `Map`)。map of path prefixes to stores; prefixes must start with `"/"` and should end with `"/"` (e.g. `"/memories/"`)
源码Source io/agentscope/harness/agent/filesystem/CompositeFilesystem.java:76–91

方法详情Method Detail

filesystemFor

public AbstractFilesystem filesystemFor(String path)

设置文件系统用于。

Returns the backend filesystem that would serve path: the longest matching prefix route, or the default backend when no route matches.

参数Parameters
名称Name类型Type说明Description
pathString路径(类型 `String`)。The path.
返回Returns AbstractFilesystem
返回AbstractFilesystem。Returns abstract filesystem.
源码Source io/agentscope/harness/agent/filesystem/CompositeFilesystem.java:104–106

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/harness/agent/filesystem/CompositeFilesystem.java:183–221

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/harness/agent/filesystem/CompositeFilesystem.java:223–227

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/harness/agent/filesystem/CompositeFilesystem.java:229–237

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/harness/agent/filesystem/CompositeFilesystem.java:239–259

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/harness/agent/filesystem/CompositeFilesystem.java:261–323

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/harness/agent/filesystem/CompositeFilesystem.java:325–395

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/harness/agent/filesystem/CompositeFilesystem.java:397–429

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/harness/agent/filesystem/CompositeFilesystem.java:431–461

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/harness/agent/filesystem/CompositeFilesystem.java:463–472

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/harness/agent/filesystem/CompositeFilesystem.java:474–508

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/harness/agent/filesystem/CompositeFilesystem.java:510–517

getDefaultBackend

public AbstractFilesystem getDefaultBackend()

返回默认存储。

Returns the default store.

返回Returns AbstractFilesystem
返回AbstractFilesystem。Returns abstract filesystem.
源码Source io/agentscope/harness/agent/filesystem/CompositeFilesystem.java:520–522

继承成员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.