类class io.agentscope.core.agui.adapter.strategy 2.x

AguiStreamContext

public class AguiStreamContext

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:39–456

AGUI 流上下文，在智能体、模型与前端之间传递结构化消息和事件。位于 io.agentscope.core.agui.adapter.strategy 包。核心成员包括 getThreadId、getRunId、getConfig、getRunInput、beginEvent、drainEvents。

A class in io.agentscope.core.agui.adapter.strategy that carries structured messages and events between agents, models and UIs. Declared in io.agentscope.core.agui.adapter.strategy.

构造器摘要Constructor Summary

构造器Constructor	说明Description
`public` `AguiStreamContext(String threadId, String runId, AguiAdapterConfig config)`	初始化 `AguiStreamContext` 实例。 Creates a new instance.
`public` `AguiStreamContext(String threadId, String runId, AguiAdapterConfig config, RunAgentInput runInput)`	初始化 `AguiStreamContext` 实例。 Creates a new instance.
`public` `AguiStreamContext(String threadId, String runId, AguiAdapterConfig config, RunAgentInput runInput, Predicate<String> isExternalTool)`	初始化 `AguiStreamContext` 实例。 Stream conversion context.

方法摘要Method Summary

方法Method	说明Description
`public String getThreadId()`	获取会话线程标识。 Returns the thread id.
`public String getRunId()`	获取运行标识。 Returns the run id.
`public` `AguiAdapterConfig getConfig()`	获取配置。 Returns the config.
`public` `RunAgentInput getRunInput()`	获取运行输入。 Returns the run input.
`public void beginEvent()`	执行 `beginEvent` 方法。 Returns the begin event.
`public List<AguiEvent> drainEvents()`	返回 `drainEvents` 结果。 Returns the drain events.
`public void emit(AguiEvent event)`	设置发出。 Performs the emit operation.
`public void startTextMessage(String messageId)`	启动文本消息。 Starts the text message.
`public void appendTextDelta(String messageId, String delta)`	追加文本增量。 Performs the append text delta operation.
`public void closeActiveTextMessage()`	关闭 `closeActiveTextMessage`。 Closes the active text message.
`public void closeTextMessage(String messageId)`	关闭文本消息。 Closes the text message.
`public void startReasoningMessage(String messageId)`	启动推理消息。 Starts the reasoning message.
`public void appendReasoningDelta(String messageId, String delta)`	追加推理增量。 Performs the append reasoning delta operation.
`public void closeActiveReasoningMessage()`	关闭 `closeActiveReasoningMessage`。 Closes the active reasoning message.
`public void closeReasoningMessage(String messageId)`	关闭推理消息。 Closes the reasoning message.
`public void startToolCall(String toolCallId, String toolCallName)`	启动工具调用。 Starts the tool call.
`public void appendToolCallArgs(String toolCallId, String delta)`	追加工具调用参数。 Performs the append tool call args operation.
`public void endToolCall(String toolCallId)`	设置结束工具调用。 Performs the end tool call operation.
`public void adoptToolCall(String toolCallId)`	设置该参数。 Accept results for a tool call whose invocation was emitted in a previous run.
`public void beginToolResult(String toolCallId)`	设置该参数。 Performs the begin tool result operation.
`public void appendToolResultText(String toolCallId, String delta)`	追加工具结果文本。 Performs the append tool result text operation.
`public void appendToolResultData(String toolCallId,` `ContentBlock data)`	追加工具结果数据。 Performs the append tool result data operation.
`public void endToolResult(String replyId, String toolCallId)`	执行结束工具结果相关操作。 Performs the end tool result operation.
`public void markToolCallSuspended(String toolCallId)`	设置该参数。 Performs the mark tool call suspended operation.
`public void addInterrupt(AguiEvent.Interrupt interrupt)`	添加中断。 Adds the interrupt.
`public List<AguiEvent.Interrupt> getPendingInterrupts()`	获取 `getPendingInterrupts`。 Returns the pending interrupts.
`public List<AguiEvent> finishPendingEvents()`	返回 `finishPendingEvents` 结果。 Returns the finish pending events.
`public boolean isExternalToolCall(String toolCallId)`	判断是否外部工具调用。 Whether the started tool call resolves to an external tool.

构造器详情Constructor Detail

AguiStreamContext

public AguiStreamContext(String threadId, String runId, AguiAdapterConfig config)

初始化 AguiStreamContext 实例。

Creates a new instance.

参数Parameters

