AS AgentScopeAPI 手册 / API Reference

ControlPlaneStores

public final class ControlPlaneStores
源码Source io/agentscope/extensions/controlplane/store/ControlPlaneStores.java:45–207

控制面 Stores,承载智能体的部署、调度与服务化运行。位于 io.agentscope.extensions.controlplane.store 包。核心成员包括 fromEnv、create、from、baseStore、sandboxExecutionGuard、sandboxSnapshotSpec。

Factory for control-plane hosted store components (/api/v1/dp/*).

AgentStateStore is deliberately excluded — callers must supply their own via #withAgentStateStore(AgentStateStore).

`ControlPlaneStores cp = ControlPlaneStores.fromEnv();
HarnessAgent.builder()
.distributedStore(cp.withAgentStateStore(redisStore.agentStateStore()))
.filesystem(new RemoteFilesystemSpec().isolationScope(IsolationScope.USER))
.build();
`

方法摘要Method Summary

方法Method说明Description
public static ControlPlaneStores fromEnv()
static
返回 `fromEnv` 结果。
Creates a factory from environment variables: `CONTROL_PLANE_HTTP`, `BUILDER_INTERNAL_TOKEN`, `CONTROL_PLANE_AGENT_NAME`, `CONTROL_PLANE_NAMESPACE`.
public static ControlPlaneStores create(String httpBase, String token, String agentName, String namespace)
static
创建并返回实例。
Creates a factory from explicit connection settings.
public static ControlPlaneStores from(ControlPlaneConfig config)
static
创建并返回实例。
Creates a factory reusing connection settings from an `ControlPlaneConfig`.
public BaseStore baseStore()
返回基类存储。
Returns a control-plane backed `BaseStore`.
public SandboxExecutionGuard sandboxExecutionGuard()
返回沙箱执行守卫。
Returns a control-plane backed `SandboxExecutionGuard`.
public SandboxSnapshotSpec sandboxSnapshotSpec()
返回沙箱快照规格。
Returns a control-plane backed `SandboxSnapshotSpec`.
public MessageBus messageBus()
返回消息总线。
Returns a control-plane backed `MessageBus`, or `null` when the hosted-store endpoint is unreachable so `HarnessAgent` can fall back to `WorkspaceMessageBus`.
public AsyncToolRegistry asyncToolRegistry()
返回异步工具注册表。
Returns a control-plane backed `AsyncToolRegistry`, or `null` when the hosted-store endpoint is unreachable so `HarnessAgent` can fall back to the workspace registry.
public TaskRepository taskRepository()
返回任务仓库。
Returns a control-plane backed `TaskRepository`, or `null` when unreachable.
public SessionTurnGate sessionTurnGate()
返回 `sessionTurnGate` 结果。
Returns a control-plane backed `SessionTurnGate` for distributed per-session turn serialization.
public DistributedStore withAgentStateStore(AgentStateStore stateStore)
执行使用智能体状态存储相关操作。
Builds a `DistributedStore` by combining hosted components with a user-provided `AgentStateStore`.

方法详情Method Detail

fromEnv

public static ControlPlaneStores fromEnv()
static

返回 fromEnv 结果。

Creates a factory from environment variables: CONTROL_PLANE_HTTP, BUILDER_INTERNAL_TOKEN, CONTROL_PLANE_AGENT_NAME, CONTROL_PLANE_NAMESPACE.

返回Returns ControlPlaneStores
返回ControlPlaneStores。Returns control plane stores.
源码Source io/agentscope/extensions/controlplane/store/ControlPlaneStores.java:62–68

create

public static ControlPlaneStores create(String httpBase, String token, String agentName, String namespace)
static

创建并返回实例。

Creates a factory from explicit connection settings.

参数Parameters
名称Name类型Type说明Description
httpBaseStringHTTP 基类(类型 `String`)。control-plane HTTP base URL
tokenString用于`X-Builder-Internal-Token`的内部令牌。internal token for `X-Builder-Internal-Token`
agentNameString智能体名称(类型 `String`)。logical agent name
namespaceString命名空间(类型 `String`)。tenant / Kubernetes namespace
返回Returns ControlPlaneStores
返回ControlPlaneStores。Returns control plane stores.
源码Source io/agentscope/extensions/controlplane/store/ControlPlaneStores.java:78–82

from

public static ControlPlaneStores from(ControlPlaneConfig config)
static

创建并返回实例。

Creates a factory reusing connection settings from an ControlPlaneConfig.

参数Parameters
名称Name类型Type说明Description
configControlPlaneConfig配置对象(类型 `ControlPlaneConfig`)。controlplane bridge config (must have `controlPlaneHttp` and token set)
返回Returns ControlPlaneStores
返回ControlPlaneStores。Returns control plane stores.
源码Source io/agentscope/extensions/controlplane/store/ControlPlaneStores.java:89–102

baseStore

public BaseStore baseStore()

返回基类存储。

Returns a control-plane backed BaseStore.

返回Returns BaseStore
返回BaseStore。Returns base store.
源码Source io/agentscope/extensions/controlplane/store/ControlPlaneStores.java:105–107

sandboxExecutionGuard

public SandboxExecutionGuard sandboxExecutionGuard()

返回沙箱执行守卫。

Returns a control-plane backed SandboxExecutionGuard.

返回Returns SandboxExecutionGuard
返回SandboxExecutionGuard。Returns sandbox execution guard.
源码Source io/agentscope/extensions/controlplane/store/ControlPlaneStores.java:110–112

sandboxSnapshotSpec

public SandboxSnapshotSpec sandboxSnapshotSpec()

返回沙箱快照规格。

Returns a control-plane backed SandboxSnapshotSpec.

返回Returns SandboxSnapshotSpec
返回SandboxSnapshotSpec。Returns sandbox snapshot spec.
源码Source io/agentscope/extensions/controlplane/store/ControlPlaneStores.java:115–117

messageBus

public MessageBus messageBus()

返回消息总线。

Returns a control-plane backed MessageBus, or null when the hosted-store endpoint is unreachable so HarnessAgent can fall back to WorkspaceMessageBus.

返回Returns MessageBus
返回MessageBus。Returns message bus.
源码Source io/agentscope/extensions/controlplane/store/ControlPlaneStores.java:123–128

asyncToolRegistry

public AsyncToolRegistry asyncToolRegistry()

返回异步工具注册表。

Returns a control-plane backed AsyncToolRegistry, or null when the hosted-store endpoint is unreachable so HarnessAgent can fall back to the workspace registry.

返回Returns AsyncToolRegistry
返回AsyncToolRegistry。Returns async tool registry.
源码Source io/agentscope/extensions/controlplane/store/ControlPlaneStores.java:135–140

taskRepository

public TaskRepository taskRepository()

返回任务仓库。

Returns a control-plane backed TaskRepository, or null when unreachable.

返回Returns TaskRepository
返回TaskRepository。Returns task repository.
源码Source io/agentscope/extensions/controlplane/store/ControlPlaneStores.java:143–148

sessionTurnGate

public SessionTurnGate sessionTurnGate()

返回 sessionTurnGate 结果。

Returns a control-plane backed SessionTurnGate for distributed per-session turn serialization.

返回Returns SessionTurnGate
返回SessionTurnGate。Returns session turn gate.
源码Source io/agentscope/extensions/controlplane/store/ControlPlaneStores.java:157–159

withAgentStateStore

public DistributedStore withAgentStateStore(AgentStateStore stateStore)

执行使用智能体状态存储相关操作。

Builds a DistributedStore by combining hosted components with a user-provided AgentStateStore.

参数Parameters
名称Name类型Type说明Description
stateStoreAgentStateStore状态存储(类型 `AgentStateStore`)。required agent session state backend
返回Returns DistributedStore
返回DistributedStore。a composite distributed store
源码Source io/agentscope/extensions/controlplane/store/ControlPlaneStores.java:168–180
基于官方固定版本源码静态生成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.