类class io.agentscope.spring.boot.agui.mvc 2.x

AguiMvcController

public class AguiMvcController

源码Source io/agentscope/spring/boot/agui/mvc/AguiMvcController.java:69–476

AGUI Mvc 控制器，承载智能体的部署、调度与服务化运行。位于 io.agentscope.spring.boot.agui.mvc 包。核心成员包括 handle、handleWithAgentId、getAgentIdHeader、builder。

MVC controller for AG-UI protocol requests.

This controller processes AG-UI run requests and returns Server-Sent Events (SSE) streams with AG-UI protocol events using Spring MVC's SseEmitter.

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:

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

嵌套类摘要Nested Class Summary

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

方法摘要Method Summary

方法Method	说明Description
`public SseEmitter handle(RunAgentInput input, String headerAgentId)`	处理AG-UI 运行请求。 Handle an AG-UI run request.
`public SseEmitter handle(RunAgentInput input, String headerAgentId, HttpServletRequest request)`	处理AG-UI 运行请求。 Handle an AG-UI run request.
`public SseEmitter handleWithAgentId(RunAgentInput input, String headerAgentId, String pathAgentId)`	处理AG-UI 运行请求使用智能体标识，使用 URL 路径。 Handle an AG-UI run request with agent ID in the URL path.
`public SseEmitter handleWithAgentId(RunAgentInput input, String headerAgentId, String pathAgentId, HttpServletRequest request)`	处理AG-UI 运行请求使用智能体标识，使用 URL 路径。 Handle an AG-UI run request with agent ID in the URL path.
`public String getAgentIdHeader()`	获取智能体标识请求头名称。 Get the agent ID header name.
`public static` `Builder builder()` static	创建新的构建器用于 AguiMvcController。 Creates a new builder for AguiMvcController.

方法详情Method Detail

handle

public SseEmitter handle(RunAgentInput input, String headerAgentId)

处理AG-UI 运行请求。

Handle an AG-UI run request.

参数Parameters

名称Name	类型Type	说明Description
`input`	RunAgentInput	运行智能体输入。The run agent input
`headerAgentId`	String	请求头智能体标识（类型 `String`）。The agent ID from HTTP header (may be null)

返回Returns SseEmitter

一种SseEmitter 用于流式 AG-UI 事件。An SseEmitter for streaming AG-UI events

源码Source io/agentscope/spring/boot/agui/mvc/AguiMvcController.java:113–115

handle

public SseEmitter handle(RunAgentInput input, String headerAgentId, HttpServletRequest request)

处理AG-UI 运行请求。

Handle an AG-UI run request.

参数Parameters

名称Name	类型Type	说明Description
`input`	RunAgentInput	运行智能体输入。The run agent input
`headerAgentId`	String	请求头智能体标识（类型 `String`）。The agent ID from HTTP header (may be null)
`request`	HttpServletRequest	请求（类型 `HttpServletRequest`）。The native servlet request (may be null)

返回Returns SseEmitter

一种SseEmitter 用于流式 AG-UI 事件。An SseEmitter for streaming AG-UI events

源码Source io/agentscope/spring/boot/agui/mvc/AguiMvcController.java:125–128

handleWithAgentId

public SseEmitter handleWithAgentId(RunAgentInput input, String headerAgentId, String pathAgentId)

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

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

参数Parameters

名称Name	类型Type	说明Description
`input`	RunAgentInput	运行智能体输入。The run agent input
`headerAgentId`	String	请求头智能体标识（类型 `String`）。The agent ID from HTTP header (may be null)
`pathAgentId`	String	路径智能体标识（类型 `String`）。The agent ID from URL path variable

返回Returns SseEmitter

一种SseEmitter 用于流式 AG-UI 事件。An SseEmitter for streaming AG-UI events

源码Source io/agentscope/spring/boot/agui/mvc/AguiMvcController.java:138–141

handleWithAgentId

public SseEmitter handleWithAgentId(RunAgentInput input, String headerAgentId, String pathAgentId, HttpServletRequest request)

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

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

参数Parameters

名称Name	类型Type	说明Description
`input`	RunAgentInput	运行智能体输入。The run agent input
`headerAgentId`	String	请求头智能体标识（类型 `String`）。The agent ID from HTTP header (may be null)
`pathAgentId`	String	路径智能体标识（类型 `String`）。The agent ID from URL path variable
`request`	HttpServletRequest	请求（类型 `HttpServletRequest`）。The native servlet request (may be null)

返回Returns SseEmitter

一种SseEmitter 用于流式 AG-UI 事件。An SseEmitter for streaming AG-UI events

源码Source io/agentscope/spring/boot/agui/mvc/AguiMvcController.java:152–158

getAgentIdHeader

public String getAgentIdHeader()

获取智能体标识请求头名称。

Get the agent ID header name.

返回Returns String

请求头名称。The header name

源码Source io/agentscope/spring/boot/agui/mvc/AguiMvcController.java:338–340

builder

public static Builder builder()

static

创建新的构建器用于 AguiMvcController。

Creates a new builder for AguiMvcController.

返回Returns Builder

一种新的构建器实例。A new builder instance

源码Source io/agentscope/spring/boot/agui/mvc/AguiMvcController.java:347–349

嵌套类详情Nested Class Detail

Builder

public static class Builder

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

Builder for AguiMvcController.