名称Name	类型Type	说明Description
`threadId`	String	会话线程标识（类型 `String`）。The thread id.
`runId`	String	运行标识（类型 `String`）。The run id.
`config`	AguiAdapterConfig	配置对象（类型 `AguiAdapterConfig`）。The config.

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:66–68

AguiStreamContext

public AguiStreamContext(String threadId, String runId, AguiAdapterConfig config, RunAgentInput runInput)

初始化 AguiStreamContext 实例。

Creates a new instance.

参数Parameters

名称Name	类型Type	说明Description
`threadId`	String	会话线程标识（类型 `String`）。The thread id.
`runId`	String	运行标识（类型 `String`）。The run id.
`config`	AguiAdapterConfig	配置对象（类型 `AguiAdapterConfig`）。The config.
`runInput`	RunAgentInput	运行输入（类型 `RunAgentInput`）。The run input.

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:70–73

AguiStreamContext

public AguiStreamContext(String threadId, String runId, AguiAdapterConfig config, RunAgentInput runInput, Predicate<String> isExternalTool)

初始化 AguiStreamContext 实例。

Stream conversion context.

参数Parameters

名称Name	类型Type	说明Description
`threadId`	String	会话线程标识（类型 `String`）。The thread id.
`runId`	String	运行标识（类型 `String`）。The run id.
`config`	AguiAdapterConfig	配置对象（类型 `AguiAdapterConfig`）。The config.
`runInput`	RunAgentInput	运行输入（类型 `RunAgentInput`）。The run input.
`isExternalTool`	Predicate<String>	是外部工具（类型 `Predicate`）。predicate for external-tool resolution by tool name

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:86–98

方法详情Method Detail

getThreadId

public String getThreadId()

获取会话线程标识。

Returns the thread id.

返回Returns String

返回字符串结果。Returns a string.

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:100–102

getRunId

public String getRunId()

获取运行标识。

Returns the run id.

返回Returns String

返回字符串结果。Returns a string.

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:104–106

getConfig

public AguiAdapterConfig getConfig()

获取配置。

Returns the config.

返回Returns AguiAdapterConfig

返回AguiAdapterConfig。Returns agui adapter config.

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:108–110

getRunInput

public RunAgentInput getRunInput()

获取运行输入。

Returns the run input.

返回Returns RunAgentInput

返回RunAgentInput。Returns run agent input.

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:112–114

beginEvent

public void beginEvent()

执行 beginEvent 方法。

Returns the begin event.

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:116–118

drainEvents

public List<AguiEvent> drainEvents()

返回 drainEvents 结果。

Returns the drain events.

返回Returns List<AguiEvent>

返回列出。Returns list.

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:120–124

emit

public void emit(AguiEvent event)

设置发出。

Performs the emit operation.

参数Parameters

名称Name	类型Type	说明Description
`event`	AguiEvent	事件（类型 `AguiEvent`）。The event.

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:126–128

startTextMessage

public void startTextMessage(String messageId)

启动文本消息。

Starts the text message.

参数Parameters

名称Name	类型Type	说明Description
`messageId`	String	消息标识（类型 `String`）。The message id.

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:134–139

appendTextDelta

public void appendTextDelta(String messageId, String delta)

追加文本增量。

Performs the append text delta operation.

参数Parameters

名称Name	类型Type	说明Description
`messageId`	String	消息标识（类型 `String`）。The message id.
`delta`	String	增量（类型 `String`）。The delta.

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:141–146

closeActiveTextMessage

public void closeActiveTextMessage()

关闭 closeActiveTextMessage。

Closes the active text message.

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:148–153

closeTextMessage

public void closeTextMessage(String messageId)

关闭文本消息。

Closes the text message.

参数Parameters

名称Name	类型Type	说明Description
`messageId`	String	消息标识（类型 `String`）。The message id.

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:155–166

startReasoningMessage

public void startReasoningMessage(String messageId)

启动推理消息。

Starts the reasoning message.

参数Parameters

名称Name	类型Type	说明Description
`messageId`	String	消息标识（类型 `String`）。The message id.

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:168–173

appendReasoningDelta

public void appendReasoningDelta(String messageId, String delta)

追加推理增量。

Performs the append reasoning delta operation.

参数Parameters

名称Name	类型Type	说明Description
`messageId`	String	消息标识（类型 `String`）。The message id.
`delta`	String	增量（类型 `String`）。The delta.

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:175–180

closeActiveReasoningMessage

public void closeActiveReasoningMessage()

