AS AgentScopeAPI 手册 / API Reference

Builder

public static class Builder
源码Source io/agentscope/spring/boot/agui/mvc/AguiMvcController.java:352–475

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

Builder for AguiMvcController.

方法摘要Method Summary

方法Method说明Description
public Builder agentRegistry(AguiAgentRegistry registry)
设置智能体注册表。
Set the agent registry.
public Builder sessionManager(ThreadSessionManager sessionManager)
设置会话管理器。
Set the thread session manager for server-side memory support.
public Builder serverSideMemory(boolean enabled)
设置该配置项。
Enable or disable server-side memory management.
public Builder config(AguiAdapterConfig config)
设置适配器配置。
Set the adapter configuration.
public Builder agentIdHeader(String agentIdHeader)
设置HTTP 请求头名称到读取智能体标识来自。
Set the HTTP header name to read agent ID from.
public Builder sseTimeout(long sseTimeout)
设置SSE 超时。
Set the SSE timeout in milliseconds.
public Builder interruptOnDisconnect(boolean interruptOnDisconnect)
设置中断 On 断开。
Set whether to interrupt the agent when the client disconnects.
public Builder runtimeContextResolver(AguiRuntimeContextResolver runtimeContextResolver)
设置运行时上下文解析器。
Set the runtime context resolver.
public Builder adapterFactory(AguiAgentAdapterFactory adapterFactory)
设置适配器工厂。
Set the adapter factory.
public AguiMvcController build()
构建控制器。
Build the controller.

方法详情Method Detail

agentRegistry

public Builder agentRegistry(AguiAgentRegistry registry)

设置智能体注册表。

Set the agent registry.

参数Parameters
名称Name类型Type说明Description
registryAguiAgentRegistry智能体注册表。The agent registry
返回Returns Builder
返回当前实例,以支持链式调用。This builder
源码Source io/agentscope/spring/boot/agui/mvc/AguiMvcController.java:370–373

sessionManager

public Builder sessionManager(ThreadSessionManager sessionManager)

设置会话管理器。

Set the thread session manager for server-side memory support.

参数Parameters
名称Name类型Type说明Description
sessionManagerThreadSessionManager会话管理器。The session manager
返回Returns Builder
返回当前实例,以支持链式调用。This builder
源码Source io/agentscope/spring/boot/agui/mvc/AguiMvcController.java:381–384

serverSideMemory

public Builder serverSideMemory(boolean enabled)

设置该配置项。

Enable or disable server-side memory management.

参数Parameters
名称Name类型Type说明Description
enabledboolean已启用(类型 `boolean`)。Whether to enable server-side memory
返回Returns Builder
返回当前实例,以支持链式调用。This builder
源码Source io/agentscope/spring/boot/agui/mvc/AguiMvcController.java:392–395

config

public Builder config(AguiAdapterConfig config)

设置适配器配置。

Set the adapter configuration.

参数Parameters
名称Name类型Type说明Description
configAguiAdapterConfig适配器配置。The adapter configuration
返回Returns Builder
返回当前实例,以支持链式调用。This builder
源码Source io/agentscope/spring/boot/agui/mvc/AguiMvcController.java:403–406

agentIdHeader

public Builder agentIdHeader(String agentIdHeader)

设置HTTP 请求头名称到读取智能体标识来自。

Set the HTTP header name to read agent ID from.

参数Parameters
名称Name类型Type说明Description
agentIdHeaderString请求头名称(默认:X-智能体-Id)。The header name (default: X-Agent-Id)
返回Returns Builder
返回当前实例,以支持链式调用。This builder
源码Source io/agentscope/spring/boot/agui/mvc/AguiMvcController.java:414–417

sseTimeout

public Builder sseTimeout(long sseTimeout)

设置SSE 超时。

Set the SSE timeout in milliseconds.

参数Parameters
名称Name类型Type说明Description
sseTimeoutlong超时值。The timeout value
返回Returns Builder
返回当前实例,以支持链式调用。This builder
源码Source io/agentscope/spring/boot/agui/mvc/AguiMvcController.java:425–428

interruptOnDisconnect

public Builder interruptOnDisconnect(boolean interruptOnDisconnect)

设置中断 On 断开。

Set whether to interrupt the agent when the client disconnects.

参数Parameters
名称Name类型Type说明Description
interruptOnDisconnectboolean判断是否到中断智能体。whether to interrupt the agent
返回Returns Builder
返回当前实例,以支持链式调用。This builder
源码Source io/agentscope/spring/boot/agui/mvc/AguiMvcController.java:436–439

runtimeContextResolver

public Builder runtimeContextResolver(AguiRuntimeContextResolver runtimeContextResolver)

设置运行时上下文解析器。

Set the runtime context resolver.

参数Parameters
名称Name类型Type说明Description
runtimeContextResolverAguiRuntimeContextResolver运行时上下文解析器(类型 `AguiRuntimeContextResolver`)。The resolver used for each request
返回Returns Builder
返回当前实例,以支持链式调用。This builder
源码Source io/agentscope/spring/boot/agui/mvc/AguiMvcController.java:447–450

adapterFactory

public Builder adapterFactory(AguiAgentAdapterFactory adapterFactory)

设置适配器工厂。

Set the adapter factory.

参数Parameters
名称Name类型Type说明Description
adapterFactoryAguiAgentAdapterFactory适配器工厂(类型 `AguiAgentAdapterFactory`)。The factory used to create per-request adapters
返回Returns Builder
返回当前实例,以支持链式调用。This builder
源码Source io/agentscope/spring/boot/agui/mvc/AguiMvcController.java:458–461

build

public AguiMvcController build()

构建控制器。

Build the controller.

返回Returns AguiMvcController
内置控制器。The built controller
抛出Throws
  • IllegalStateException 当if 注册表是不设置时抛出 `IllegalStateException`。if registry is not set
源码Source io/agentscope/spring/boot/agui/mvc/AguiMvcController.java:469–474
基于官方固定版本源码静态生成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.