AS AgentScopeAPI 手册 / API Reference

Gateway

public interface Gateway
源码Source io/agentscope/harness/agent/gateway/Gateway.java:39–163

定义网关契约的接口。位于 io.agentscope.harness.agent.gateway 包。核心成员包括 bindMainAgent、registerAgent、run、runStream、runSubagent、runSubagentStream。

Gateway-style entrypoint: route inbound turns by MsgContext, and bind the primary HarnessAgent for announce delivery.

Implementations should serialize turns per logical session (fair wait) so injected announce runs and user/channel #run calls do not race the same HarnessAgent turn.

Callers may supply a RuntimeContext that is merged into the agent turn. Gateway-owned identity fields (sessionId, userId, outboundAddress, …) always win on conflict.

方法摘要Method Summary

方法Method说明Description
public void bindMainAgent(HarnessAgent agent)
设置该参数。
Binds the primary harness agent after construction.
default public void registerAgent(String agentId, HarnessAgent agent)
default
注册智能体。
Registers a named harness agent for routing.
public Mono<Msg> run(MsgContext context, List<Msg> messages)
执行运行相关操作。
Inbound turn (direct API or channel adapter).
default public Mono<Msg> run(MsgContext context, List<Msg> messages, OutboundAddress outboundAddress)
default
执行运行相关操作。
Inbound turn with outbound address.
default public Mono<Msg> run(MsgContext context, List<Msg> messages, OutboundAddress outboundAddress, RuntimeContext callerContext)
default
执行运行相关操作。
Inbound turn with outbound address and an optional caller `RuntimeContext`.
default public Mono<Msg> run(MsgContext context, List<Msg> messages, OutboundAddress outboundAddress, RuntimeContext callerContext, InboundMessage inboundMessage)
default
执行运行相关操作。
Inbound turn with full Channel metadata for `io.agentscope.harness.agent.gateway.channel.ChannelRuntimeContextResolver`.
default public Mono<Msg> run(MsgContext context, Msg message)
default
执行运行相关操作。
Single-message convenience.
default public Flux<AgentEvent> runStream(MsgContext context, List<Msg> messages)
default
运行流。
Streaming variant of `#run(MsgContext, List)`.
default public Flux<AgentEvent> runStream(MsgContext context, List<Msg> messages, OutboundAddress outboundAddress)
default
运行流。
Streaming variant of `#run(MsgContext, List, OutboundAddress)`.
default public Flux<AgentEvent> runStream(MsgContext context, List<Msg> messages, OutboundAddress outboundAddress, RuntimeContext callerContext)
default
运行流。
Streaming variant of `#run(MsgContext, List, OutboundAddress, RuntimeContext)`.
default public Flux<AgentEvent> runStream(MsgContext context, List<Msg> messages, OutboundAddress outboundAddress, RuntimeContext callerContext, InboundMessage inboundMessage)
default
运行流。
Streaming variant of `#run(MsgContext, List, OutboundAddress, RuntimeContext, InboundMessage)`.
default public Mono<Msg> runSubagent(String subagentId, List<Msg> messages)
default
运行子智能体。
Routes messages directly to an exposed subagent session identified by `subagentId`, bypassing normal binding-based routing.
default public Flux<AgentEvent> runSubagentStream(String subagentId, List<Msg> messages)
default
运行子智能体流。
Streaming variant of `#runSubagent(String, List)`.

方法详情Method Detail

bindMainAgent

public void bindMainAgent(HarnessAgent agent)

设置该参数。

Binds the primary harness agent after construction.

参数Parameters
名称Name类型Type说明Description
agentHarnessAgent智能体(类型 `HarnessAgent`)。The agent.
源码Source io/agentscope/harness/agent/gateway/Gateway.java:45

registerAgent

default public void registerAgent(String agentId, HarnessAgent agent)
default

注册智能体。

Registers a named harness agent for routing.

