AS AgentScopeAPI 手册 / API Reference

TeamsMiddleware

public final class TeamsMiddleware implements HarnessRuntimeMiddleware
源码Source io/agentscope/harness/agent/middleware/TeamsMiddleware.java:55–700

Teams 中间件,在智能体执行流程中提供横切扩展。位于 io.agentscope.harness.agent.middleware 包,实现 HarnessRuntimeMiddleware。核心成员包括 bindSession、registerSession、unregisterSession、wakeupSession、wakeupTeamMember、getTools。

Injects AgentTeams context into the system prompt and exposes a role-clipped TeamTool.

Optional #wireMessageBus(MessageBus, String) pushes mailbox wakeups into the session inbox path used by InboxMiddleware.

构造器摘要Constructor Summary

构造器Constructor说明Description
public TeamsMiddleware(TeamClient teamClient, TeamContext teamContext)
初始化 `TeamsMiddleware` 实例。
Creates a new instance.

方法摘要Method Summary

方法Method说明Description
public void bindSession(String sessionId)
设置该参数。
Registers this middleware under a runtime session id for TeamEvent delivery.
public static void registerSession(String sessionId, TeamsMiddleware middleware)
static
注册会话。
Registers `sessionId` against an already-built middleware instance.
public static void unregisterSession(String sessionId)
static
注销会话。
Drops every registry entry for a session that is gone for good, so a later team reusing the same team and member names cannot wake this dead session.
public static boolean wakeupSession(String sessionId)
static
设置该参数。
Wakes the teammate bound to `sessionId`.
public static boolean wakeupSession(String sessionId, String notice)
static
执行 `wakeupSession` 方法。
Wakes the teammate bound to `sessionId`, injecting `notice` into its next turn.
public static boolean wakeupTeamMember(String teamName, String memberName)
static
执行 `wakeupTeamMember` 方法。
Wakes a teammate identified by team + member name.
public static boolean wakeupTeamMember(String teamName, String memberName, String notice)
static
执行 `wakeupTeamMember` 方法。
Wakes a teammate by team + member name, injecting `notice` into its next turn.
public List<Object> getTools()
获取工具。
Tools to register on the agent toolkit at build time.
public TeamContext teamContext()
返回团队上下文。
Returns the team context.
public TeamClient teamClient()
返回团队客户端。
Returns the team client.
public void wireMessageBus(MessageBus messageBus, String agentId)
执行 `wireMessageBus` 方法。
Wires mailbox wakeups.
public void notifyWakeup(String sessionId)
设置该参数。
Notifies this teammate session that a team event arrived (message / task settled).
public void notifyWakeup(String sessionId, String notice)
执行 `notifyWakeup` 方法。
Notifies this teammate session, injecting `notice` so the woken turn starts with the event content instead of an empty prompt.
public Flux<AgentEvent> onAgent(Agent agent, RuntimeContext ctx, AgentInput input, Function<AgentInput, Flux<AgentEvent>> next)
处理智能体事件。
Gives the lead the board as it stands when its turn starts, and settles a worker's tasks when its turn ends.
public Flux<AgentEvent> onReasoning(Agent agent, RuntimeContext ctx, ReasoningInput input, Function<ReasoningInput, Flux<AgentEvent>> next)
处理推理事件。
Performs the on reasoning operation.
public boolean hasOutstandingTeamWork()
判断是否具有 `hasOutstandingTeamWork`。
Reports whether the shared board still has non-terminal tasks, so blocking waits know that teammates are still working even when this session owns no background subagent tasks.
public static String renderTeamSection(TeamContext ctx)
static
渲染 `renderTeamSection`。
Renders the system-prompt team section (also used by BYO `team_join` kickoff).

构造器详情Constructor Detail

TeamsMiddleware

public TeamsMiddleware(TeamClient teamClient, TeamContext teamContext)

初始化 TeamsMiddleware 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
teamClientTeamClient团队客户端(类型 `TeamClient`)。The team client.
teamContextTeamContext团队上下文(类型 `TeamContext`)。The team context.
源码Source io/agentscope/harness/agent/middleware/TeamsMiddleware.java:101–109

