接口interface io.agentscope.extensions.aistio 2.x

FrameworkAdapter

public interface FrameworkAdapter

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:41–181

定义 Framework 适配器契约的接口。位于 io.agentscope.extensions.aistio 包。核心成员包括 frameworkName、frameworkVersion、canHandle、attach、detach、onBridgeAttached。

One adapter per agent framework, presenting a uniform view of that framework's sessions to SessionBridge. The Java counterpart of the Python SDK's FrameworkAdapter.

Bypass principle: interception copies data, it never replaces or blocks the framework's own path, and a failed report is swallowed rather than propagated. An instrumented agent must behave exactly as an uninstrumented one.

Optional operations default to failing with UnsupportedOperationException. Declare only what you actually implement in #capabilities() — the control plane gates its UI on that list, so over-declaring produces buttons that fail.

字段摘要Field Summary

字段Field	类型Type	说明Description
`CAP_CONTEXT_QUERY`	String	CAP 上下文查询字段。 The CAP CONTEXT QUERY field.
`CAP_MESSAGE_QUERY`	String	CAP 消息查询字段。 The CAP MESSAGE QUERY field.
`CAP_SUBAGENT_INVENTORY`	String	CAP 子智能体清单字段。 The CAP SUBAGENT INVENTORY field.
`CAP_WORKSPACE_INVENTORY`	String	CAP 工作区清单字段。 The CAP WORKSPACE INVENTORY field.
`CAP_SESSION_COMMAND`	String	CAP 会话命令字段。 The CAP SESSION COMMAND field.
`CAP_SESSION_ABORT`	String	CAP 会话中止字段。 The CAP SESSION ABORT field.
`CAP_TASK_QUERY`	String	CAP 任务查询字段。 The CAP TASK QUERY field.
`CAP_SUBAGENT_TASK_QUERY`	String	CAP 子智能体任务查询字段。 The CAP SUBAGENT TASK QUERY field.
`CAP_SUBAGENT_TASK_COMMAND`	String	CAP 子智能体任务命令字段。 The CAP SUBAGENT TASK COMMAND field.
`CAP_PLAN_MODE`	String	CAP 计划模式字段。 The CAP PLAN MODE field.
`CAP_AGENT_TASK`	String	CAP 智能体任务字段。 The CAP AGENT TASK field.
`CAP_EXPORT_TRANSCRIPT`	String	CAP EXPORT TRANSCRIPT字段。 The CAP EXPORT TRANSCRIPT field.
`CAP_CONVERSATION_INBOUND`	String	CAP 会话入站字段。 The CAP CONVERSATION INBOUND field.
`COMMAND_COMPRESS`	String	命令压缩字段。 The COMMAND COMPRESS field.
`COMMAND_TERMINATE`	String	命令 TERMINATE字段。 The COMMAND TERMINATE field.
`COMMAND_ABORT`	String	命令中止字段。 The COMMAND ABORT field.

方法摘要Method Summary

