AS AgentScopeAPI 手册 / API Reference

SandboxTool

public abstract class SandboxTool extends Tool
源码Source io/agentscope/runtime/sandbox/tools/SandboxTool.java:24–69

沙箱工具,封装可被智能体调用的能力。位于 io.agentscope.runtime.sandbox.tools 包,继承自 Tool。核心成员包括 getSandboxService、setSandboxService、getSandbox、setSandbox、getSchema、setSchema。

A class in io.agentscope.runtime.sandbox.tools that lets agents invoke external capabilities under control. Declared in io.agentscope.runtime.sandbox.tools. Extends Tool.

字段摘要Field Summary

字段Field类型Type说明Description
sandboxService
SandboxService
沙箱服务字段。
The sandbox service field.
sandbox
Sandbox
沙箱字段。
The sandbox field.
schema
Map<String, Object>
模式字段。
The schema field.

构造器摘要Constructor Summary

构造器Constructor说明Description
protected SandboxTool(String name, String toolType, String description)
初始化 `SandboxTool` 实例。
Creates a new instance.
protected SandboxTool(String name, String toolType, String description, SandboxService sandboxService)
初始化 `SandboxTool` 实例。
Creates a new instance.

方法摘要Method Summary

方法Method说明Description
public SandboxService getSandboxService()
获取沙箱服务。
Returns the sandbox service.
public void setSandboxService(SandboxService sandboxService)
设置沙箱服务。
Sets the sandbox service.
public Sandbox getSandbox()
获取沙箱。
Returns the sandbox.
public void setSandbox(Sandbox sandbox)
设置沙箱。
Sets the sandbox.
public Map<String, Object> getSchema()
获取模式。
Returns the schema.
protected void setSchema(Map<String, Object> schema)
设置模式。
Sets the schema.
public abstract Class<? extends Sandbox> getSandboxClass()
abstract
获取沙箱类。
Returns the sandbox class.
public abstract SandboxTool bind(Sandbox sandbox)
abstract
设置该参数。
Performs the bind operation.

字段详情Field Detail

sandboxService

protected SandboxService sandboxService

沙箱服务字段。声明为 protected SandboxService sandboxService。

The sandbox service field.

源码Source io/agentscope/runtime/sandbox/tools/SandboxTool.java:26

sandbox

protected Sandbox sandbox

沙箱字段。声明为 protected Sandbox sandbox。

The sandbox field.

源码Source io/agentscope/runtime/sandbox/tools/SandboxTool.java:28

schema

protected Map<String, Object> schema

模式字段。声明为 protected Map schema。

The schema field.

源码Source io/agentscope/runtime/sandbox/tools/SandboxTool.java:30

构造器详情Constructor Detail

SandboxTool

protected SandboxTool(String name, String toolType, String description)

初始化 SandboxTool 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
nameString名称(类型 `String`)。The name.
toolTypeString工具类型(类型 `String`)。The tool type.
descriptionString描述(类型 `String`)。The description.
源码Source io/agentscope/runtime/sandbox/tools/SandboxTool.java:32–34

SandboxTool

protected SandboxTool(String name, String toolType, String description, SandboxService sandboxService)

初始化 SandboxTool 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
nameString名称(类型 `String`)。The name.
toolTypeString工具类型(类型 `String`)。The tool type.
descriptionString描述(类型 `String`)。The description.
sandboxServiceSandboxService沙箱服务(类型 `SandboxService`)。The sandbox service.
源码Source io/agentscope/runtime/sandbox/tools/SandboxTool.java:36–40

方法详情Method Detail

getSandboxService

public SandboxService getSandboxService()

获取沙箱服务。

Returns the sandbox service.

返回Returns SandboxService
返回SandboxService。Returns sandbox service.
源码Source io/agentscope/runtime/sandbox/tools/SandboxTool.java:42–44

setSandboxService

public void setSandboxService(SandboxService sandboxService)

设置沙箱服务。

Sets the sandbox service.

参数Parameters
名称Name类型Type说明Description
sandboxServiceSandboxService沙箱服务(类型 `SandboxService`)。The sandbox service.
源码Source io/agentscope/runtime/sandbox/tools/SandboxTool.java:46–48

getSandbox

public Sandbox getSandbox()

获取沙箱。

Returns the sandbox.

返回Returns Sandbox
返回沙箱。Returns sandbox.
源码Source io/agentscope/runtime/sandbox/tools/SandboxTool.java:50–52

setSandbox

public void setSandbox(Sandbox sandbox)

设置沙箱。

Sets the sandbox.

参数Parameters
名称Name类型Type说明Description
sandboxSandbox沙箱(类型 `Sandbox`)。The sandbox.
源码Source io/agentscope/runtime/sandbox/tools/SandboxTool.java:54–56

getSchema

public Map<String, Object> getSchema()

获取模式。

Returns the schema.

返回Returns Map<String, Object>
返回映射。Returns map.
源码Source io/agentscope/runtime/sandbox/tools/SandboxTool.java:58–60

setSchema

protected void setSchema(Map<String, Object> schema)

设置模式。

Sets the schema.

参数Parameters
名称Name类型Type说明Description
schemaMap<String, Object>模式定义(类型 `Map`)。The schema.
源码Source io/agentscope/runtime/sandbox/tools/SandboxTool.java:62–64

getSandboxClass

public abstract Class<? extends Sandbox> getSandboxClass()
abstract

获取沙箱类。

Returns the sandbox class.

返回Returns Class<? extends Sandbox>
返回类。Returns class.
源码Source io/agentscope/runtime/sandbox/tools/SandboxTool.java:66

bind

public abstract SandboxTool bind(Sandbox sandbox)
abstract

设置该参数。

Performs the bind operation.

参数Parameters
名称Name类型Type说明Description
sandboxSandbox沙箱(类型 `Sandbox`)。The sandbox.
返回Returns SandboxTool
返回SandboxTool。Returns sandbox tool.
源码Source io/agentscope/runtime/sandbox/tools/SandboxTool.java:68

继承成员Inherited Members

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