方法详情Method Detail

bindSession

public void bindSession(String sessionId)

设置该参数。

Registers this middleware under a runtime session id for TeamEvent delivery.

参数Parameters
名称Name类型Type说明Description
sessionIdString会话标识(类型 `String`)。The session id.
源码Source io/agentscope/harness/agent/middleware/TeamsMiddleware.java:112–122

registerSession

public static void registerSession(String sessionId, TeamsMiddleware middleware)
static

注册会话。

Registers sessionId against an already-built middleware instance.

参数Parameters
名称Name类型Type说明Description
sessionIdString会话标识(类型 `String`)。The session id.
middlewareTeamsMiddleware中间件(类型 `TeamsMiddleware`)。The middleware.
源码Source io/agentscope/harness/agent/middleware/TeamsMiddleware.java:125–129

unregisterSession

public static void unregisterSession(String sessionId)
static

注销会话。

Drops every registry entry for a session that is gone for good, so a later team reusing the same team and member names cannot wake this dead session.

参数Parameters
名称Name类型Type说明Description
sessionIdString会话标识(类型 `String`)。The session id.
源码Source io/agentscope/harness/agent/middleware/TeamsMiddleware.java:139–154

wakeupSession

public static boolean wakeupSession(String sessionId)
static

设置该参数。

Wakes the teammate bound to sessionId.

参数Parameters
名称Name类型Type说明Description
sessionIdString会话标识(类型 `String`)。The session id.
返回Returns boolean
返回布尔值,表示判断结果。Returns a boolean result.
源码Source io/agentscope/harness/agent/middleware/TeamsMiddleware.java:157–159

wakeupSession

public static boolean wakeupSession(String sessionId, String notice)
static

执行 wakeupSession 方法。

Wakes the teammate bound to sessionId, injecting notice into its next turn.

参数Parameters
名称Name类型Type说明Description
sessionIdString会话标识(类型 `String`)。The session id.
noticeStringnotice(类型 `String`)。The notice.
返回Returns boolean
返回布尔值,表示判断结果。Returns a boolean result.
源码Source io/agentscope/harness/agent/middleware/TeamsMiddleware.java:162–169

wakeupTeamMember

public static boolean wakeupTeamMember(String teamName, String memberName)
static

执行 wakeupTeamMember 方法。

Wakes a teammate identified by team + member name.

参数Parameters
名称Name类型Type说明Description
teamNameString团队名称(类型 `String`)。The team name.
memberNameString成员名称(类型 `String`)。The member name.
返回Returns boolean
返回布尔值,表示判断结果。Returns a boolean result.
源码Source io/agentscope/harness/agent/middleware/TeamsMiddleware.java:172–174

wakeupTeamMember

public static boolean wakeupTeamMember(String teamName, String memberName, String notice)
static

执行 wakeupTeamMember 方法。

Wakes a teammate by team + member name, injecting notice into its next turn.

参数Parameters
名称Name类型Type说明Description
teamNameString团队名称(类型 `String`)。The team name.
memberNameString成员名称(类型 `String`)。The member name.
noticeStringnotice(类型 `String`)。The notice.
返回Returns boolean
返回布尔值,表示判断结果。Returns a boolean result.
源码Source io/agentscope/harness/agent/middleware/TeamsMiddleware.java:177–185

getTools

public List<Object> getTools()

获取工具。

Tools to register on the agent toolkit at build time.

返回Returns List<Object>
返回列出。Returns list.
源码Source io/agentscope/harness/agent/middleware/TeamsMiddleware.java:195–197

teamContext

public TeamContext teamContext()

返回团队上下文。

Returns the team context.

返回Returns TeamContext
返回TeamContext。Returns team context.
源码Source io/agentscope/harness/agent/middleware/TeamsMiddleware.java:199–201

teamClient

public TeamClient teamClient()

返回团队客户端。

Returns the team client.