参数Parameters
名称Name类型Type说明Description
agentIdString智能体标识(类型 `String`)。The agent id.
agentHarnessAgent智能体(类型 `HarnessAgent`)。The agent.
源码Source io/agentscope/harness/agent/gateway/Gateway.java:52

run

public Mono<Msg> run(MsgContext context, List<Msg> messages)

执行运行相关操作。

Inbound turn (direct API or channel adapter).

参数Parameters
名称Name类型Type说明Description
contextMsgContext上下文(类型 `MsgContext`)。The context.
messagesList<Msg>消息列表(类型 `List`)。The messages.
返回Returns Mono<Msg>
返回Mono。Returns mono.
源码Source io/agentscope/harness/agent/gateway/Gateway.java:55

run

default public Mono<Msg> run(MsgContext context, List<Msg> messages, OutboundAddress outboundAddress)
default

执行运行相关操作。

Inbound turn with outbound address.

参数Parameters
名称Name类型Type说明Description
contextMsgContext上下文(类型 `MsgContext`)。routing context for session key resolution
messagesList<Msg>入站消息。the inbound messages
outboundAddressOutboundAddress出站 Address(类型 `OutboundAddress`)。the delivery target for proactive replies; may be null
返回Returns Mono<Msg>
返回Mono。Returns mono.
源码Source io/agentscope/harness/agent/gateway/Gateway.java:66–68

run

default public Mono<Msg> run(MsgContext context, List<Msg> messages, OutboundAddress outboundAddress, RuntimeContext callerContext)
default

执行运行相关操作。

Inbound turn with outbound address and an optional caller RuntimeContext.

参数Parameters
名称Name类型Type说明Description
contextMsgContext上下文(类型 `MsgContext`)。routing context for session key resolution
messagesList<Msg>入站消息。the inbound messages
outboundAddressOutboundAddress出站 Address(类型 `OutboundAddress`)。the delivery target for proactive replies; may be null
callerContextRuntimeContextcaller 上下文(类型 `RuntimeContext`)。optional application context to merge; may be null
返回Returns Mono<Msg>
返回Mono。Returns mono.
源码Source io/agentscope/harness/agent/gateway/Gateway.java:82–88

run

default public Mono<Msg> run(MsgContext context, List<Msg> messages, OutboundAddress outboundAddress, RuntimeContext callerContext, InboundMessage inboundMessage)
default

执行运行相关操作。

Inbound turn with full Channel metadata for io.agentscope.harness.agent.gateway.channel.ChannelRuntimeContextResolver.

参数Parameters
名称Name类型Type说明Description
contextMsgContext上下文(类型 `MsgContext`)。The context.
messagesList<Msg>消息列表(类型 `List`)。The messages.
outboundAddressOutboundAddress出站 Address(类型 `OutboundAddress`)。The outbound address.
callerContextRuntimeContextcaller 上下文(类型 `RuntimeContext`)。The caller context.
inboundMessageInboundMessage入站消息(类型 `InboundMessage`)。optional inbound envelope passed to the resolver; may be null
返回Returns Mono<Msg>
返回Mono。Returns mono.
源码Source io/agentscope/harness/agent/gateway/Gateway.java:96–103

run

default public Mono<Msg> run(MsgContext context, Msg message)
default

执行运行相关操作。

Single-message convenience.

参数Parameters
名称Name类型Type说明Description
contextMsgContext上下文(类型 `MsgContext`)。The context.
messageMsg消息(类型 `Msg`)。The message.
返回Returns Mono<Msg>
返回Mono。Returns mono.
源码Source io/agentscope/harness/agent/gateway/Gateway.java:106–108

runStream

default public Flux<AgentEvent> runStream(MsgContext context, List<Msg> messages)
default

运行流。

Streaming variant of #run(MsgContext, List).