方法Method	说明Description
`public String frameworkName()`	返回 `frameworkName` 结果。 Framework identifier reported on every snapshot, e.g.
`default public String frameworkVersion()` default	返回 `frameworkVersion` 结果。 Framework version, or an empty string when it cannot be determined.
`public boolean canHandle(Object target)`	判断是否可以 `canHandle`。 Whether this adapter can instrument `target`.
`public void attach(Object target, Consumer<SessionEvent> emit)`	执行 `attach` 方法。 Attaches to the framework object.
`public void detach()`	执行 `detach` 方法。 Removes the interception and restores the framework object.
`default public void onBridgeAttached(SessionBridge bridge)` default	处理 `onBridgeAttached` 事件。 Called once the adapter is mounted, giving it a handle for metadata the event stream cannot carry — system prompt, tool list, context window — via `SessionBridge#describeSession`.
`public Mono<ContextSnapshot> extractContext(String sessionId)`	设置该参数。 Level 4: the context that the session's next model call will actually see.
`default public Mono<MessagePage> listMessages(String sessionId, int offset, int limit)` default	列出消息。 Level 3: full history including messages already compacted away.
`default public Mono<List<Inventory.SubagentInfo>> listSubagents()` default	列出 `listSubagents`。 Lists the subagents.
`default public Mono<List<Inventory.WorkspaceInfo>> listWorkspaces()` default	列出 `listWorkspaces`。 Lists the workspaces.
`default public Mono<List<Map<String, Object>>> listTasks(String sessionId)` default	用于`GET .../tasks`的会话任务列出。 Session task list for `GET .../tasks`.
`default public Mono<List<Map<String, Object>>> listSubagentTasks(String sessionId)` default	列出子智能体任务。 Background subagent tasks for `GET .../subagent-tasks` (not todolist).
`default public Mono<Void> cancelSubagentTask(String sessionId, String taskId)` default	执行取消子智能体任务相关操作。 Cancel one background subagent task.
`default public Mono<Void> setPlanMode(String sessionId, byte[] params)` default	设置计划模式。 Enter or exit plan mode for the session.
`default public Mono<Void> injectUserMessage(String sessionId, String content)` default	执行 `injectUserMessage` 方法。 Inject a console/control-plane user message into the live session.
`default public Mono<String> runConversationTurn(String sessionId, String content)` default	运行会话轮次。 Run a control-plane conversation turn and return its terminal assistant reply.
`default public Map<String, Object> buildAgentConfig()` default	构建智能体配置。 Effective Definition snapshot for `GET /agentscope/info` → `agentConfig`.
`default public Mono<Void> handleCommand(String sessionId, String command, byte[] params)` default	处理命令。 Executes `#COMMAND_COMPRESS`, `#COMMAND_TERMINATE`, or `#COMMAND_ABORT` against the session.
`default public Mono<Void> handleAgentTask(AgentTaskAssignment assignment)` default	处理智能体任务。 Materializes a downstream AgentTask delivery as an isolated execution.
`default public Set<String> capabilities()` default	返回能力。 Capabilities contributed by this adapter.

字段详情Field Detail

CAP_CONTEXT_QUERY

String CAP_CONTEXT_QUERY

CAP 上下文查询字段。声明为 String CAP_CONTEXT_QUERY。

The CAP CONTEXT QUERY field.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:43

CAP_MESSAGE_QUERY

String CAP_MESSAGE_QUERY

CAP 消息查询字段。声明为 String CAP_MESSAGE_QUERY。

The CAP MESSAGE QUERY field.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:44

CAP_SUBAGENT_INVENTORY

String CAP_SUBAGENT_INVENTORY

CAP 子智能体清单字段。声明为 String CAP_SUBAGENT_INVENTORY。

The CAP SUBAGENT INVENTORY field.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:45

CAP_WORKSPACE_INVENTORY

String CAP_WORKSPACE_INVENTORY

CAP 工作区清单字段。声明为 String CAP_WORKSPACE_INVENTORY。

The CAP WORKSPACE INVENTORY field.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:46

CAP_SESSION_COMMAND

String CAP_SESSION_COMMAND

CAP 会话命令字段。声明为 String CAP_SESSION_COMMAND。

The CAP SESSION COMMAND field.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:47

CAP_SESSION_ABORT

String CAP_SESSION_ABORT

CAP 会话中止字段。声明为 String CAP_SESSION_ABORT。

The CAP SESSION ABORT field.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:48

CAP_TASK_QUERY

String CAP_TASK_QUERY

CAP 任务查询字段。声明为 String CAP_TASK_QUERY。

The CAP TASK QUERY field.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:49

CAP_SUBAGENT_TASK_QUERY

String CAP_SUBAGENT_TASK_QUERY

CAP 子智能体任务查询字段。声明为 String CAP_SUBAGENT_TASK_QUERY。

The CAP SUBAGENT TASK QUERY field.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:50

CAP_SUBAGENT_TASK_COMMAND

String CAP_SUBAGENT_TASK_COMMAND

CAP 子智能体任务命令字段。声明为 String CAP_SUBAGENT_TASK_COMMAND。

The CAP SUBAGENT TASK COMMAND field.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:51

CAP_PLAN_MODE

String CAP_PLAN_MODE

CAP 计划模式字段。声明为 String CAP_PLAN_MODE。

