AS AgentScopeAPI 手册 / API Reference

SessionAdminController

@RestController public class SessionAdminController
源码Source io/agentscope/spring/boot/admin/controller/SessionAdminController.java:50–298

会话管理台控制器,承载智能体的部署、调度与服务化运行。位于 io.agentscope.spring.boot.admin.controller 包。核心成员包括 listSessions、messages、stateDump、export、compact、abort。

Data-plane REST surface. Route prefix is derived from agentscope.admin.base-path (default /v1/admin).

Verbs follow Google AIP-136 (resource:action) so OpenAPI generators and CLIs can map them to idiomatic command names — e.g. POST /v1/admin/sessions/{id}:compact surfaces as session compact <id> in a downstream CLI.

构造器摘要Constructor Summary

构造器Constructor说明Description
public SessionAdminController(SessionOperations ops, ObjectProvider<AgentStateStore> sessions, AdminAuditLogger audit, AdminProperties properties)
初始化 `SessionAdminController` 实例。
Creates a new instance.

方法摘要Method Summary

方法Method说明Description
public Mono<List<String>> listSessions(String operator)
列出会话。
Lists the sessions.
public Mono<List<MessageView>> messages(String sessionId, String operator)
执行消息相关操作。
Performs the messages operation.
public Mono<String> stateDump(String sessionId, String operator)
执行 `stateDump` 方法。
Performs the state dump operation.
public Mono<ResponseEntity<String>> export(String sessionId, String operator)
执行 `export` 方法。
Performs the export operation.
public Mono<CompactResponse> compact(String sessionId, CompactRequest request, String operator, String token)
执行 `compact` 方法。
Performs the compact operation.
public Mono<ResponseEntity<Void>> abort(String sessionId, String operator, String token)
执行中止相关操作。
Performs the abort operation.
public Mono<SessionOperations.UndoResult> undo(String sessionId, String operator, String token)
执行 `undo` 方法。
Performs the undo operation.
public Mono<SessionOperations.UndoResult> redo(String sessionId, String operator, String token)
执行 `redo` 方法。
Performs the redo operation.
public Mono<PlanModeView> plan(String sessionId, String operator)
执行计划相关操作。
Performs the plan operation.
public Mono<PlanModeView> enterPlanMode(String sessionId, String operator, String token)
执行 `enterPlanMode` 方法。
Performs the enter plan mode operation.
public Mono<PlanModeView> exitPlanMode(String sessionId, String operator, String token)
执行 `exitPlanMode` 方法。
Performs the exit plan mode operation.
public Mono<List<AgentTaskView>> agentTasks(String sessionId, String operator)
执行智能体任务相关操作。
Performs the agent tasks operation.

构造器详情Constructor Detail

SessionAdminController

public SessionAdminController(SessionOperations ops, ObjectProvider<AgentStateStore> sessions, AdminAuditLogger audit, AdminProperties properties)

初始化 SessionAdminController 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
opsSessionOperationsops(类型 `SessionOperations`)。The ops.
sessionsObjectProvider<AgentStateStore>会话(类型 `ObjectProvider`)。The sessions.
auditAdminAuditLoggeraudit(类型 `AdminAuditLogger`)。The audit.
propertiesAdminProperties属性(类型 `AdminProperties`)。The properties.
源码Source io/agentscope/spring/boot/admin/controller/SessionAdminController.java:61–70

方法详情Method Detail

listSessions

public Mono<List<String>> listSessions(String operator)

列出会话。

Lists the sessions.

参数Parameters
名称Name类型Type说明Description
operatorStringoperator(类型 `String`)。The operator.
返回Returns Mono<List<String>>
返回Mono>。Returns mono.
源码Source io/agentscope/spring/boot/admin/controller/SessionAdminController.java:72–86

messages

public Mono<List<MessageView>> messages(String sessionId, String operator)

执行消息相关操作。

Performs the messages operation.

参数Parameters
名称Name类型Type说明Description
sessionIdString会话标识(类型 `String`)。The session id.
operatorStringoperator(类型 `String`)。The operator.
返回Returns Mono<List<MessageView>>
返回Mono>。Returns mono.
源码Source io/agentscope/spring/boot/admin/controller/SessionAdminController.java:88–102

stateDump

public Mono<String> stateDump(String sessionId, String operator)

执行 stateDump 方法。

Performs the state dump operation.

参数Parameters
名称Name类型Type说明Description
sessionIdString会话标识(类型 `String`)。The session id.
operatorStringoperator(类型 `String`)。The operator.
返回Returns Mono<String>
返回Mono。Returns mono.
源码Source io/agentscope/spring/boot/admin/controller/SessionAdminController.java:104–120

export

public Mono<ResponseEntity<String>> export(String sessionId, String operator)

