AS AgentScopeAPI 手册 / API Reference

DataPlaneConfig

@Configuration public class DataPlaneConfig
源码Source io/agentscope/builder/web/config/DataPlaneConfig.java:73–188

数据面配置,保存相关配置项。位于 io.agentscope.builder.web.config 包。核心成员包括 objectMapper、dashscopeModel、baseStore、agentStateStore、coordinationStore、agentVisibilityResolver。

Bean assembly for the builder data plane.

  • ObjectMapper — shared JSON helper when Jackson auto-configuration does not expose one (WebFlux / Boot 4 setups);

  • Model — optional default DashScope model for agents whose snapshot does not pin a model name; skipped when no api-key is configured so Optional<Model> injection sites receive Optional.empty();

  • BaseStore — JDBC-backed shared key/value store. The control plane writes agent definition files (skills, subagents, mirrors) through it; the data plane reads the same namespaces from the shared database when materializing agents;

  • AgentStateStore — JPA-backed agent state persistence used by every built HarnessAgent;

  • CoordinationStore — JDBC-backed coordination tables (turn leases, HITL tickets, Hands work queue) shared with the scheduler;

  • SharedWorkspacePaths — resolves the platform-wide shared workspace root (identical layout to the control plane).

方法摘要Method Summary

方法Method说明Description
public ObjectMapper objectMapper()
返回 `objectMapper` 结果。
Ensures a shared `ObjectMapper` is available for `ManagedJsonHelper` and API layers when Jackson auto-configuration does not expose one (WebFlux / Boot 4 setups).
public Model dashscopeModel()
返回DashScope 模型。
Creates a `DashScopeChatModel` bean when `builder.dashscope.api-key` (or the legacy `claw.dashscope.api-key`) is configured and no other `Model` bean is present.
public BaseStore baseStore(DataSource dataSource)
设置基类存储。
Default `BaseStore` backed by the Spring-managed `DataSource`.
public AgentStateStore agentStateStore(AgentStateEntityRepository repository, DeletedSessionRegistry deletedSessions)
执行智能体状态存储相关操作。
JPA-backed `AgentStateStore` shared by every agent built on this node.
public CoordinationStore coordinationStore(CoordLeaseEntityRepository leaseRepository, CoordHitlTicketEntityRepository hitlRepository, CoordWorkItemEntityRepository workRepository, CoordWorkerHeartbeatEntityRepository workerRepository, TransactionTemplate transactionTemplate)
执行 `coordinationStore` 方法。
Default multi-replica coordination store (turn leases, HITL tickets, Hands work queue) persisted in the shared builder database.
public AgentVisibilityResolver agentVisibilityResolver(AgentVersionEntityRepository versionRepository, AgentVersionService versionService, UserAgentDefinitionStore userAgentDefinitionStore, UserStore userStore, AgentAclService aclService)
执行 `agentVisibilityResolver` 方法。
JPA-only `AgentVisibilityResolver` read view over the shared database (global agents via materialized version rows, own/shared-in user agents via the definition store + ACL grants).
public SharedWorkspacePaths sharedWorkspacePaths(String workspaceRoot)
设置该参数。
Shared workspace path resolver.

方法详情Method Detail

objectMapper

public ObjectMapper objectMapper()

返回 objectMapper 结果。

Ensures a shared ObjectMapper is available for ManagedJsonHelper and API layers when Jackson auto-configuration does not expose one (WebFlux / Boot 4 setups).

返回Returns ObjectMapper
返回ObjectMapper。Returns object mapper.
源码Source io/agentscope/builder/web/config/DataPlaneConfig.java:91–95

dashscopeModel

public Model dashscopeModel()

返回DashScope 模型。

Creates a DashScopeChatModel bean when builder.dashscope.api-key (or the legacy claw.dashscope.api-key) is configured and no other Model bean is present.

返回Returns Model
返回模型。Returns model.
源码Source io/agentscope/builder/web/config/DataPlaneConfig.java:102–112

baseStore

public BaseStore baseStore(DataSource dataSource)

设置基类存储。

Default BaseStore backed by the Spring-managed DataSource.

