AS AgentScopeAPI 手册 / API Reference

WorkspaceSpec

public class WorkspaceSpec
源码Source io/agentscope/harness/agent/sandbox/WorkspaceSpec.java:43–86

工作区规格,承载智能体的部署、调度与服务化运行。位于 io.agentscope.harness.agent.sandbox 包。核心成员包括 getRoot、setRoot、getEntries、setEntries、getEnvironment、setEnvironment。

Describes the desired initial state of a sandbox workspace: root path, materialized file/directory entries, and per-exec environment variables.

Fields:

  • root — workspace path inside the sandbox (default: /workspace)

  • entries — files, directories, and optional bind_mount entries to apply at startup (bind mounts are enforced by Docker/Kubernetes stores, not materialized as copied files)

  • environment — environment variables to inject into every exec command

Usage example:

`WorkspaceSpec spec = new WorkspaceSpec();
spec.setRoot("/workspace");
spec.getEntries().put("README.md", new io.agentscope.harness.agent.sandbox.layout.FileEntry("# My Project"));
spec.getEnvironment().put("DEBUG", "true");
`

构造器摘要Constructor Summary

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

方法摘要Method Summary

方法Method说明Description
public String getRoot()
获取根。
Returns the root.
public void setRoot(String root)
设置根。
Sets the root.
public Map<String, WorkspaceEntry> getEntries()
获取条目。
Returns the entries.
public void setEntries(Map<String, WorkspaceEntry> entries)
设置条目。
Sets the entries.
public Map<String, String> getEnvironment()
获取环境。
Returns the environment.
public void setEnvironment(Map<String, String> environment)
设置环境。
Sets the environment.
public WorkspaceSpec copy()
返回 `copy` 结果。
Creates a deep copy.

构造器详情Constructor Detail

WorkspaceSpec

public WorkspaceSpec()

初始化 WorkspaceSpec 实例。

Creates a new instance.

源码Source io/agentscope/harness/agent/sandbox/WorkspaceSpec.java:49

方法详情Method Detail

getRoot

public String getRoot()

获取根。

Returns the root.

返回Returns String
返回字符串结果。Returns a string.
源码Source io/agentscope/harness/agent/sandbox/WorkspaceSpec.java:51–53

setRoot

public void setRoot(String root)

设置根。

Sets the root.

参数Parameters
名称Name类型Type说明Description
rootString根(类型 `String`)。The root.
源码Source io/agentscope/harness/agent/sandbox/WorkspaceSpec.java:55–57

getEntries

public Map<String, WorkspaceEntry> getEntries()

获取条目。

Returns the entries.

返回Returns Map<String, WorkspaceEntry>
返回映射。Returns map.
源码Source io/agentscope/harness/agent/sandbox/WorkspaceSpec.java:59–61

setEntries

public void setEntries(Map<String, WorkspaceEntry> entries)

设置条目。

Sets the entries.

参数Parameters
名称Name类型Type说明Description
entriesMap<String, WorkspaceEntry>条目(类型 `Map`)。The entries.
源码Source io/agentscope/harness/agent/sandbox/WorkspaceSpec.java:63–65

getEnvironment

public Map<String, String> getEnvironment()

获取环境。

Returns the environment.

返回Returns Map<String, String>
返回映射。Returns map.
源码Source io/agentscope/harness/agent/sandbox/WorkspaceSpec.java:67–69

setEnvironment

public void setEnvironment(Map<String, String> environment)

设置环境。

Sets the environment.

参数Parameters
名称Name类型Type说明Description
environmentMap<String, String>环境(类型 `Map`)。The environment.
源码Source io/agentscope/harness/agent/sandbox/WorkspaceSpec.java:71–73

copy

public WorkspaceSpec copy()

返回 copy 结果。

Creates a deep copy.

返回Returns WorkspaceSpec
返回WorkspaceSpec。Returns workspace spec.
源码Source io/agentscope/harness/agent/sandbox/WorkspaceSpec.java:79–85
基于官方固定版本源码静态生成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.