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

agentscope-admin-spring-boot-starter

AgentScope Java - Admin Ops Spring Boot Starter · 2.0.4

Spring Boot starter exposing admin/ops REST + Actuator endpoints for AgentScope agents

groupIdGroupIdio.agentscope
版本Version2.0.4
版本线Line2.x
分类Categorystarter
包Packages13
类型Types45 top-level / 49 total

包Packages

io.agentscope.spring.boot.admin1
io.agentscope.spring.boot.admin.audit2
io.agentscope.spring.boot.admin.command4
io.agentscope.spring.boot.admin.controller2
io.agentscope.spring.boot.admin.dto6
io.agentscope.spring.boot.admin.endpoint11
io.agentscope.spring.boot.admin.metrics3
io.agentscope.spring.boot.admin.openapi1
io.agentscope.spring.boot.admin.properties1
io.agentscope.spring.boot.admin.registry4
io.agentscope.spring.boot.admin.service5
io.agentscope.spring.boot.admin.snapshot2
io.agentscope.spring.boot.admin.subagent3

类型Types

类型Type种类Kind包Package说明Description
AgentscopeAdminAutoConfiguration类classio.agentscope.spring.boot.admin
Agentscope 管理台 Auto 配置,保存相关配置项。
Spring Boot auto-configuration for the AgentScope admin/ops starter.
AdminAuditEvent记录recordio.agentscope.spring.boot.admin.audit
承载管理台 Audit 事件数据的记录类型。
Immutable audit record for one admin operation.
AdminAuditLogger类classio.agentscope.spring.boot.admin.audit
管理台 Audit 日志记录器,承载智能体的部署、调度与服务化运行。
Default audit sink: logs at INFO via SLF4J and (optionally) republishes the record as a Spring `ApplicationEvent` so other components can subscribe with `@EventListener`.
AdminCommand记录recordio.agentscope.spring.boot.admin.command
承载管理台命令数据的记录类型。
Self-describing record of an admin operation exposed by this starter.
AdminCommandRegistry类classio.agentscope.spring.boot.admin.command
管理台命令注册表,承载智能体的部署、调度与服务化运行。
Thread-safe registry of `AdminCommand` instances.
BuiltinCommandRegistrar类classio.agentscope.spring.boot.admin.command
内置命令 Registrar,承载智能体的部署、调度与服务化运行。
Registers the Phase-1 built-in `AdminCommand`s into the `AdminCommandRegistry`.
CommandPlane枚举enumio.agentscope.spring.boot.admin.command
定义命令 Plane相关取值的枚举。
Which physical surface a command lives on.
SessionAdminController类classio.agentscope.spring.boot.admin.controller
会话管理台控制器,承载智能体的部署、调度与服务化运行。
Data-plane REST surface.
SubagentTaskController类classio.agentscope.spring.boot.admin.controller
子智能体任务控制器,承载智能体的部署、调度与服务化运行。
Data-plane REST for `BackgroundTask`s dispatched to subagents via `TaskRepository`.
AgentTaskView记录recordio.agentscope.spring.boot.admin.dto
承载智能体任务 View数据的记录类型。
Read-only wire view of `Task` (the per-`io.agentscope.core.state.AgentState` task record — the TodoWrite-style work-item list that an agent maintains for itself).
CompactRequest记录recordio.agentscope.spring.boot.admin.dto
用于`POST /v1/admin/sessions/{id}:compact`的请求正文。
Request body for `POST /v1/admin/sessions/{id}:compact`.
CompactResponse记录recordio.agentscope.spring.boot.admin.dto
用于`POST /v1/admin/sessions/{id}:compact`的响应正文。
Response body for `POST /v1/admin/sessions/{id}:compact`.
MessageView记录recordio.agentscope.spring.boot.admin.dto
承载消息 View数据的记录类型。
Slim projection of a `io.agentscope.core.message.Msg` for admin listings.
PlanModeView记录recordio.agentscope.spring.boot.admin.dto
承载计划模式 View数据的记录类型。
Wire view of `PlanModeContextState`, plus a server-side flag indicating whether the `PlanModeMiddleware` was wired into the agent at build time.
SubagentTaskView记录recordio.agentscope.spring.boot.admin.dto
承载子智能体任务 View数据的记录类型。
Wire view of a `BackgroundTask` dispatched to a subagent.
AgentscopeAgentsEndpoint类classio.agentscope.spring.boot.admin.endpoint
Agentscope 智能体端点,承载智能体的部署、调度与服务化运行。
`GET /actuator/agentscope-agents`: enumerate agents known to the registry.
AgentscopeCommandsEndpoint类classio.agentscope.spring.boot.admin.endpoint
Agentscope Commands 端点,承载智能体的部署、调度与服务化运行。
`GET /actuator/agentscope-commands`: machine-readable catalog of every admin command exposed by this process.
AgentscopeDoctorEndpoint类classio.agentscope.spring.boot.admin.endpoint
Agentscope Doctor 端点,承载智能体的部署、调度与服务化运行。
`GET /actuator/agentscope-doctor`: opinionated self-check.
AgentscopeDrainEndpoint类classio.agentscope.spring.boot.admin.endpoint
Agentscope Drain 端点,承载智能体的部署、调度与服务化运行。
`POST /actuator/agentscope-drain`: stop accepting new agent requests, wait for in-flight ones to finish, but do NOT terminate the JVM.
AgentscopeModelsEndpoint类classio.agentscope.spring.boot.admin.endpoint
Agentscope 模型端点,承载智能体的部署、调度与服务化运行。
`GET /actuator/agentscope-models`: {beanName -> modelName} map.
AgentscopePermissionsEndpoint类classio.agentscope.spring.boot.admin.endpoint
Agentscope 权限端点,承载智能体的部署、调度与服务化运行。
`GET /actuator/agentscope-permissions`: enumerate the permission posture of every registered `ReActAgent`.
AgentscopeShutdownEndpoint类classio.agentscope.spring.boot.admin.endpoint
Agentscope Shutdown 端点,承载智能体的部署、调度与服务化运行。
`POST /actuator/agentscope-shutdown`: drain, then schedule a JVM-level shutdown.
AgentscopeStatusEndpoint类classio.agentscope.spring.boot.admin.endpoint
Agentscope 状态端点,承载智能体的部署、调度与服务化运行。
`GET /actuator/agentscope-status`: process-wide health summary.
AgentscopeSubagentsEndpoint类classio.agentscope.spring.boot.admin.endpoint
Agentscope Subagents 端点,承载智能体的部署、调度与服务化运行。
`GET /actuator/agentscope-subagents`: enumerate the registered subagents.
AgentscopeToolsEndpoint类classio.agentscope.spring.boot.admin.endpoint
已注册工具的`GET /actuator/agentscope-tools`:per-工具包-bean 列出。
`GET /actuator/agentscope-tools`: per-Toolkit-bean list of registered tools.
AgentscopeUsageEndpoint类classio.agentscope.spring.boot.admin.endpoint
Agentscope 用量端点,承载智能体的部署、调度与服务化运行。
`GET /actuator/agentscope-usage`: process-cumulative token usage, sliced both by agent name and by model name.
MetricsHook类classio.agentscope.spring.boot.admin.metrics
指标钩子,承载智能体的部署、调度与服务化运行。
Legacy `Hook` that observes `PostCallEvent` and forwards the per-call token usage to a `MetricsRecorder`.
MetricsRecorder类classio.agentscope.spring.boot.admin.metrics
指标记录器,承载智能体的部署、调度与服务化运行。
Thread-safe accumulator for token usage counters, sliced by agent name and by model name.
UsageStats记录recordio.agentscope.spring.boot.admin.metrics
承载用量 Stats数据的记录类型。
Immutable snapshot of accumulated usage counters for a single bucket (agent or model).
AdminOpenApiConfiguration类classio.agentscope.spring.boot.admin.openapi
管理台打开 API 配置,保存相关配置项。
Wires the admin starter into springdoc-openapi *only when springdoc is on the classpath*.
AdminProperties类classio.agentscope.spring.boot.admin.properties
管理台属性,承载智能体的部署、调度与服务化运行。
Configuration properties for the AgentScope admin/ops starter.
AgentDescriptor记录recordio.agentscope.spring.boot.admin.registry
承载智能体描述符数据的记录类型。
Lightweight projection of an `Agent` for inventory views.
AgentRegistry接口interfaceio.agentscope.spring.boot.admin.registry
定义智能体注册表契约的接口。
SPI for tracking live agents the admin surface can inspect or act on.
AgentResolver类classio.agentscope.spring.boot.admin.registry
智能体解析器,承载智能体的部署、调度与服务化运行。
Small unwrap helper that hides the `HarnessAgent` composition from admin call sites.
InMemoryAgentRegistry类classio.agentscope.spring.boot.admin.registry
In 记忆智能体注册表,承载智能体的部署、调度与服务化运行。
Single-node, in-memory `AgentRegistry` suitable as the starter default.
AgentInventory类classio.agentscope.spring.boot.admin.service
智能体清单,承载智能体的部署、调度与服务化运行。
Aggregates inventory information across `AgentRegistry`, Spring-managed `Toolkit` and `Model` beans, and the `GracefulShutdownManager`.
ModelSummarizationStrategy类classio.agentscope.spring.boot.admin.service
模型 Summarization Strategy,承载智能体的部署、调度与服务化运行。
Default `SummarizationStrategy` that asks the agent's own model to produce a fresh rolling summary.
SessionOperations类classio.agentscope.spring.boot.admin.service
会话 Operations,承载智能体的部署、调度与服务化运行。
Business logic for the per-session data-plane admin actions.
SubagentTaskOperations类classio.agentscope.spring.boot.admin.service
子智能体任务 Operations,承载智能体的部署、调度与服务化运行。
Read/cancel operations over a `TaskRepository`-managed pool of subagent background tasks.
SummarizationStrategy接口interfaceio.agentscope.spring.boot.admin.service
定义 Summarization Strategy契约的接口。
Strategy for the `session:compact` action.
AgentStateRestorer类classio.agentscope.spring.boot.admin.snapshot
智能体状态 Restorer,承载智能体的部署、调度与服务化运行。
Copies the mutable fields of a snapshotted `AgentState` back into a live one.
SnapshotStore类classio.agentscope.spring.boot.admin.snapshot
快照存储,负责持久化与读取数据。
In-memory undo/redo stacks per session.
SpringSubagentInventory类classio.agentscope.spring.boot.admin.subagent
Spring 子智能体清单,支持智能体之间的发现、委派与协作。
Default `SubagentInventory` that scans the Spring context for any user-declared `SubagentEntry` or `SubagentDeclaration` beans.
SubagentDescriptor记录recordio.agentscope.spring.boot.admin.subagent
承载子智能体描述符数据的记录类型。
Wire view of a registered subagent — flattens whichever projection (a `SubagentEntry` from a built agent, or a `SubagentDeclaration` loaded from a yaml/markdown spec) the inventory adapter happens to hold.
SubagentInventory接口interfaceio.agentscope.spring.boot.admin.subagent
定义子智能体清单契约的接口。
SPI for enumerating the subagents available to this process.