参数Parameters
名称Name类型Type说明Description
dataSourceDataSource数据来源(类型 `DataSource`)。The data source.
返回Returns BaseStore
返回BaseStore。Returns base store.
源码Source io/agentscope/builder/web/config/DataPlaneConfig.java:119–124

agentStateStore

public AgentStateStore agentStateStore(AgentStateEntityRepository repository, DeletedSessionRegistry deletedSessions)

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

JPA-backed AgentStateStore shared by every agent built on this node.

参数Parameters
名称Name类型Type说明Description
repositoryAgentStateEntityRepository仓库(类型 `AgentStateEntityRepository`)。The repository.
deletedSessionsDeletedSessionRegistry已删除会话(类型 `DeletedSessionRegistry`)。The deleted sessions.
返回Returns AgentStateStore
返回AgentStateStore。Returns agent state store.
源码Source io/agentscope/builder/web/config/DataPlaneConfig.java:127–133

coordinationStore

public CoordinationStore coordinationStore(CoordLeaseEntityRepository leaseRepository, CoordHitlTicketEntityRepository hitlRepository, CoordWorkItemEntityRepository workRepository, CoordWorkerHeartbeatEntityRepository workerRepository, TransactionTemplate transactionTemplate)

执行 coordinationStore 方法。

Default multi-replica coordination store (turn leases, HITL tickets, Hands work queue) persisted in the shared builder database.

参数Parameters
名称Name类型Type说明Description
leaseRepositoryCoordLeaseEntityRepositorylease 仓库(类型 `CoordLeaseEntityRepository`)。The lease repository.
hitlRepositoryCoordHitlTicketEntityRepositoryhitl 仓库(类型 `CoordHitlTicketEntityRepository`)。The hitl repository.
workRepositoryCoordWorkItemEntityRepositorywork 仓库(类型 `CoordWorkItemEntityRepository`)。The work repository.
workerRepositoryCoordWorkerHeartbeatEntityRepository工作进程仓库(类型 `CoordWorkerHeartbeatEntityRepository`)。The worker repository.
transactionTemplateTransactionTemplate事务模板(类型 `TransactionTemplate`)。The transaction template.
返回Returns CoordinationStore
返回CoordinationStore。Returns coordination store.
源码Source io/agentscope/builder/web/config/DataPlaneConfig.java:140–155

agentVisibilityResolver

public AgentVisibilityResolver agentVisibilityResolver(AgentVersionEntityRepository versionRepository, AgentVersionService versionService, UserAgentDefinitionStore userAgentDefinitionStore, UserStore userStore, AgentAclService aclService)

执行 agentVisibilityResolver 方法。

JPA-only AgentVisibilityResolver read view over the shared database (global agents via materialized version rows, own/shared-in user agents via the definition store + ACL grants).

参数Parameters
名称Name类型Type说明Description
versionRepositoryAgentVersionEntityRepository版本仓库(类型 `AgentVersionEntityRepository`)。The version repository.
versionServiceAgentVersionService版本服务(类型 `AgentVersionService`)。The version service.
userAgentDefinitionStoreUserAgentDefinitionStore用户智能体定义存储(类型 `UserAgentDefinitionStore`)。The user agent definition store.
userStoreUserStore用户存储(类型 `UserStore`)。The user store.
aclServiceAgentAclServiceacl 服务(类型 `AgentAclService`)。The acl service.
返回Returns AgentVisibilityResolver
返回AgentVisibilityResolver。Returns agent visibility resolver.
源码Source io/agentscope/builder/web/config/DataPlaneConfig.java:162–172

sharedWorkspacePaths

public SharedWorkspacePaths sharedWorkspacePaths(String workspaceRoot)

设置该参数。

Shared workspace path resolver.

参数Parameters
名称Name类型Type说明Description
workspaceRootString工作区根(类型 `String`)。The workspace root.
返回Returns SharedWorkspacePaths
返回SharedWorkspacePaths。Returns shared workspace paths.
源码Source io/agentscope/builder/web/config/DataPlaneConfig.java:179–187
基于官方固定版本源码静态生成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.