参数Parameters
名称Name类型Type说明Description
contextMsgContext上下文(类型 `MsgContext`)。The context.
messagesList<Msg>消息列表(类型 `List`)。The messages.
返回Returns Flux<AgentEvent>
返回Flux。Returns flux.
源码Source io/agentscope/harness/agent/gateway/Gateway.java:111–113

runStream

default public Flux<AgentEvent> runStream(MsgContext context, List<Msg> messages, OutboundAddress outboundAddress)
default

运行流。

Streaming variant of #run(MsgContext, List, OutboundAddress).

参数Parameters
名称Name类型Type说明Description
contextMsgContext上下文(类型 `MsgContext`)。The context.
messagesList<Msg>消息列表(类型 `List`)。The messages.
outboundAddressOutboundAddress出站 Address(类型 `OutboundAddress`)。The outbound address.
返回Returns Flux<AgentEvent>
返回Flux。Returns flux.
源码Source io/agentscope/harness/agent/gateway/Gateway.java:116–119

runStream

default public Flux<AgentEvent> runStream(MsgContext context, List<Msg> messages, OutboundAddress outboundAddress, RuntimeContext callerContext)
default

运行流。

Streaming variant of #run(MsgContext, List, OutboundAddress, RuntimeContext).

参数Parameters
名称Name类型Type说明Description
contextMsgContext上下文(类型 `MsgContext`)。The context.
messagesList<Msg>消息列表(类型 `List`)。The messages.
outboundAddressOutboundAddress出站 Address(类型 `OutboundAddress`)。The outbound address.
callerContextRuntimeContextcaller 上下文(类型 `RuntimeContext`)。The caller context.
返回Returns Flux<AgentEvent>
返回Flux。Returns flux.
源码Source io/agentscope/harness/agent/gateway/Gateway.java:126–132

runStream

default public Flux<AgentEvent> runStream(MsgContext context, List<Msg> messages, OutboundAddress outboundAddress, RuntimeContext callerContext, InboundMessage inboundMessage)
default

运行流。

Streaming variant of #run(MsgContext, List, OutboundAddress, RuntimeContext, InboundMessage).

参数Parameters
名称Name类型Type说明Description
contextMsgContext上下文(类型 `MsgContext`)。The context.
messagesList<Msg>消息列表(类型 `List`)。The messages.
outboundAddressOutboundAddress出站 Address(类型 `OutboundAddress`)。The outbound address.
callerContextRuntimeContextcaller 上下文(类型 `RuntimeContext`)。The caller context.
inboundMessageInboundMessage入站消息(类型 `InboundMessage`)。The inbound message.
返回Returns Flux<AgentEvent>
返回Flux。Returns flux.
源码Source io/agentscope/harness/agent/gateway/Gateway.java:138–145

runSubagent

default public Mono<Msg> runSubagent(String subagentId, List<Msg> messages)
default

运行子智能体。

Routes messages directly to an exposed subagent session identified by subagentId, bypassing normal binding-based routing.

参数Parameters
名称Name类型Type说明Description
subagentIdString子智能体标识(类型 `String`)。the handle returned by `SubagentGatewayBridge.ExposeResult#subagentId()`
messagesList<Msg>消息到发送到子智能体。the messages to send to the subagent
返回Returns Mono<Msg>
返回Mono。Returns mono.
源码Source io/agentscope/harness/agent/gateway/Gateway.java:155–157

runSubagentStream

default public Flux<AgentEvent> runSubagentStream(String subagentId, List<Msg> messages)
default

运行子智能体流。

Streaming variant of #runSubagent(String, List).

参数Parameters
名称Name类型Type说明Description
subagentIdString子智能体标识(类型 `String`)。The subagent id.
messagesList<Msg>消息列表(类型 `List`)。The messages.
返回Returns Flux<AgentEvent>
返回Flux。Returns flux.
源码Source io/agentscope/harness/agent/gateway/Gateway.java:160–162
基于官方固定版本源码静态生成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.