AS AgentScopeAPI 手册 / API Reference

AguiRequestProcessor

public class AguiRequestProcessor
源码Source io/agentscope/core/agui/processor/AguiRequestProcessor.java:66–438

AGUI 请求处理器,在智能体、模型与前端之间传递结构化消息和事件。位于 io.agentscope.core.agui.processor 包。核心成员包括 process、resolveAgentId、extractLatestUserMessage、builder。

Core processor for AG-UI requests.

This class encapsulates the common logic for processing AG-UI requests, extracting it from MVC and WebFlux handlers to avoid code duplication.

Responsibilities:

  • Agent ID resolution from multiple sources

  • Message extraction for server-side memory scenarios

  • Agent resolution via AgentResolver

  • Event stream generation via AguiAgentAdapter

Usage:

`AguiRequestProcessor processor = AguiRequestProcessor.builder()
.agentResolver(resolver)
.config(AguiAdapterConfig.defaultConfig())
.build();

AguiRuntimeContextRequest<?> request = AguiRuntimeContextRequest.builder()
.input(input)
.build();
ProcessResult result = processor.process(request);
Flux<AguiEvent> events = result.events();
`

嵌套类摘要Nested Class Summary

类Class类型Kind说明Description
ProcessResult记录record
承载 Process 结果数据的记录类型。
Result of processing an AG-UI request.
Builder类class
AguiRequestProcessor的构建器。
Builder for AguiRequestProcessor.

方法摘要Method Summary

方法Method说明Description
public ProcessResult process(AguiRuntimeContextRequest<?> request)
设置该参数。
Process an AG-UI request and return the result containing agent and event stream.
public String resolveAgentId(RunAgentInput input, String headerAgentId, String pathAgentId)
解析智能体标识。
Resolve the agent ID from multiple sources.
public RunAgentInput extractLatestUserMessage(RunAgentInput input)
设置该参数。
Extract messages that arrived after the last assistant turn.
public static Builder builder()
static
创建新的构建器用于 AguiRequestProcessor。
Creates a new builder for AguiRequestProcessor.

方法详情Method Detail

process

public ProcessResult process(AguiRuntimeContextRequest<?> request)

设置该参数。

Process an AG-UI request and return the result containing agent and event stream.

参数Parameters
名称Name类型Type说明Description
requestAguiRuntimeContextRequest<?>请求(类型 `AguiRuntimeContextRequest`)。The AG-UI request context carrying input, agent IDs, transport details and the native request
返回Returns ProcessResult
返回ProcessResult。A ProcessResult containing the agent and event stream
源码Source io/agentscope/core/agui/processor/AguiRequestProcessor.java:134–225

resolveAgentId

public String resolveAgentId(RunAgentInput input, String headerAgentId, String pathAgentId)

解析智能体标识。

Resolve the agent ID from multiple sources.

参数Parameters
名称Name类型Type说明Description
inputRunAgentInput请求输入。The request input
headerAgentIdString请求头智能体标识(类型 `String`)。The agent ID from HTTP header (may be null)
pathAgentIdString路径智能体标识(类型 `String`)。The agent ID from URL path variable (may be null)
返回Returns String
已解析智能体标识。The resolved agent ID
源码Source io/agentscope/core/agui/processor/AguiRequestProcessor.java:276–306

extractLatestUserMessage

public RunAgentInput extractLatestUserMessage(RunAgentInput input)

设置该参数。

Extract messages that arrived after the last assistant turn.

参数Parameters
名称Name类型Type说明Description
inputRunAgentInput输入消息(类型 `RunAgentInput`)。The original input
返回Returns RunAgentInput
返回RunAgentInput。A new input containing only the follow-up messages, or the original input
源码Source io/agentscope/core/agui/processor/AguiRequestProcessor.java:323–364

builder

public static Builder builder()
static

创建新的构建器用于 AguiRequestProcessor。

Creates a new builder for AguiRequestProcessor.

返回Returns Builder
一种新的构建器实例。A new builder instance
源码Source io/agentscope/core/agui/processor/AguiRequestProcessor.java:371–373

嵌套类详情Nested Class Detail

ProcessResult

public record ProcessResult( Agent agent, Flux<AguiEvent> events, RuntimeContext runtimeContext)

承载 Process 结果数据的记录类型。位于 io.agentscope.core.agui.processor 包。核心成员包括 agent、events、runtimeContext、interrupt。

Result of processing an AG-UI request.

Contains the resolved agent (for interrupt handling) and the event stream.

Builder

public static class Builder

AguiRequestProcessor的构建器。位于 io.agentscope.core.agui.processor 包。核心成员包括 agentResolver、config、adapterFactory、runtimeContextResolver、build。

Builder for AguiRequestProcessor.

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