AgentRunClient
public class AgentRunClient extends BaseClient源码Source
io/agentscope/runtime/sandbox/client/agentrun/AgentRunClient.java:39–696智能体运行客户端，封装与远端服务的连接和调用。位于 io.agentscope.runtime.sandbox.client.agentrun 包，继承自 BaseClient。核心成员包括 connect、isConnected、createContainer、startContainer、stopContainer、removeContainer。
Client for managing AgentRun containers in the sandbox environment.
This client provides methods to create, start, stop, remove, and inspect AgentRun sessions. It also handles the underlying AgentRun API calls and status polling.
构造器摘要Constructor Summary
| 构造器Constructor | 说明Description |
|---|---|
public AgentRunClient(AgentRunClientStarter config) throws Exception | 初始化 `AgentRunClient` 实例。 Creates a new instance. |
方法摘要Method Summary
构造器详情Constructor Detail
AgentRunClient
public AgentRunClient(AgentRunClientStarter config) throws Exception初始化 AgentRunClient 实例。
Creates a new instance.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
config | AgentRunClientStarter | 配置对象（类型 `AgentRunClientStarter`）。The config. |
Exception可能抛出 `Exception`。Thrown when the operation cannot be completed.
源码Source
io/agentscope/runtime/sandbox/client/agentrun/AgentRunClient.java:60–69方法详情Method Detail
connect
public boolean connect()建立连接并完成初始化。
Returns the connect.
boolean返回布尔值，表示判断结果。Returns a boolean result.
源码Source
io/agentscope/runtime/sandbox/client/agentrun/AgentRunClient.java:71–81isConnected
public boolean isConnected()判断是否已连接。
Returns whether the connected.
boolean返回布尔值，表示判断结果。Returns a boolean result.
源码Source
io/agentscope/runtime/sandbox/client/agentrun/AgentRunClient.java:83–86createContainer
public ContainerCreateResult createContainer(String containerName, String imageName, List<String> ports, List<VolumeBinding> volumeBindings, Map<String, String> environment, Map<String, Object> runtimeConfig)创建容器。
Creates the container.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
containerName | String | 容器名称（类型 `String`）。The container name. |
imageName | String | 图像名称（类型 `String`）。The image name. |
ports | List<String> | ports（类型 `List`）。The ports. |
volumeBindings | List<VolumeBinding> | volume Bindings（类型 `List`）。The volume bindings. |
environment | Map<String, String> | 环境（类型 `Map`）。The environment. |
runtimeConfig | Map<String, Object> | 运行时配置（类型 `Map`）。The runtime config. |
ContainerCreateResult返回ContainerCreateResult。Returns container create result.
源码Source
io/agentscope/runtime/sandbox/client/agentrun/AgentRunClient.java:88–219startContainer
public void startContainer(String containerId)启动容器。
Starts the container.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
containerId | String | 容器标识（类型 `String`）。The container id. |
源码Source
io/agentscope/runtime/sandbox/client/agentrun/AgentRunClient.java:221–241stopContainer
public void stopContainer(String containerId)停止容器。
Stops the container.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
containerId | String | 容器标识（类型 `String`）。The container id. |
源码Source
io/agentscope/runtime/sandbox/client/agentrun/AgentRunClient.java:243–257removeContainer
public void removeContainer(String containerId)移除容器。
Removes the container.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
containerId | String | 容器标识（类型 `String`）。The container id. |
源码Source
io/agentscope/runtime/sandbox/client/agentrun/AgentRunClient.java:259–287getContainerStatus
public String getContainerStatus(String containerId)获取容器状态。
Returns the container status.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
containerId | String | 容器标识（类型 `String`）。The container id. |
String返回字符串结果。Returns a string.
源码Source
io/agentscope/runtime/sandbox/client/agentrun/AgentRunClient.java:289–311imageExists
public boolean imageExists(String imageName)设置该参数。
Performs the image exists operation.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
imageName | String | 图像名称（类型 `String`）。The image name. |
boolean返回布尔值，表示判断结果。Returns a boolean result.
源码Source
io/agentscope/runtime/sandbox/client/agentrun/AgentRunClient.java:313–316inspectContainer
public boolean inspectContainer(String containerIdOrName)设置该参数。
Performs the inspect container operation.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
containerIdOrName | String | 容器标识或名称（类型 `String`）。The container id or name. |
boolean返回布尔值，表示判断结果。Returns a boolean result.
源码Source
io/agentscope/runtime/sandbox/client/agentrun/AgentRunClient.java:318–322pullImage
public boolean pullImage(String imageName)设置该参数。
Performs the pull image operation.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
imageName | String | 图像名称（类型 `String`）。The image name. |
boolean返回布尔值，表示判断结果。Returns a boolean result.
源码Source
io/agentscope/runtime/sandbox/client/agentrun/AgentRunClient.java:324–328inspect
public Map<String, Object> inspect(String sessionId)设置该参数。
Inspect an AgentRun session and return detailed information.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
sessionId | String | 会话标识（类型 `String`）。The ID of the session to inspect. |
Map<String, Object>返回映射。A map containing session information, agent runtime info, and status.
源码Source
io/agentscope/runtime/sandbox/client/agentrun/AgentRunClient.java:336–393