The CAP PLAN MODE field.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:52

CAP_AGENT_TASK

String CAP_AGENT_TASK

CAP 智能体任务字段。声明为 String CAP_AGENT_TASK。

The CAP AGENT TASK field.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:53

CAP_EXPORT_TRANSCRIPT

String CAP_EXPORT_TRANSCRIPT

CAP EXPORT TRANSCRIPT字段。声明为 String CAP_EXPORT_TRANSCRIPT。

The CAP EXPORT TRANSCRIPT field.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:54

CAP_CONVERSATION_INBOUND

String CAP_CONVERSATION_INBOUND

CAP 会话入站字段。声明为 String CAP_CONVERSATION_INBOUND。

The CAP CONVERSATION INBOUND field.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:55

COMMAND_COMPRESS

String COMMAND_COMPRESS

命令压缩字段。声明为 String COMMAND_COMPRESS。

The COMMAND COMPRESS field.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:57

COMMAND_TERMINATE

String COMMAND_TERMINATE

命令 TERMINATE字段。声明为 String COMMAND_TERMINATE。

The COMMAND TERMINATE field.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:58

COMMAND_ABORT

String COMMAND_ABORT

命令中止字段。声明为 String COMMAND_ABORT。

The COMMAND ABORT field.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:59

方法详情Method Detail

frameworkName

public String frameworkName()

返回 frameworkName 结果。

Framework identifier reported on every snapshot, e.g.

返回Returns String

返回字符串结果。Returns a string.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:62

frameworkVersion

default public String frameworkVersion()

default

返回 frameworkVersion 结果。

Framework version, or an empty string when it cannot be determined.

返回Returns String

返回字符串结果。Returns a string.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:65–67

canHandle

public boolean canHandle(Object target)

判断是否可以 canHandle。

Whether this adapter can instrument target.

参数Parameters

名称Name	类型Type	说明Description
`target`	Object	目标（类型 `Object`）。The target.

返回Returns boolean

返回布尔值，表示判断结果。Returns a boolean result.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:70

attach

public void attach(Object target, Consumer<SessionEvent> emit)

执行 attach 方法。

Attaches to the framework object.

参数Parameters

名称Name	类型Type	说明Description
`target`	Object	目标（类型 `Object`）。The target.
`emit`	Consumer<SessionEvent>	发出（类型 `Consumer`）。The emit.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:76

detach

public void detach()

执行 detach 方法。

Removes the interception and restores the framework object.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:79

onBridgeAttached

default public void onBridgeAttached(SessionBridge bridge)

default

处理 onBridgeAttached 事件。

Called once the adapter is mounted, giving it a handle for metadata the event stream cannot carry — system prompt, tool list, context window — via SessionBridge#describeSession.

参数Parameters

名称Name	类型Type	说明Description
`bridge`	SessionBridge	bridge（类型 `SessionBridge`）。The bridge.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:86–88

extractContext

public Mono<ContextSnapshot> extractContext(String sessionId)

设置该参数。

Level 4: the context that the session's next model call will actually see.

参数Parameters

名称Name	类型Type	说明Description
`sessionId`	String	会话标识（类型 `String`）。The session id.

返回Returns Mono<ContextSnapshot>

返回Mono。Returns mono.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:91

listMessages

default public Mono<MessagePage> listMessages(String sessionId, int offset, int limit)

default

列出消息。

Level 3: full history including messages already compacted away.

参数Parameters

名称Name	类型Type	说明Description
`sessionId`	String	会话标识（类型 `String`）。The session id.
`offset`	int	偏移量（类型 `int`）。The offset.
`limit`	int	数量上限（类型 `int`）。The limit.

返回Returns Mono<MessagePage>

返回Mono。Returns mono.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:94–96

listSubagents

default public Mono<List<Inventory.SubagentInfo>> listSubagents()

default

列出 listSubagents。

Lists the subagents.

返回Returns Mono<List<Inventory.SubagentInfo>>

返回Mono>。Returns mono.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:98–100

listWorkspaces

default public Mono<List<Inventory.WorkspaceInfo>> listWorkspaces()

default

列出 listWorkspaces。

Lists the workspaces.