执行 export 方法。

Performs the export operation.

参数Parameters
名称Name类型Type说明Description
sessionIdString会话标识(类型 `String`)。The session id.
operatorStringoperator(类型 `String`)。The operator.
返回Returns Mono<ResponseEntity<String>>
返回Mono>。Returns mono.
源码Source io/agentscope/spring/boot/admin/controller/SessionAdminController.java:122–144

compact

public Mono<CompactResponse> compact(String sessionId, CompactRequest request, String operator, String token)

执行 compact 方法。

Performs the compact operation.

参数Parameters
名称Name类型Type说明Description
sessionIdString会话标识(类型 `String`)。The session id.
requestCompactRequest请求(类型 `CompactRequest`)。The request.
operatorStringoperator(类型 `String`)。The operator.
tokenString令牌(类型 `String`)。The token.
返回Returns Mono<CompactResponse>
返回Mono。Returns mono.
源码Source io/agentscope/spring/boot/admin/controller/SessionAdminController.java:146–163

abort

public Mono<ResponseEntity<Void>> abort(String sessionId, String operator, String token)

执行中止相关操作。

Performs the abort operation.

参数Parameters
名称Name类型Type说明Description
sessionIdString会话标识(类型 `String`)。The session id.
operatorStringoperator(类型 `String`)。The operator.
tokenString令牌(类型 `String`)。The token.
返回Returns Mono<ResponseEntity<Void>>
返回Mono>。Returns mono.
源码Source io/agentscope/spring/boot/admin/controller/SessionAdminController.java:165–177

undo

public Mono<SessionOperations.UndoResult> undo(String sessionId, String operator, String token)

执行 undo 方法。

Performs the undo operation.

参数Parameters
名称Name类型Type说明Description
sessionIdString会话标识(类型 `String`)。The session id.
operatorStringoperator(类型 `String`)。The operator.
tokenString令牌(类型 `String`)。The token.
返回Returns Mono<SessionOperations.UndoResult>
返回Mono。Returns mono.
源码Source io/agentscope/spring/boot/admin/controller/SessionAdminController.java:179–197

redo

public Mono<SessionOperations.UndoResult> redo(String sessionId, String operator, String token)

执行 redo 方法。

Performs the redo operation.

参数Parameters
名称Name类型Type说明Description
sessionIdString会话标识(类型 `String`)。The session id.
operatorStringoperator(类型 `String`)。The operator.
tokenString令牌(类型 `String`)。The token.
返回Returns Mono<SessionOperations.UndoResult>
返回Mono。Returns mono.
源码Source io/agentscope/spring/boot/admin/controller/SessionAdminController.java:199–217

plan

public Mono<PlanModeView> plan(String sessionId, String operator)

执行计划相关操作。

Performs the plan operation.

参数Parameters
名称Name类型Type说明Description
sessionIdString会话标识(类型 `String`)。The session id.
operatorStringoperator(类型 `String`)。The operator.
返回Returns Mono<PlanModeView>
返回Mono。Returns mono.
源码Source io/agentscope/spring/boot/admin/controller/SessionAdminController.java:223–241

enterPlanMode

public Mono<PlanModeView> enterPlanMode(String sessionId, String operator, String token)

执行 enterPlanMode 方法。

Performs the enter plan mode operation.

参数Parameters
名称Name类型Type说明Description
sessionIdString会话标识(类型 `String`)。The session id.
operatorStringoperator(类型 `String`)。The operator.
tokenString令牌(类型 `String`)。The token.
返回Returns Mono<PlanModeView>
返回Mono。Returns mono.
源码Source io/agentscope/spring/boot/admin/controller/SessionAdminController.java:243–259

exitPlanMode

public Mono<PlanModeView> exitPlanMode(String sessionId, String operator, String token)

执行 exitPlanMode 方法。

Performs the exit plan mode operation.

参数Parameters
名称Name类型Type说明Description
sessionIdString会话标识(类型 `String`)。The session id.
operatorStringoperator(类型 `String`)。The operator.
tokenString令牌(类型 `String`)。The token.
返回Returns Mono<PlanModeView>
返回Mono。Returns mono.
源码Source io/agentscope/spring/boot/admin/controller/SessionAdminController.java:261–277

agentTasks

public Mono<List<AgentTaskView>> agentTasks(String sessionId, String operator)

执行智能体任务相关操作。

Performs the agent tasks operation.

参数Parameters
名称Name类型Type说明Description
sessionIdString会话标识(类型 `String`)。The session id.
operatorStringoperator(类型 `String`)。The operator.
返回Returns Mono<List<AgentTaskView>>
返回Mono>。Returns mono.
源码Source io/agentscope/spring/boot/admin/controller/SessionAdminController.java:283–297
基于官方固定版本源码静态生成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.