返回Returns TeamClient
返回TeamClient。Returns team client.
源码Source io/agentscope/harness/agent/middleware/TeamsMiddleware.java:203–205

wireMessageBus

public void wireMessageBus(MessageBus messageBus, String agentId)

执行 wireMessageBus 方法。

Wires mailbox wakeups.

参数Parameters
名称Name类型Type说明Description
messageBusMessageBus消息总线(类型 `MessageBus`)。The message bus.
agentIdString智能体标识(类型 `String`)。The agent id.
源码Source io/agentscope/harness/agent/middleware/TeamsMiddleware.java:211–216

notifyWakeup

public void notifyWakeup(String sessionId)

设置该参数。

Notifies this teammate session that a team event arrived (message / task settled).

参数Parameters
名称Name类型Type说明Description
sessionIdString会话标识(类型 `String`)。The session id.
源码Source io/agentscope/harness/agent/middleware/TeamsMiddleware.java:219–221

notifyWakeup

public void notifyWakeup(String sessionId, String notice)

执行 notifyWakeup 方法。

Notifies this teammate session, injecting notice so the woken turn starts with the event content instead of an empty prompt.

参数Parameters
名称Name类型Type说明Description
sessionIdString会话标识(类型 `String`)。The session id.
noticeStringnotice(类型 `String`)。The notice.
源码Source io/agentscope/harness/agent/middleware/TeamsMiddleware.java:230–261

onAgent

public Flux<AgentEvent> onAgent(Agent agent, RuntimeContext ctx, AgentInput input, Function<AgentInput, Flux<AgentEvent>> next)

处理智能体事件。

Gives the lead the board as it stands when its turn starts, and settles a worker's tasks when its turn ends.

参数Parameters
名称Name类型Type说明Description
agentAgent智能体(类型 `Agent`)。The agent.
ctxRuntimeContext运行时上下文(类型 `RuntimeContext`)。The ctx.
inputAgentInput输入消息(类型 `AgentInput`)。The input.
nextFunction<AgentInput, Flux<AgentEvent>>下一个(类型 `Function >`)。The next.
返回Returns Flux<AgentEvent>
返回Flux。Returns flux.
源码Source io/agentscope/harness/agent/middleware/TeamsMiddleware.java:285–313

onReasoning

public Flux<AgentEvent> onReasoning(Agent agent, RuntimeContext ctx, ReasoningInput input, Function<ReasoningInput, Flux<AgentEvent>> next)

处理推理事件。

Performs the on reasoning operation.

参数Parameters
名称Name类型Type说明Description
agentAgent智能体(类型 `Agent`)。The agent.
ctxRuntimeContext运行时上下文(类型 `RuntimeContext`)。The ctx.
inputReasoningInput输入消息(类型 `ReasoningInput`)。The input.
nextFunction<ReasoningInput, Flux<AgentEvent>>下一个(类型 `Function >`)。The next.
返回Returns Flux<AgentEvent>
返回Flux。Returns flux.
源码Source io/agentscope/harness/agent/middleware/TeamsMiddleware.java:391–402

hasOutstandingTeamWork

public boolean hasOutstandingTeamWork()

判断是否具有 hasOutstandingTeamWork。

Reports whether the shared board still has non-terminal tasks, so blocking waits know that teammates are still working even when this session owns no background subagent tasks.

返回Returns boolean
返回布尔值,表示判断结果。Returns a boolean result.
源码Source io/agentscope/harness/agent/middleware/TeamsMiddleware.java:484–498

renderTeamSection

public static String renderTeamSection(TeamContext ctx)
static

渲染 renderTeamSection。

Renders the system-prompt team section (also used by BYO team_join kickoff).

参数Parameters
名称Name类型Type说明Description
ctxTeamContext运行时上下文(类型 `TeamContext`)。The ctx.
返回Returns String
返回字符串结果。Returns a string.
源码Source io/agentscope/harness/agent/middleware/TeamsMiddleware.java:514–648

继承成员Inherited Members

继承自Methods inherited from MiddlewareBase
基于官方固定版本源码静态生成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.