关闭 closeActiveReasoningMessage。

Closes the active reasoning message.

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:182–187

closeReasoningMessage

public void closeReasoningMessage(String messageId)

关闭推理消息。

Closes the reasoning message.

参数Parameters

名称Name	类型Type	说明Description
`messageId`	String	消息标识（类型 `String`）。The message id.

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:189–200

startToolCall

public void startToolCall(String toolCallId, String toolCallName)

启动工具调用。

Starts the tool call.

参数Parameters

名称Name	类型Type	说明Description
`toolCallId`	String	工具调用标识（类型 `String`）。The tool call id.
`toolCallName`	String	工具调用名称（类型 `String`）。The tool call name.

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:202–215

appendToolCallArgs

public void appendToolCallArgs(String toolCallId, String delta)

追加工具调用参数。

Performs the append tool call args operation.

参数Parameters

名称Name	类型Type	说明Description
`toolCallId`	String	工具调用标识（类型 `String`）。The tool call id.
`delta`	String	增量（类型 `String`）。The delta.

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:217–224

endToolCall

public void endToolCall(String toolCallId)

设置结束工具调用。

Performs the end tool call operation.

参数Parameters

名称Name	类型Type	说明Description
`toolCallId`	String	工具调用标识（类型 `String`）。The tool call id.

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:226–234

adoptToolCall

public void adoptToolCall(String toolCallId)

设置该参数。

Accept results for a tool call whose invocation was emitted in a previous run.

参数Parameters

名称Name	类型Type	说明Description
`toolCallId`	String	工具调用标识（类型 `String`）。stable id of the previously emitted tool call

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:246–252

beginToolResult

public void beginToolResult(String toolCallId)

设置该参数。

Performs the begin tool result operation.

参数Parameters

名称Name	类型Type	说明Description
`toolCallId`	String	工具调用标识（类型 `String`）。The tool call id.

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:254–259

appendToolResultText

public void appendToolResultText(String toolCallId, String delta)

追加工具结果文本。

Performs the append tool result text operation.

参数Parameters

名称Name	类型Type	说明Description
`toolCallId`	String	工具调用标识（类型 `String`）。The tool call id.
`delta`	String	增量（类型 `String`）。The delta.

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:261–268

appendToolResultData

public void appendToolResultData(String toolCallId, ContentBlock data)

追加工具结果数据。

Performs the append tool result data operation.

参数Parameters

名称Name	类型Type	说明Description
`toolCallId`	String	工具调用标识（类型 `String`）。The tool call id.
`data`	ContentBlock	数据（类型 `ContentBlock`）。The data.

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:270–282

endToolResult

public void endToolResult(String replyId, String toolCallId)

执行结束工具结果相关操作。

Performs the end tool result operation.

参数Parameters

名称Name	类型Type	说明Description
`replyId`	String	回复标识（类型 `String`）。The reply id.
`toolCallId`	String	工具调用标识（类型 `String`）。The tool call id.

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:284–300

markToolCallSuspended

public void markToolCallSuspended(String toolCallId)

设置该参数。

Performs the mark tool call suspended operation.

参数Parameters

名称Name	类型Type	说明Description
`toolCallId`	String	工具调用标识（类型 `String`）。The tool call id.

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:302–307

addInterrupt

public void addInterrupt(AguiEvent.Interrupt interrupt)

添加中断。

Adds the interrupt.

参数Parameters

名称Name	类型Type	说明Description
`interrupt`	AguiEvent.Interrupt	中断（类型 `AguiEvent.Interrupt`）。The interrupt.

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:309–312

getPendingInterrupts

public List<AguiEvent.Interrupt> getPendingInterrupts()

获取 getPendingInterrupts。

Returns the pending interrupts.

返回Returns List<AguiEvent.Interrupt>

返回列出。Returns list.

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:314–316

finishPendingEvents

public List<AguiEvent> finishPendingEvents()

返回 finishPendingEvents 结果。

Returns the finish pending events.

返回Returns List<AguiEvent>

返回列出。Returns list.

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:318–328

isExternalToolCall

public boolean isExternalToolCall(String toolCallId)

判断是否外部工具调用。

Whether the started tool call resolves to an external tool.

参数Parameters

名称Name	类型Type	说明Description
`toolCallId`	String	工具调用标识（类型 `String`）。The tool call id.

返回Returns boolean

返回布尔值，表示判断结果。Returns a boolean result.

源码Source io/agentscope/core/agui/adapter/strategy/AguiStreamContext.java:384–387