AS AgentScopeAPI 手册 / API Reference

Builder

public static class Builder
源码Source io/agentscope/core/agui/adapter/AguiAdapterConfig.java:216–419

AguiAdapterConfig的构建器。位于 io.agentscope.core.agui.adapter 包。核心成员包括 toolMergeMode、emitStateEvents、emitToolCallArgs、emitTokenUsage、enableReasoning、emitRunFinishedAfterError。

Builder for AguiAdapterConfig.

方法摘要Method Summary

方法Method说明Description
public Builder toolMergeMode(ToolMergeMode toolMergeMode)
设置该配置项。
Set the tool merge mode.
public Builder emitStateEvents(boolean emitStateEvents)
设置发出状态事件。
Set whether to emit state events.
public Builder emitToolCallArgs(boolean emitToolCallArgs)
设置发出工具调用参数。
Set whether to emit tool call argument events.
public Builder emitTokenUsage(boolean emitTokenUsage)
设置发出令牌用量。
Set whether to emit accumulated token usage events.
public Builder enableReasoning(boolean enableReasoning)
启用推理。
Set whether to enable reasoning/thinking content output.
public Builder emitRunFinishedAfterError(boolean emitRunFinishedAfterError)
设置该配置项。
Set whether to emit `RUN_FINISHED` after `RUN_ERROR`.
public Builder runTimeout(Duration runTimeout)
设置运行超时时长。
Set the run timeout duration.
public Builder defaultAgentId(String defaultAgentId)
设置默认智能体标识。
Set the default agent ID.
public Builder addEventConverter(AgentEventConverter eventConverter)
添加事件转换器。
Add a custom AgentEvent converter.
public Builder eventConverters(List<AgentEventConverter> eventConverters)
设置该配置项。
Replace the custom AgentEvent converters.
public Builder addEventEnricher(AguiEventEnricher eventEnricher)
添加 `addEventEnricher`。
Add an AG-UI event enricher.
public Builder eventEnrichers(List<AguiEventEnricher> eventEnrichers)
设置该配置项。
Replace the custom AG-UI event enrichers.
public Builder baseEventPropertiesEnricherEnabled(boolean baseEventPropertiesEnricherEnabled)
设置该配置项。
Set whether the default base event properties enricher should be enabled.
public Builder emitSubagentEventsAsNative(boolean emitSubagentEventsAsNative)
设置发出子智能体事件 As 原生。
Set whether subagent-sourced events should use native AG-UI event types.
public AguiAdapterConfig build()
构建配置。
Build the configuration.

方法详情Method Detail

toolMergeMode

public Builder toolMergeMode(ToolMergeMode toolMergeMode)

设置该配置项。

Set the tool merge mode.

参数Parameters
名称Name类型Type说明Description
toolMergeModeToolMergeMode工具 Merge 模式(类型 `ToolMergeMode`)。The tool merge mode
返回Returns Builder
返回当前实例,以支持链式调用。This builder
源码Source io/agentscope/core/agui/adapter/AguiAdapterConfig.java:237–240

emitStateEvents

public Builder emitStateEvents(boolean emitStateEvents)

设置发出状态事件。

Set whether to emit state events.

参数Parameters
名称Name类型Type说明Description
emitStateEventsboolean发出状态事件(类型 `boolean`)。true to emit state events
返回Returns Builder
返回当前实例,以支持链式调用。This builder
源码Source io/agentscope/core/agui/adapter/AguiAdapterConfig.java:248–251

emitToolCallArgs

public Builder emitToolCallArgs(boolean emitToolCallArgs)

设置发出工具调用参数。

Set whether to emit tool call argument events.

参数Parameters
名称Name类型Type说明Description
emitToolCallArgsboolean发出工具调用参数(类型 `boolean`)。true to emit tool call args events
返回Returns Builder
返回当前实例,以支持链式调用。This builder
源码Source io/agentscope/core/agui/adapter/AguiAdapterConfig.java:259–262

emitTokenUsage

public Builder emitTokenUsage(boolean emitTokenUsage)

设置发出令牌用量。

Set whether to emit accumulated token usage events.

参数Parameters
名称Name类型Type说明Description
emitTokenUsageboolean发出令牌用量(类型 `boolean`)。true to emit token usage events
返回Returns Builder
返回当前实例,以支持链式调用。This builder
源码Source io/agentscope/core/agui/adapter/AguiAdapterConfig.java:273–276

enableReasoning

public Builder enableReasoning(boolean enableReasoning)

启用推理。

Set whether to enable reasoning/thinking content output.

参数Parameters
名称Name类型Type说明Description
enableReasoningboolean启用推理(类型 `boolean`)。true to enable reasoning events
返回Returns Builder
返回当前实例,以支持链式调用。This builder
源码Source io/agentscope/core/agui/adapter/AguiAdapterConfig.java:288–291

