AS AgentScopeAPI 手册 / API Reference
包package 2.x

service-common

AgentScope Java - Service Common · 2.0.4

Shared contracts: JPA entities/repositories, DTOs, error model, coordination store, auth filters, config entries

groupIdGroupIdio.agentscope
版本Version2.0.4
版本线Line2.x
分类Categoryservice
包Packages13
类型Types109 top-level / 140 total

包Packages

io.agentscope.builder.runtime.config9
io.agentscope.builder.web.api.error5
io.agentscope.builder.web.auth6
io.agentscope.builder.web.catalog5
io.agentscope.builder.web.catalog.spec2
io.agentscope.builder.web.config1
io.agentscope.builder.web.coord3
io.agentscope.builder.web.managed16
io.agentscope.builder.web.managed.selfhosted1
io.agentscope.builder.web.managed.service10
io.agentscope.builder.web.persistence.jpa43
io.agentscope.builder.web.share7
io.agentscope.builder.web.workspace1

类型Types

类型Type种类Kind包Package说明Description
AgentConfigEntry类classio.agentscope.builder.runtime.config
智能体配置条目，承载智能体的部署、调度与服务化运行。
Per-agent section in `agentscope.json` under `agents.<agentId>`.
AgentscopeConfig类classio.agentscope.builder.runtime.config
用于`${cwd}/.agentscope/agentscope.json`的根文档。
Root document for `${cwd}/.agentscope/agentscope.json`.
BindingConfigEntry类classio.agentscope.builder.runtime.config
绑定配置条目，承载智能体的部署、调度与服务化运行。
JSON-serializable counterpart of `ChannelBinding`.
ChannelConfigEntry类classio.agentscope.builder.runtime.config
渠道配置条目，承载智能体的部署、调度与服务化运行。
Per-channel section in `agentscope.json` under `channels.<channelId>`.
ChannelTypeRegistry类classio.agentscope.builder.runtime.config
渠道类型注册表，承载智能体的部署、调度与服务化运行。
Registry of `ChannelFactory` implementations keyed by `type`.
MarketplaceConfigEntry类classio.agentscope.builder.runtime.config
市场配置条目，承载智能体的部署、调度与服务化运行。
Marketplace configuration carrier — a `type` discriminator (`"git"` / ` "nacos"`) plus an open bag of type-specific properties.
SessionLifecycleConfig类classio.agentscope.builder.runtime.config
会话生命周期配置，保存相关配置项。
Optional `session` block in `agentscope.json` controlling session lifecycle and maintenance.
SkillRepositoryConfigEntry类classio.agentscope.builder.runtime.config
技能仓库配置条目，承载智能体的部署、调度与服务化运行。
Declarative skill repository settings for `agentscope.json` (and similar) configs.
SkillRepositorySupport类classio.agentscope.builder.runtime.config
构建`AgentSkillRepository`来自`SkillRepositoryConfigEntry`。
Builds an `AgentSkillRepository` from `SkillRepositoryConfigEntry`.
ApiErrorDetail记录recordio.agentscope.builder.web.api.error
承载 API 错误详情数据的记录类型。
Shared typed error object for HTTP responses and `session.error` payloads.
ApiErrorResponse记录recordio.agentscope.builder.web.api.error
承载 API 错误响应数据的记录类型。
Top-level HTTP error envelope: `{ "type": "error", "error": { ... } }`.
ApiErrorType枚举enumio.agentscope.builder.web.api.error
定义API 错误类型的枚举。
Typed HTTP / session.error categories shared across the Managed Agents API surface.
ApiException类classio.agentscope.builder.web.api.error
API 异常，表示执行过程中的错误。
Typed API failure with stable machine `code` for HTTP and session.error payloads.
RestExceptionHandler类classio.agentscope.builder.web.api.error
REST 异常处理器，承载智能体的部署、调度与服务化运行。
Maps exceptions on `/api/**` to the shared typed error envelope.
EnvironmentApiKeyVerifier接口interfaceio.agentscope.builder.web.auth
定义环境 API 键校验器契约的接口。
Verifies an Environment Worker API key against control-plane state.
EnvironmentKeyAuthFilter类classio.agentscope.builder.web.auth
环境键认证过滤器，承载智能体的部署、调度与服务化运行。
Authenticates Environment Worker requests via `X-Builder-Environment-Key` before the JWT filter chain.
InternalTokenAuthFilter类classio.agentscope.builder.web.auth
内部令牌认证过滤器，承载智能体的部署、调度与服务化运行。
Authenticates cross-plane internal calls via a shared static token carried in ` X-Builder-Internal-Token`.
InternalTokenStartupValidator类classio.agentscope.builder.web.auth
内部令牌启动校验器，承载智能体的部署、调度与服务化运行。
Fails fast when the shared cross-plane internal token is missing or uses a known development default outside the `dev` profile.
JwtService类classio.agentscope.builder.web.auth
JWT 服务，承载智能体的部署、调度与服务化运行。
HS256 JWT service for the claw web application.
UserStore接口interfaceio.agentscope.builder.web.auth
定义用户存储契约的接口。
Abstraction over the user registry.
AgentDefinition记录recordio.agentscope.builder.web.catalog
承载智能体定义数据的记录类型。
API representation of an agent definition visible to the current user.
BaseStoreDefinitionStore类classio.agentscope.builder.web.catalog
基类存储定义存储，负责持久化与读取数据。
`DefinitionStore` backed by the shared `BaseStore` under namespace ` definitions / {ownerId} / {agentId}`.
DefinitionStore接口interfaceio.agentscope.builder.web.catalog
定义定义存储契约的接口。
Control-plane persistence for agent *definition* files (skills, optional workspace assets, staged resources), independent of the session Hands `AbstractFilesystem`.
DefinitionStoreSkillRepository类classio.agentscope.builder.web.catalog
定义存储技能仓库，负责持久化与读取数据。
Loads workspace skills from the control-plane `DefinitionStore` (paths under ` skills/{name}/…`), independent of the session Hands filesystem.
UserAgentDefinitionStore接口interfaceio.agentscope.builder.web.catalog
定义用户智能体定义存储契约的接口。
Abstraction over the per-user custom agent definition registry.
AgentSpecCodec类classio.agentscope.builder.web.catalog.spec
智能体规格编解码器，承载智能体的部署、调度与服务化运行。
Converts Agent body tool/MCP/skills structures to harness `ToolsConfig` and policy maps.
AgentSpecTypes类classio.agentscope.builder.web.catalog.spec
智能体规格类型，承载智能体的部署、调度与服务化运行。
Wire types for the Managed Agents Agent body (tools / MCP / skills / multiagent), aligned with Claude Managed Agents semantics.
BuilderE2bProperties类classio.agentscope.builder.web.config
构建器 E 2 b 属性，承载智能体的部署、调度与服务化运行。
Global defaults for Managed Environment `type=sandbox` (E2B cloud).
BuilderInstanceId类classio.agentscope.builder.web.coord
构建器实例标识，承载智能体的部署、调度与服务化运行。
Stable-enough identity for this Brain / worker JVM, used as lease owner ids.
CoordinationStore接口interfaceio.agentscope.builder.web.coord
定义 Coordination 存储契约的接口。
Shared coordination plane for multi-replica Brain / Hands workers.
JdbcCoordinationStore类classio.agentscope.builder.web.coord
JDBC Coordination 存储，负责持久化与读取数据。
JDBC-backed `CoordinationStore` using the builder catalog DataSource / JPA schema.
AgentOverrideMerger类classio.agentscope.builder.web.managed
智能体 Override Merger，承载智能体的部署、调度与服务化运行。
Shared merge helper for session-scoped agent overrides.
AgentVersionSnapshot记录recordio.agentscope.builder.web.managed
承载智能体版本快照数据的记录类型。
Immutable snapshot of versioned agent configuration fields persisted in `io.agentscope.builder.web.persistence.jpa.AgentVersionEntity`.
DeploymentDto记录recordio.agentscope.builder.web.managed
承载部署 Dto数据的记录类型。
API representation of a deployment: agent + version + environment + trigger.
EnvironmentDto记录recordio.agentscope.builder.web.managed
承载环境 Dto数据的记录类型。
API representation of an execution environment template.
EnvironmentTypes类classio.agentscope.builder.web.managed
环境类型，承载智能体的部署、调度与服务化运行。
Environment template type constants, shared across planes.
ManagedSessionDto记录recordio.agentscope.builder.web.managed
承载托管会话 Dto数据的记录类型。
API representation of a managed agent session.
MemoryDto记录recordio.agentscope.builder.web.managed
承载记忆 Dto数据的记录类型。
API representation of a path-addressed memory document.
MemoryStoreDto记录recordio.agentscope.builder.web.managed
承载记忆存储 Dto数据的记录类型。
API representation of a cross-session memory store.
MemoryVersionDto记录recordio.agentscope.builder.web.managed
承载记忆版本 Dto数据的记录类型。
API representation of an immutable memory document version.
ResourceShareDto记录recordio.agentscope.builder.web.managed
承载资源 Share Dto数据的记录类型。
API view of a `io.agentscope.builder.web.persistence.jpa.ResourceShareEntity` grant.
SessionAgentBuildSpec记录recordio.agentscope.builder.web.managed
承载会话智能体构建规格数据的记录类型。
Runtime build parameters for a managed-session `io.agentscope.harness.agent.HarnessAgent`.
SessionEventDto记录recordio.agentscope.builder.web.managed
承载会话事件 Dto数据的记录类型。
API representation of a single append-only session event.
SessionEventTypes类classio.agentscope.builder.web.managed
会话事件类型，承载智能体的部署、调度与服务化运行。
Canonical session event type names (persisted + stream-only).
SessionStatuses类classio.agentscope.builder.web.managed
会话 Statuses，承载智能体的部署、调度与服务化运行。
Shared session status vocabulary.
VaultCredentialDto记录recordio.agentscope.builder.web.managed
承载 Vault 凭证 Dto数据的记录类型。
API representation of a vault credential entry (no plaintext).
VaultDto记录recordio.agentscope.builder.web.managed
承载 Vault Dto数据的记录类型。
API representation of a credential vault (no secrets).
SessionInputStager类classio.agentscope.builder.web.managed.selfhosted
会话输入 Stager，承载智能体的部署、调度与服务化运行。
Stages session metadata / resource file references into a worker workspace.
AgentVersionService类classio.agentscope.builder.web.managed.service
智能体版本服务，承载智能体的部署、调度与服务化运行。
Manages immutable version snapshots for user-custom agents.
DeletedSessionRegistry类classio.agentscope.builder.web.managed.service
已删除会话注册表，承载智能体的部署、调度与服务化运行。
Tracks sessions that were deleted while work was still in flight.
HandsMetrics类classio.agentscope.builder.web.managed.service
Hands 指标，承载智能体的部署、调度与服务化运行。
Per-session hands-lease counters: acquires, releases, and acquire timeouts.
ManagedJsonHelper类classio.agentscope.builder.web.managed.service
托管 JSON Helper，承载智能体的部署、调度与服务化运行。
Shared JSON and identifier helpers for the managed-agents service layer.
MemoryStoreService类classio.agentscope.builder.web.managed.service
记忆存储服务，承载智能体的部署、调度与服务化运行。
CRUD for memory stores and versioned memory documents.
SessionEventLog类classio.agentscope.builder.web.managed.service
会话事件日志，承载智能体的部署、调度与服务化运行。
Append-only session event log.
SessionEventMirror接口interfaceio.agentscope.builder.web.managed.service
定义会话事件镜像契约的接口。
Best-effort observer used to project persisted managed events to another read model.
SessionEventNotifier类classio.agentscope.builder.web.managed.service
会话事件 Notifier，承载智能体的部署、调度与服务化运行。
Wakes session-event readers without continuously polling the event table.
VaultCrypto类classio.agentscope.builder.web.managed.service
Vault Crypto，承载智能体的部署、调度与服务化运行。
AES-GCM encryption for vault credential payloads.
VaultService类classio.agentscope.builder.web.managed.service
Vault 服务，承载智能体的部署、调度与服务化运行。
CRUD for credential vaults with encrypted secret storage.
AgentEntity类classio.agentscope.builder.web.persistence.jpa
智能体 Entity，在多次调用之间保存和恢复会话与记忆数据。
Persistent representation of a user-custom agent definition.
AgentEntityRepository接口interfaceio.agentscope.builder.web.persistence.jpa
定义智能体 Entity 仓库契约的接口。
Spring Data repository for `AgentEntity`.
AgentShareEntity类classio.agentscope.builder.web.persistence.jpa
智能体 Share Entity，在多次调用之间保存和恢复会话与记忆数据。
Persistent representation of one `io.agentscope.builder.web.share.AgentShareGrant`.
AgentStateEntity类classio.agentscope.builder.web.persistence.jpa
智能体状态 Entity，在多次调用之间保存和恢复会话与记忆数据。
One row of persisted `io.agentscope.core.state.AgentStateStore` data.
AgentStateEntityRepository接口interfaceio.agentscope.builder.web.persistence.jpa
定义智能体状态 Entity 仓库契约的接口。
Spring Data repository for `AgentStateEntity`.
AgentVersionEntity类classio.agentscope.builder.web.persistence.jpa
智能体版本 Entity，在多次调用之间保存和恢复会话与记忆数据。
Immutable configuration snapshot for one version of a user-custom agent.
AgentVersionEntityRepository接口interfaceio.agentscope.builder.web.persistence.jpa
定义智能体版本 Entity 仓库契约的接口。
Spring Data repository for `AgentVersionEntity`.
CoordHitlTicketEntity类classio.agentscope.builder.web.persistence.jpa
Coord Hitl Ticket Entity，在多次调用之间保存和恢复会话与记忆数据。
Shared HITL tool-confirmation tickets.
CoordHitlTicketEntityRepository接口interfaceio.agentscope.builder.web.persistence.jpa
定义 Coord Hitl Ticket Entity 仓库契约的接口。
An interface in io.agentscope.builder.web.persistence.jpa that defines the contract for components that persists and restores session and memory data across calls.
CoordLeaseEntity类classio.agentscope.builder.web.persistence.jpa
Coord Lease Entity，在多次调用之间保存和恢复会话与记忆数据。
Shared lease rows: turn ownership and deployment fire windows.
CoordLeaseEntityRepository接口interfaceio.agentscope.builder.web.persistence.jpa
定义 Coord Lease Entity 仓库契约的接口。
An interface in io.agentscope.builder.web.persistence.jpa that defines the contract for components that persists and restores session and memory data across calls.
CoordWorkItemEntity类classio.agentscope.builder.web.persistence.jpa
Coord Work 条目 Entity，在多次调用之间保存和恢复会话与记忆数据。
Durable hands work-queue rows + sandbox-ready metadata.
CoordWorkItemEntityRepository接口interfaceio.agentscope.builder.web.persistence.jpa
定义 Coord Work 条目 Entity 仓库契约的接口。
An interface in io.agentscope.builder.web.persistence.jpa that defines the contract for components that persists and restores session and memory data across calls.
CoordWorkerHeartbeatEntity类classio.agentscope.builder.web.persistence.jpa
Coord 工作进程心跳 Entity，在多次调用之间保存和恢复会话与记忆数据。
Last-seen heartbeat for environment workers.
CoordWorkerHeartbeatEntityRepository接口interfaceio.agentscope.builder.web.persistence.jpa
定义 Coord 工作进程心跳 Entity 仓库契约的接口。
An interface in io.agentscope.builder.web.persistence.jpa that defines the contract for components that persists and restores session and memory data across calls.
DeploymentEntity类classio.agentscope.builder.web.persistence.jpa
部署 Entity，在多次调用之间保存和恢复会话与记忆数据。
A deployment binds an agent (optionally pinned to a version) and an execution environment to a trigger — `cron`, `webhook`, or `manual` — so it can be fired automatically or on demand without a human driving a chat session.
DeploymentEntityRepository接口interfaceio.agentscope.builder.web.persistence.jpa
定义部署 Entity 仓库契约的接口。
Spring Data repository for `DeploymentEntity`.
EnvironmentEntity类classio.agentscope.builder.web.persistence.jpa
环境 Entity，在多次调用之间保存和恢复会话与记忆数据。
Execution-environment template (local / sandbox / remote).
EnvironmentEntityRepository接口interfaceio.agentscope.builder.web.persistence.jpa
定义环境 Entity 仓库契约的接口。
Spring Data repository for `EnvironmentEntity`.
JpaAgentStateStore类classio.agentscope.builder.web.persistence.jpa
JPA 智能体状态存储，负责持久化与读取数据。
Database-backed `AgentStateStore` for agentscope-builder.
JpaPersistenceConfig类classio.agentscope.builder.web.persistence.jpa
JPA 持久化配置，保存相关配置项。
Wires the JPA-backed `UserStore` and `UserAgentDefinitionStore`.
JpaUserAgentDefinitionStore类classio.agentscope.builder.web.persistence.jpa
JPA 用户智能体定义存储，负责持久化与读取数据。
JPA-backed `UserAgentDefinitionStore`.
JpaUserStore类classio.agentscope.builder.web.persistence.jpa
JPA 用户存储，负责持久化与读取数据。
JPA-backed `UserStore`.
ManagedSessionEntity类classio.agentscope.builder.web.persistence.jpa
托管会话 Entity，在多次调用之间保存和恢复会话与记忆数据。
Managed-Agents-style session: pairs an agent reference with an environment and tracks status via an append-only event log (`SessionEventEntity`).
ManagedSessionEntityRepository接口interfaceio.agentscope.builder.web.persistence.jpa
定义托管会话 Entity 仓库契约的接口。
Spring Data repository for `ManagedSessionEntity`.
MemoryEntity类classio.agentscope.builder.web.persistence.jpa
记忆 Entity，在多次调用之间保存和恢复会话与记忆数据。
Path-addressed memory document inside a `MemoryStoreEntity`.
MemoryEntityRepository接口interfaceio.agentscope.builder.web.persistence.jpa
定义记忆 Entity 仓库契约的接口。
Spring Data repository for `MemoryEntity`.
MemoryStoreEntity类classio.agentscope.builder.web.persistence.jpa
记忆存储 Entity，在多次调用之间保存和恢复会话与记忆数据。
Cross-session memory store (mounted into a session sandbox as a directory).
MemoryStoreEntityRepository接口interfaceio.agentscope.builder.web.persistence.jpa
定义记忆存储 Entity 仓库契约的接口。
Spring Data repository for `MemoryStoreEntity`.
MemoryVersionEntity类classio.agentscope.builder.web.persistence.jpa
记忆版本 Entity，在多次调用之间保存和恢复会话与记忆数据。
Immutable version of a memory document for audit / point-in-time recovery.
MemoryVersionEntityRepository接口interfaceio.agentscope.builder.web.persistence.jpa
定义记忆版本 Entity 仓库契约的接口。
Spring Data repository for `MemoryVersionEntity`.
ResourceShareEntity类classio.agentscope.builder.web.persistence.jpa
资源 Share Entity，在多次调用之间保存和恢复会话与记忆数据。
A single sharing grant on a non-agent managed resource (environment / memory store / vault).
ResourceShareEntityRepository接口interfaceio.agentscope.builder.web.persistence.jpa
定义资源 Share Entity 仓库契约的接口。
Spring Data repository for `ResourceShareEntity`.
SessionEventEntity类classio.agentscope.builder.web.persistence.jpa
会话事件 Entity，在多次调用之间保存和恢复会话与记忆数据。
Append-only event row for a managed session (`domain.action` naming).
SessionEventEntityRepository接口interfaceio.agentscope.builder.web.persistence.jpa
定义会话事件 Entity 仓库契约的接口。
Spring Data repository for `SessionEventEntity`.
UserEntity类classio.agentscope.builder.web.persistence.jpa
用户 Entity，在多次调用之间保存和恢复会话与记忆数据。
Persistent representation of a builder user.
UserEntityRepository接口interfaceio.agentscope.builder.web.persistence.jpa
定义用户 Entity 仓库契约的接口。
Spring Data repository for `UserEntity`.
UserMarketplaceEntity类classio.agentscope.builder.web.persistence.jpa
用户市场 Entity，在多次调用之间保存和恢复会话与记忆数据。
Persistent representation of a single user-owned skill marketplace.
UserMarketplaceRepository接口interfaceio.agentscope.builder.web.persistence.jpa
定义用户市场仓库契约的接口。
Spring Data repository for `UserMarketplaceEntity`.
VaultCredentialEntity类classio.agentscope.builder.web.persistence.jpa
Vault 凭证 Entity，在多次调用之间保存和恢复会话与记忆数据。
Encrypted credential entry inside a `VaultEntity`.
VaultCredentialEntityRepository接口interfaceio.agentscope.builder.web.persistence.jpa
定义 Vault 凭证 Entity 仓库契约的接口。
Spring Data repository for `VaultCredentialEntity`.
VaultEntity类classio.agentscope.builder.web.persistence.jpa
Vault Entity，在多次调用之间保存和恢复会话与记忆数据。
Per-end-user credential vault referenced by sessions via vault_ids.
VaultEntityRepository接口interfaceio.agentscope.builder.web.persistence.jpa
定义 Vault Entity 仓库契约的接口。
Spring Data repository for `VaultEntity`.
AgentAccessGuard类classio.agentscope.builder.web.share
智能体访问守卫，承载智能体的部署、调度与服务化运行。
Convenience gate for controllers: resolve an agent by id (across globals, own, shared-in) and verify the caller holds at least the required tier.
AgentAclService类classio.agentscope.builder.web.share
智能体 Acl 服务，承载智能体的部署、调度与服务化运行。
Single source of truth for per-agent permissions.
AgentShareGrant记录recordio.agentscope.builder.web.share
承载智能体 Share Grant数据的记录类型。
A single sharing grant on an agent.
AgentVisibilityResolver接口interfaceio.agentscope.builder.web.share
定义智能体 Visibility 解析器契约的接口。
Resolves whether an agent is visible to a user and returns its definition.
JpaAgentVisibilityResolver类classio.agentscope.builder.web.share
JPA 智能体 Visibility 解析器，承载智能体的部署、调度与服务化运行。
JPA-only `AgentVisibilityResolver`: a read view over the shared database, usable by any plane that does not own the file-backed catalog (data plane, scheduler).
ResourceAccessService类classio.agentscope.builder.web.share
资源访问服务，承载智能体的部署、调度与服务化运行。
Generic owner-or-shared access control for non-agent managed resources (environments, memory stores, vaults).
ShareRequest记录recordio.agentscope.builder.web.share
承载 Share 请求数据的记录类型。
Request body for granting a `ResourceAccessService` share on a non-agent managed resource (environment / memory store / vault).
SharedWorkspacePaths类classio.agentscope.builder.web.workspace
共享工作区 Paths，承载智能体的部署、调度与服务化运行。
Resolves on-disk paths derived from the platform-wide shared workspace root, without composing any filesystem instances.