AS AgentScopeAPI 手册 / API Reference

TrainingSandboxClient

public class TrainingSandboxClient extends SandboxClient
源码Source io/agentscope/runtime/sandbox/manager/util/TrainingSandboxClient.java:33–436

Training 沙箱客户端,封装与远端服务的连接和调用。位于 io.agentscope.runtime.sandbox.manager.util 包,继承自 SandboxClient。核心成员包括 addMcpServers、checkHealth、waitUntilHealthy、getTaskIds、getEnvProfile、getToolsInfo。

A class in io.agentscope.runtime.sandbox.manager.util that deploys, schedules and serves agents. Declared in io.agentscope.runtime.sandbox.manager.util. Extends SandboxClient.

构造器摘要Constructor Summary

构造器Constructor说明Description
public TrainingSandboxClient(ContainerModel containerModel, int timeout)
初始化 `TrainingSandboxClient` 实例。
Constructor with ContainerModel
public TrainingSandboxClient(String baseUrl, int timeout)
初始化 `TrainingSandboxClient` 实例。
Constructor with base URL

方法摘要Method Summary

方法Method说明Description
public Map<String, Object> addMcpServers(Map<String, Object> serverConfigs, boolean overwrite)
添加 `addMcpServers`。
Adds the mcp servers.
public boolean checkHealth()
检查健康状态。
Returns the check health.
public void waitUntilHealthy()
等待 `waitUntilHealthy`。
Returns the wait until healthy.
public Object getTaskIds(String envType, String split, Map<String, Object> params)
获取任务 IDs 用于特定环境。
Get task IDs for a specific environment
public String getEnvProfile(String envType, String split, Map<String, Object> params)
获取环境配置档案。
Get environment profile
public Map<String, Object> getToolsInfo(String instanceId, Map<String, Object> messages, Map<String, Object> params)
获取工具信息。
Get tools information for an instance
public String createInstance(String envType, String taskId, String instanceId, Map<String, Object> params)
创建实例。
Create a training instance
public String step(String instanceId, Map<String, Object> action, Map<String, Object> params)
执行步骤相关操作。
Execute a step in the training environment
public String evaluate(String instanceId, Map<String, Object> messages, Map<String, Object> params)
执行 `evaluate` 方法。
Evaluate instance performance
public String releaseInstance(String instanceId)
设置该参数。
Release a training instance
public String callTool(String name, Map<String, Object> arguments)
调用工具。
Call a tool by name
public Map<String, Object> listTools(String toolType, Map<String, Object> arguments)
列出工具。
Lists the tools.
public void close() throws IOException
关闭连接并释放相关资源。
Releases resources and connections.

构造器详情Constructor Detail

TrainingSandboxClient

public TrainingSandboxClient(ContainerModel containerModel, int timeout)

初始化 TrainingSandboxClient 实例。

Constructor with ContainerModel

参数Parameters
名称Name类型Type说明Description
containerModelContainerModel容器模型(类型 `ContainerModel`)。Container model with base URL information
timeoutint超时时间(类型 `int`)。Timeout in seconds
源码Source io/agentscope/runtime/sandbox/manager/util/TrainingSandboxClient.java:47–49

TrainingSandboxClient

public TrainingSandboxClient(String baseUrl, int timeout)

初始化 TrainingSandboxClient 实例。

Constructor with base URL

参数Parameters
名称Name类型Type说明Description
baseUrlString基类 URL(类型 `String`)。Base URL of the training sandbox service
timeoutint超时时间(类型 `int`)。Timeout in seconds
源码Source io/agentscope/runtime/sandbox/manager/util/TrainingSandboxClient.java:57–74

方法详情Method Detail

addMcpServers

public Map<String, Object> addMcpServers(Map<String, Object> serverConfigs, boolean overwrite)

添加 addMcpServers。

Adds the mcp servers.

参数Parameters
名称Name类型Type说明Description
serverConfigsMap<String, Object>服务端 Configs(类型 `Map`)。The server configs.
overwritebooleanoverwrite(类型 `boolean`)。The overwrite.
返回Returns Map<String, Object>
返回映射。Returns map.
源码Source io/agentscope/runtime/sandbox/manager/util/TrainingSandboxClient.java:76–79

checkHealth

public boolean checkHealth()

检查健康状态。

Returns the check health.

返回Returns boolean
返回布尔值,表示判断结果。Returns a boolean result.
源码Source io/agentscope/runtime/sandbox/manager/util/TrainingSandboxClient.java:82–99

waitUntilHealthy

public void waitUntilHealthy()

等待 waitUntilHealthy。

Returns the wait until healthy.

源码Source io/agentscope/runtime/sandbox/manager/util/TrainingSandboxClient.java:101–120

getTaskIds

public Object getTaskIds(String envType, String split, Map<String, Object> params)

获取任务 IDs 用于特定环境。

Get task IDs for a specific environment

