AS AgentScopeAPI 手册 / API Reference

AguiWebFluxHandler

public class AguiWebFluxHandler
源码Source io/agentscope/spring/boot/agui/webflux/AguiWebFluxHandler.java:72–408

AGUI Web Flux 处理器,承载智能体的部署、调度与服务化运行。位于 io.agentscope.spring.boot.agui.webflux 包。核心成员包括 handle、handleWithAgentId、builder。

WebFlux handler for AG-UI protocol requests.

This handler processes AG-UI run requests and returns Server-Sent Events (SSE) streams with AG-UI protocol events.

Agent ID Resolution Priority:

  • URL path variable: /agui/run/{agentId}

  • HTTP header: configurable via agentIdHeader (default: X-Agent-Id)

  • forwardedProps.agentId in request body

  • config.defaultAgentId

  • "default"

Usage:

`AguiWebFluxHandler handler = AguiWebFluxHandler.builder()
.agentRegistry(registry)
.config(AguiAdapterConfig.defaultConfig())
.agentIdHeader("X-Agent-Id")
.build();

RouterFunction<ServerResponse> routes = RouterFunctions.route()
.POST("/agui/run", handler::handle)
.POST("/agui/run/{agentId}", handler::handleWithAgentId)
.build();
`

嵌套类摘要Nested Class Summary

类Class类型Kind说明Description
Builder类class
AguiWebFluxHandler的构建器。
Builder for AguiWebFluxHandler.

方法摘要Method Summary

方法Method说明Description
public Mono<ServerResponse> handle(ServerRequest request)
处理AG-UI 运行请求。
Handle an AG-UI run request.
public Mono<ServerResponse> handleWithAgentId(ServerRequest request)
处理AG-UI 运行请求使用智能体标识,使用 URL 路径。
Handle an AG-UI run request with agent ID in the URL path.
public static Builder builder()
static
创建新的构建器用于 AguiWebFluxHandler。
Creates a new builder for AguiWebFluxHandler.

方法详情Method Detail

handle

public Mono<ServerResponse> handle(ServerRequest request)

处理AG-UI 运行请求。

Handle an AG-UI run request.

参数Parameters
名称Name类型Type说明Description
requestServerRequest服务端请求。The server request
返回Returns Mono<ServerResponse>
返回Mono。A Mono containing the server response with SSE stream
源码Source io/agentscope/spring/boot/agui/webflux/AguiWebFluxHandler.java:120–125

handleWithAgentId

public Mono<ServerResponse> handleWithAgentId(ServerRequest request)

处理AG-UI 运行请求使用智能体标识,使用 URL 路径。

Handle an AG-UI run request with agent ID in the URL path.

参数Parameters
名称Name类型Type说明Description
requestServerRequest请求(类型 `ServerRequest`)。The server request containing the agentId path variable
返回Returns Mono<ServerResponse>
返回Mono。A Mono containing the server response with SSE stream
源码Source io/agentscope/spring/boot/agui/webflux/AguiWebFluxHandler.java:136–142

builder

public static Builder builder()
static

创建新的构建器用于 AguiWebFluxHandler。

Creates a new builder for AguiWebFluxHandler.

返回Returns Builder
一种新的构建器实例。A new builder instance
源码Source io/agentscope/spring/boot/agui/webflux/AguiWebFluxHandler.java:279–281

嵌套类详情Nested Class Detail

Builder

public static class Builder

AguiWebFluxHandler的构建器。位于 io.agentscope.spring.boot.agui.webflux 包。核心成员包括 agentRegistry、sessionManager、serverSideMemory、config、agentIdHeader、interruptOnDisconnect。

Builder for AguiWebFluxHandler.

基于官方固定版本源码静态生成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.