AS AgentScopeAPI 手册 / API Reference

FsFileEditor

public class FsFileEditor extends BaseSandboxAwareTool<EditFileTool, FsFileEditor.EditFileToolRequest, FsFileEditor.EditFileToolResponse>
源码Source io/agentscope/runtime/engine/agents/saa/tools/fs/FsFileEditor.java:49–122

Fs 文件 Editor,让智能体以受控方式调用外部能力。位于 io.agentscope.runtime.engine.agents.saa.tools.fs 包,继承自 BaseSandboxAwareTool<EditFileTool, FsFileEditor.EditFileToolRequest, FsFileEditor.EditFileToolResponse>。核心成员包括 apply、buildTool、FsFileEditor。

A class in io.agentscope.runtime.engine.agents.saa.tools.fs that lets agents invoke external capabilities under control. Declared in io.agentscope.runtime.engine.agents.saa.tools.fs. Extends BaseSandboxAwareTool.

嵌套类摘要Nested Class Summary

类Class类型Kind说明Description
EditFileToolRequest记录record
承载 Edit 文件工具请求数据的记录类型。
A record in io.agentscope.runtime.engine.agents.saa.tools.fs that carries data used when components lets agents invoke external capabilities under control.
EditFileToolResponse记录record
承载 Edit 文件工具响应数据的记录类型。
A record in io.agentscope.runtime.engine.agents.saa.tools.fs that carries data used when components lets agents invoke external capabilities under control.
Response记录record
承载响应数据的记录类型。
A record in io.agentscope.runtime.engine.agents.saa.tools.fs that carries data used when components lets agents invoke external capabilities under control.

构造器摘要Constructor Summary

构造器Constructor说明Description
public FsFileEditor()
初始化 `FsFileEditor` 实例。
Creates a new instance.

方法摘要Method Summary

方法Method说明Description
public EditFileToolResponse apply(EditFileToolRequest request, ToolContext toolContext)
执行 `apply` 方法。
Performs the apply operation.
public RuntimeFunctionToolCallback buildTool()
构建工具。
Builds the tool.

构造器详情Constructor Detail

FsFileEditor

public FsFileEditor()

初始化 FsFileEditor 实例。

Creates a new instance.

源码Source io/agentscope/runtime/engine/agents/saa/tools/fs/FsFileEditor.java:52–54

方法详情Method Detail

apply

public EditFileToolResponse apply(EditFileToolRequest request, ToolContext toolContext)

执行 apply 方法。

Performs the apply operation.

参数Parameters
名称Name类型Type说明Description
requestEditFileToolRequest请求(类型 `EditFileToolRequest`)。The request.
toolContextToolContext工具上下文(类型 `ToolContext`)。The tool context.
返回Returns EditFileToolResponse
返回EditFileToolResponse。Returns edit file tool response.
源码Source io/agentscope/runtime/engine/agents/saa/tools/fs/FsFileEditor.java:56–60

buildTool

public RuntimeFunctionToolCallback buildTool()

构建工具。

Builds the tool.

返回Returns RuntimeFunctionToolCallback
返回RuntimeFunctionToolCallback。Returns runtime function tool callback.
源码Source io/agentscope/runtime/engine/agents/saa/tools/fs/FsFileEditor.java:102–121

嵌套类详情Nested Class Detail

EditFileToolRequest

public record EditFileToolRequest( @JsonProperty(required = true, value = "path") @JsonPropertyDescription("Path to the file to edit") String path, @JsonProperty(required = true, value = "edits") @JsonPropertyDescription("Array of edit objects with oldText and newText properties") Map<String, Object>[] edits )

承载 Edit 文件工具请求数据的记录类型。位于 io.agentscope.runtime.engine.agents.saa.tools.fs 包。核心成员包括 path、edits、EditFileToolRequest。

A record in io.agentscope.runtime.engine.agents.saa.tools.fs that carries data used when components lets agents invoke external capabilities under control. Declared in io.agentscope.runtime.engine.agents.saa.tools.fs.

EditFileToolResponse

public record EditFileToolResponse(@JsonProperty("Response") Response output)

承载 Edit 文件工具响应数据的记录类型。位于 io.agentscope.runtime.engine.agents.saa.tools.fs 包。核心成员包括 output、EditFileToolResponse。

A record in io.agentscope.runtime.engine.agents.saa.tools.fs that carries data used when components lets agents invoke external capabilities under control. Declared in io.agentscope.runtime.engine.agents.saa.tools.fs.

Response

@JsonClassDescription("The result contains filesystem tool output and execution message") public record Response(String result, String message)

承载响应数据的记录类型。位于 io.agentscope.runtime.engine.agents.saa.tools.fs 包。核心成员包括 result、message、Response。

A record in io.agentscope.runtime.engine.agents.saa.tools.fs that carries data used when components lets agents invoke external capabilities under control. Declared in io.agentscope.runtime.engine.agents.saa.tools.fs.

基于官方固定版本源码静态生成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.