参数Parameters
名称Name类型Type说明Description
envTypeStringenv 类型(类型 `String`)。Environment type
splitString已拆分(类型 `String`)。Data split (e.g., "train", "test")
paramsMap<String, Object>参数(类型 `Map`)。Additional parameters
返回Returns Object
返回对象。Task IDs data
源码Source io/agentscope/runtime/sandbox/manager/util/TrainingSandboxClient.java:189–202

getEnvProfile

public String getEnvProfile(String envType, String split, Map<String, Object> params)

获取环境配置档案。

Get environment profile

参数Parameters
名称Name类型Type说明Description
envTypeStringenv 类型(类型 `String`)。Environment type
splitString已拆分(类型 `String`)。Data split
paramsMap<String, Object>参数(类型 `Map`)。Additional parameters
返回Returns String
返回字符串结果。Environment profile data
源码Source io/agentscope/runtime/sandbox/manager/util/TrainingSandboxClient.java:212–230

getToolsInfo

public Map<String, Object> getToolsInfo(String instanceId, Map<String, Object> messages, Map<String, Object> params)

获取工具信息。

Get tools information for an instance

参数Parameters
名称Name类型Type说明Description
instanceIdString实例标识(类型 `String`)。Instance ID
messagesMap<String, Object>消息列表(类型 `Map`)。Messages
paramsMap<String, Object>参数(类型 `Map`)。Parameters
返回Returns Map<String, Object>
返回映射。BaseSandboxTool information
源码Source io/agentscope/runtime/sandbox/manager/util/TrainingSandboxClient.java:240–270

createInstance

public String createInstance(String envType, String taskId, String instanceId, Map<String, Object> params)

创建实例。

Create a training instance

参数Parameters
名称Name类型Type说明Description
envTypeStringenv 类型(类型 `String`)。Environment type
taskIdString任务标识(类型 `String`)。Task ID
instanceIdString实例标识(类型 `String`)。Instance ID (optional)
paramsMap<String, Object>参数(类型 `Map`)。Additional parameters
返回Returns String
返回字符串结果。Created instance information
源码Source io/agentscope/runtime/sandbox/manager/util/TrainingSandboxClient.java:281–296

step

public String step(String instanceId, Map<String, Object> action, Map<String, Object> params)

执行步骤相关操作。

Execute a step in the training environment

参数Parameters
名称Name类型Type说明Description
instanceIdString实例标识(类型 `String`)。Instance ID
actionMap<String, Object>动作(类型 `Map`)。Action to perform
paramsMap<String, Object>参数(类型 `Map`)。Additional parameters
返回Returns String
返回字符串结果。Step result
源码Source io/agentscope/runtime/sandbox/manager/util/TrainingSandboxClient.java:306–321

evaluate

public String evaluate(String instanceId, Map<String, Object> messages, Map<String, Object> params)

执行 evaluate 方法。

Evaluate instance performance

参数Parameters
名称Name类型Type说明Description
instanceIdString实例标识(类型 `String`)。Instance ID
messagesMap<String, Object>消息列表(类型 `Map`)。Evaluation messages
paramsMap<String, Object>参数(类型 `Map`)。Additional parameters
返回Returns String
返回字符串结果。Evaluation results
源码Source io/agentscope/runtime/sandbox/manager/util/TrainingSandboxClient.java:331–346

releaseInstance

public String releaseInstance(String instanceId)

设置该参数。

Release a training instance

参数Parameters
名称Name类型Type说明Description
instanceIdString实例标识(类型 `String`)。Instance ID
返回Returns String
返回字符串结果。true if released successfully
源码Source io/agentscope/runtime/sandbox/manager/util/TrainingSandboxClient.java:354–365

callTool

public String callTool(String name, Map<String, Object> arguments)

调用工具。

Call a tool by name

参数Parameters
名称Name类型Type说明Description
nameString名称(类型 `String`)。BaseSandboxTool name
argumentsMap<String, Object>参数(类型 `Map`)。Arguments
返回Returns String
返回字符串结果。BaseSandboxTool result
源码Source io/agentscope/runtime/sandbox/manager/util/TrainingSandboxClient.java:374–412

listTools

public Map<String, Object> listTools(String toolType, Map<String, Object> arguments)

列出工具。

Lists the tools.

参数Parameters
名称Name类型Type说明Description
toolTypeString工具类型(类型 `String`)。The tool type.
argumentsMap<String, Object>参数(类型 `Map`)。The arguments.
返回Returns Map<String, Object>
返回映射。Returns map.
源码Source io/agentscope/runtime/sandbox/manager/util/TrainingSandboxClient.java:423–431

close

public void close() throws IOException

关闭连接并释放相关资源。

Releases resources and connections.

抛出Throws
  • IOException 可能抛出 `IOException`。Thrown when the operation cannot be completed.
源码Source io/agentscope/runtime/sandbox/manager/util/TrainingSandboxClient.java:433–435
基于官方固定版本源码静态生成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.