AS AgentScopeAPI 手册 / API Reference

Builder

public static class Builder
源码Source io/agentscope/core/studio/StudioUserAgent.java:244–333

UserProxyAgent的构建器。位于 io.agentscope.core.studio 包。核心成员包括 name、description、studioClient、webSocketClient、inputTimeout、build。

Builder for UserProxyAgent.

方法摘要Method Summary

方法Method说明Description
public Builder name(String name)
设置智能体名称(默认:"用户")。
Sets the agent name (default: "User").
public Builder description(String description)
设置该配置项。
Sets the agent description (optional).
public Builder studioClient(StudioClient studioClient)
设置该配置项。
Sets the Studio HTTP client for requesting user input.
public Builder webSocketClient(StudioWebSocketClient webSocketClient)
设置该配置项。
Sets the Studio WebSocket client for receiving user input.
public Builder inputTimeout(Duration inputTimeout)
设置输入超时。
Sets the timeout for waiting for user input from Studio (default: 30 minutes).
public StudioUserAgent build()
构建UserProxyAgent。
Builds the UserProxyAgent.

方法详情Method Detail

name

public Builder name(String name)

设置智能体名称(默认:"用户")。

Sets the agent name (default: "User").

参数Parameters
名称Name类型Type说明Description
nameString名称(类型 `String`)。Agent name
返回Returns Builder
返回当前实例,以支持链式调用。This builder
源码Source io/agentscope/core/studio/StudioUserAgent.java:258–261

description

public Builder description(String description)

设置该配置项。

Sets the agent description (optional).

参数Parameters
名称Name类型Type说明Description
descriptionString描述(类型 `String`)。Agent description
返回Returns Builder
返回当前实例,以支持链式调用。This builder
源码Source io/agentscope/core/studio/StudioUserAgent.java:269–272

studioClient

public Builder studioClient(StudioClient studioClient)

设置该配置项。

Sets the Studio HTTP client for requesting user input.

参数Parameters
名称Name类型Type说明Description
studioClientStudioClientStudio 客户端(类型 `StudioClient`)。Studio HTTP client
返回Returns Builder
返回当前实例,以支持链式调用。This builder
源码Source io/agentscope/core/studio/StudioUserAgent.java:282–285

webSocketClient

public Builder webSocketClient(StudioWebSocketClient webSocketClient)

设置该配置项。

Sets the Studio WebSocket client for receiving user input.

参数Parameters
名称Name类型Type说明Description
webSocketClientStudioWebSocketClientWeb Socket 客户端(类型 `StudioWebSocketClient`)。Studio WebSocket client
返回Returns Builder
返回当前实例,以支持链式调用。This builder
源码Source io/agentscope/core/studio/StudioUserAgent.java:295–298

inputTimeout

public Builder inputTimeout(Duration inputTimeout)

设置输入超时。

Sets the timeout for waiting for user input from Studio (default: 30 minutes).

参数Parameters
名称Name类型Type说明Description
inputTimeoutDuration输入超时(类型 `Duration`)。Timeout duration
返回Returns Builder
返回当前实例,以支持链式调用。This builder
源码Source io/agentscope/core/studio/StudioUserAgent.java:306–309

build

public StudioUserAgent build()

构建UserProxyAgent。

Builds the UserProxyAgent.

返回Returns StudioUserAgent
一种新的UserProxyAgent 实例。A new UserProxyAgent instance
源码Source io/agentscope/core/studio/StudioUserAgent.java:327–332
基于官方固定版本源码静态生成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.