emitRunFinishedAfterError

public Builder emitRunFinishedAfterError(boolean emitRunFinishedAfterError)

设置该配置项。

Set whether to emit RUN_FINISHED after RUN_ERROR.

参数Parameters
名称Name类型Type说明Description
emitRunFinishedAfterErrorboolean发出运行 Finished 之后错误(类型 `boolean`)。true to emit `RUN_FINISHED` after ` RUN_ERROR`
返回Returns Builder
返回当前实例,以支持链式调用。This builder
源码Source io/agentscope/core/agui/adapter/AguiAdapterConfig.java:304–307

runTimeout

public Builder runTimeout(Duration runTimeout)

设置运行超时时长。

Set the run timeout duration.

参数Parameters
名称Name类型Type说明Description
runTimeoutDuration超时时长。The timeout duration
返回Returns Builder
返回当前实例,以支持链式调用。This builder
源码Source io/agentscope/core/agui/adapter/AguiAdapterConfig.java:315–318

defaultAgentId

public Builder defaultAgentId(String defaultAgentId)

设置默认智能体标识。

Set the default agent ID.

参数Parameters
名称Name类型Type说明Description
defaultAgentIdString默认智能体标识。The default agent ID
返回Returns Builder
返回当前实例,以支持链式调用。This builder
源码Source io/agentscope/core/agui/adapter/AguiAdapterConfig.java:326–329

addEventConverter

public Builder addEventConverter(AgentEventConverter eventConverter)

添加事件转换器。

Add a custom AgentEvent converter.

参数Parameters
名称Name类型Type说明Description
eventConverterAgentEventConverter转换器到添加。The converter to add
返回Returns Builder
返回当前实例,以支持链式调用。This builder
源码Source io/agentscope/core/agui/adapter/AguiAdapterConfig.java:338–342

eventConverters

public Builder eventConverters(List<AgentEventConverter> eventConverters)

设置该配置项。

Replace the custom AgentEvent converters.

参数Parameters
名称Name类型Type说明Description
eventConvertersList<AgentEventConverter>事件 Converters(类型 `List`)。The converters to use
返回Returns Builder
返回当前实例,以支持链式调用。This builder
源码Source io/agentscope/core/agui/adapter/AguiAdapterConfig.java:350–356

addEventEnricher

public Builder addEventEnricher(AguiEventEnricher eventEnricher)

添加 addEventEnricher。

Add an AG-UI event enricher.

参数Parameters
名称Name类型Type说明Description
eventEnricherAguiEventEnricher事件 Enricher(类型 `AguiEventEnricher`)。The enricher to add
返回Returns Builder
返回当前实例,以支持链式调用。This builder
源码Source io/agentscope/core/agui/adapter/AguiAdapterConfig.java:364–368

eventEnrichers

public Builder eventEnrichers(List<AguiEventEnricher> eventEnrichers)

设置该配置项。

Replace the custom AG-UI event enrichers.

参数Parameters
名称Name类型Type说明Description
eventEnrichersList<AguiEventEnricher>事件 Enrichers(类型 `List`)。The enrichers to use
返回Returns Builder
返回当前实例,以支持链式调用。This builder
源码Source io/agentscope/core/agui/adapter/AguiAdapterConfig.java:376–382

baseEventPropertiesEnricherEnabled

public Builder baseEventPropertiesEnricherEnabled(boolean baseEventPropertiesEnricherEnabled)

设置该配置项。

Set whether the default base event properties enricher should be enabled.

参数Parameters
名称Name类型Type说明Description
baseEventPropertiesEnricherEnabledboolean基类事件属性 Enricher 已启用(类型 `boolean`)。true to enable the default enricher
返回Returns Builder
返回当前实例,以支持链式调用。This builder
源码Source io/agentscope/core/agui/adapter/AguiAdapterConfig.java:390–394

emitSubagentEventsAsNative

public Builder emitSubagentEventsAsNative(boolean emitSubagentEventsAsNative)

设置发出子智能体事件 As 原生。

Set whether subagent-sourced events should use native AG-UI event types.

参数Parameters
名称Name类型Type说明Description
emitSubagentEventsAsNativeboolean发出子智能体事件 As 原生(类型 `boolean`)。true for legacy native presentation
返回Returns Builder
返回当前实例,以支持链式调用。This builder
源码Source io/agentscope/core/agui/adapter/AguiAdapterConfig.java:406–409

build

public AguiAdapterConfig build()

构建配置。

Build the configuration.

返回Returns AguiAdapterConfig
内置配置。The built configuration
源码Source io/agentscope/core/agui/adapter/AguiAdapterConfig.java:416–418
基于官方固定版本源码静态生成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.