AS AgentScopeAPI 手册 / API Reference

RemoteFilesystem

public class RemoteFilesystem implements AbstractFilesystem
源码Source io/agentscope/harness/agent/filesystem/remote/RemoteFilesystem.java:66–737

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

AbstractFilesystem backed by a BaseStore (persistent, cross-thread).

Files are organized via namespaces and persist across threads/sessions. The namespace can be static (fixed at construction time) or dynamic (resolved at every operation via a NamespaceFactory).

Dynamic namespace example:

`RemoteFilesystem fs = new RemoteFilesystem(store,
() -> List.of("sessions", sessionIdSupplier.get(), "filesystem"));
`

构造器摘要Constructor Summary

构造器Constructor说明Description
public RemoteFilesystem(BaseStore store, NamespaceFactory namespaceFactory)
初始化 `RemoteFilesystem` 实例。
Creates a RemoteFilesystem with a `NamespaceFactory` that is called on every operation, allowing the namespace to vary based on runtime context.
public RemoteFilesystem(BaseStore store, List<String> namespace)
初始化 `RemoteFilesystem` 实例。
Creates a RemoteFilesystem with a fixed namespace.
public RemoteFilesystem(BaseStore store)
创建RemoteFilesystem 使用默认"文件系统"命名空间。
Creates a RemoteFilesystem with a default "filesystem" namespace.

方法摘要Method Summary

方法Method说明Description
public RemoteFilesystem withIndex(WorkspaceIndex index)
执行使用索引相关操作。
Attaches a best-effort `WorkspaceIndex` to accelerate list/glob/exists/grep operations.
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 boolean exists(RuntimeContext runtimeContext, String path)
判断数据是否存在。
Performs the exists 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.

构造器详情Constructor Detail

RemoteFilesystem

public RemoteFilesystem(BaseStore store, NamespaceFactory namespaceFactory)

初始化 RemoteFilesystem 实例。

Creates a RemoteFilesystem with a NamespaceFactory that is called on every operation, allowing the namespace to vary based on runtime context.

参数Parameters
名称Name类型Type说明Description
storeBaseStore存储到使用用于持久化。the store to use for persistence
namespaceFactoryNamespaceFactory命名空间工厂(类型 `NamespaceFactory`)。factory that returns the namespace tuple per operation
源码Source io/agentscope/harness/agent/filesystem/remote/RemoteFilesystem.java:85–94

RemoteFilesystem

public RemoteFilesystem(BaseStore store, List<String> namespace)

初始化 RemoteFilesystem 实例。

Creates a RemoteFilesystem with a fixed namespace.

参数Parameters
名称Name类型Type说明Description
storeBaseStore存储到使用用于持久化。the store to use for persistence
namespaceList<String>命名空间(类型 `List`)。the namespace tuple for organizing files
源码Source io/agentscope/harness/agent/filesystem/remote/RemoteFilesystem.java:102–104

RemoteFilesystem

public RemoteFilesystem(BaseStore store)

创建RemoteFilesystem 使用默认"文件系统"命名空间。

Creates a RemoteFilesystem with a default "filesystem" namespace.

参数Parameters
名称Name类型Type说明Description
storeBaseStore存储到使用用于持久化。the store to use for persistence
源码Source io/agentscope/harness/agent/filesystem/remote/RemoteFilesystem.java:111–113

方法详情Method Detail

withIndex

public RemoteFilesystem withIndex(WorkspaceIndex index)

执行使用索引相关操作。

Attaches a best-effort WorkspaceIndex to accelerate list/glob/exists/grep operations.

参数Parameters
名称Name类型Type说明Description
indexWorkspaceIndex索引(类型 `WorkspaceIndex`)。workspace index; `null` disables index-backed fast paths
返回Returns RemoteFilesystem
返回RemoteFilesystem。this instance (fluent)
源码Source io/agentscope/harness/agent/filesystem/remote/RemoteFilesystem.java:135–138

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/remote/RemoteFilesystem.java:156–215

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/remote/RemoteFilesystem.java:217–261

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/remote/RemoteFilesystem.java:263–277

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/remote/RemoteFilesystem.java:282–330

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/remote/RemoteFilesystem.java:332–417

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/remote/RemoteFilesystem.java:419–495

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/remote/RemoteFilesystem.java:497–531

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/remote/RemoteFilesystem.java:533–560

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/remote/RemoteFilesystem.java:562–592

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/remote/RemoteFilesystem.java:595–611

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/remote/RemoteFilesystem.java:613–638

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