返回Returns Mono<List<Inventory.WorkspaceInfo>>

返回Mono>。Returns mono.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:102–104

listTasks

default public Mono<List<Map<String, Object>>> listTasks(String sessionId)

default

用于GET .../tasks的会话任务列出。

Session task list for GET .../tasks.

参数Parameters

名称Name	类型Type	说明Description
`sessionId`	String	会话标识（类型 `String`）。The session id.

返回Returns Mono<List<Map<String, Object>>>

返回Mono>>。Returns mono.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:111–113

listSubagentTasks

default public Mono<List<Map<String, Object>>> listSubagentTasks(String sessionId)

default

列出子智能体任务。

Background subagent tasks for GET .../subagent-tasks (not todolist).

参数Parameters

名称Name	类型Type	说明Description
`sessionId`	String	会话标识（类型 `String`）。The session id.

返回Returns Mono<List<Map<String, Object>>>

返回Mono>>。Returns mono.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:119–121

cancelSubagentTask

default public Mono<Void> cancelSubagentTask(String sessionId, String taskId)

default

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

Cancel one background subagent task.

参数Parameters

名称Name	类型Type	说明Description
`sessionId`	String	会话标识（类型 `String`）。The session id.
`taskId`	String	任务标识（类型 `String`）。The task id.

返回Returns Mono<Void>

返回Mono。Returns mono.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:124–126

setPlanMode

default public Mono<Void> setPlanMode(String sessionId, byte[] params)

default

设置计划模式。

Enter or exit plan mode for the session.

参数Parameters

名称Name	类型Type	说明Description
`sessionId`	String	会话标识（类型 `String`）。The session id.
`params`	byte[]	参数（类型 `byte[]`）。The params.

返回Returns Mono<Void>

返回Mono。Returns mono.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:132–134

injectUserMessage

default public Mono<Void> injectUserMessage(String sessionId, String content)

default

执行 injectUserMessage 方法。

Inject a console/control-plane user message into the live session.

参数Parameters

名称Name	类型Type	说明Description
`sessionId`	String	会话标识（类型 `String`）。The session id.
`content`	String	内容（类型 `String`）。The content.

返回Returns Mono<Void>

返回Mono。Returns mono.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:140–142

runConversationTurn

default public Mono<String> runConversationTurn(String sessionId, String content)

default

运行会话轮次。

Run a control-plane conversation turn and return its terminal assistant reply.

参数Parameters

名称Name	类型Type	说明Description
`sessionId`	String	会话标识（类型 `String`）。The session id.
`content`	String	内容（类型 `String`）。The content.

返回Returns Mono<String>

返回Mono。Returns mono.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:148–150

buildAgentConfig

default public Map<String, Object> buildAgentConfig()

default

构建智能体配置。

Effective Definition snapshot for GET /agentscope/info → agentConfig.

返回Returns Map<String, Object>

返回映射。Returns map.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:153–155

handleCommand

default public Mono<Void> handleCommand(String sessionId, String command, byte[] params)

default

处理命令。

Executes #COMMAND_COMPRESS, #COMMAND_TERMINATE, or #COMMAND_ABORT against the session.

参数Parameters

名称Name	类型Type	说明Description
`sessionId`	String	会话标识（类型 `String`）。The session id.
`command`	String	命令（类型 `String`）。The command.
`params`	byte[]	参数（类型 `byte[]`）。The params.

返回Returns Mono<Void>

返回Mono。Returns mono.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:161–163

handleAgentTask

default public Mono<Void> handleAgentTask(AgentTaskAssignment assignment)

default

处理智能体任务。

Materializes a downstream AgentTask delivery as an isolated execution.

参数Parameters

名称Name	类型Type	说明Description
`assignment`	AgentTaskAssignment	assignment（类型 `AgentTaskAssignment`）。The assignment.

返回Returns Mono<Void>

返回Mono。Returns mono.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:166–168

capabilities

default public Set<String> capabilities()

default

返回能力。

Capabilities contributed by this adapter.

返回Returns Set<String>

返回设置。Returns set.

源码Source io/agentscope/extensions/aistio/FrameworkAdapter.java:174–176