AS AgentScopeAPI 手册 / API Reference

ChatUiRequest

public record ChatUiRequest(String peerId, String agentId, String subagentId, List<Msg> messages)
源码Source io/agentscope/harness/agent/gateway/channel/chatui/ChatUiRequest.java:42–91

用于ChatUiChannel的请求对象。位于 io.agentscope.harness.agent.gateway.channel.chatui 包。核心成员包括 peerId、agentId、subagentId、messages、of、withPeer。

Request object for ChatUiChannel. Carries the peer identity (optional) and the messages to send to the agent.

The peerId is used by the channel router to build a stable session key:

  • If peerId is null and the channel's DmScope is MAIN, all requests share one session — convenient for single-user or testing scenarios.

  • If peerId is provided, each distinct peer gets its own session (when using PER_PEER or similar scopes).

记录组件摘要Record Component Summary

组件Component类型Type说明Description
peerIdString
执行对端标识相关操作。
optional user / peer identifier; null means "no peer" (single-session mode)
agentIdString
执行智能体标识相关操作。
optional explicit agent override; null for normal binding-driven routing
subagentIdString
执行子智能体标识相关操作。
optional exposed subagent id for direct subagent routing; null for normal routing
messagesList<Msg>
执行消息相关操作。
one or more messages to send

构造器摘要Constructor Summary

构造器Constructor说明Description
public ChatUiRequest(String peerId, String agentId, String subagentId, List<Msg> messages)
初始化 `ChatUiRequest` 实例。
Creates a new instance.

方法摘要Method Summary

方法Method说明Description
public static ChatUiRequest of(String text)
static
创建并返回实例。
Single user-text message in single-session mode (no peer).
public static ChatUiRequest withPeer(String peerId, String text)
static
执行使用对端相关操作。
Single user-text message associated with a specific peer id.
public static ChatUiRequest forAgent(String peerId, String agentId, String text)
static
执行用于智能体相关操作。
Single user-text message targeted at a specific agent.
public static ChatUiRequest toSubagent(String subagentId, String text)
static
执行到子智能体相关操作。
Single user-text message routed directly to an exposed subagent.
public static ChatUiRequest of(List<Msg> messages)
static
创建并返回实例。
Multi-message request without a peer (single-session mode).
public static ChatUiRequest withPeer(String peerId, List<Msg> messages)
static
执行使用对端相关操作。
Multi-message request for a specific peer.

记录组件详情Record Component Detail

peerId

String peerId

执行对端标识相关操作。

optional user / peer identifier; null means "no peer" (single-session mode)

源码Source io/agentscope/harness/agent/gateway/channel/chatui/ChatUiRequest.java:42–91

agentId

String agentId

执行智能体标识相关操作。

optional explicit agent override; null for normal binding-driven routing

源码Source io/agentscope/harness/agent/gateway/channel/chatui/ChatUiRequest.java:42–91

subagentId

String subagentId

执行子智能体标识相关操作。

optional exposed subagent id for direct subagent routing; null for normal routing

源码Source io/agentscope/harness/agent/gateway/channel/chatui/ChatUiRequest.java:42–91

messages

List<Msg> messages

执行消息相关操作。

one or more messages to send

源码Source io/agentscope/harness/agent/gateway/channel/chatui/ChatUiRequest.java:42–91

构造器详情Constructor Detail

ChatUiRequest

public ChatUiRequest(String peerId, String agentId, String subagentId, List<Msg> messages)

初始化 ChatUiRequest 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
peerIdString对端标识(类型 `String`)。The peer id.
agentIdString智能体标识(类型 `String`)。The agent id.
subagentIdString子智能体标识(类型 `String`)。The subagent id.
messagesList<Msg>消息列表(类型 `List`)。The messages.
源码Source io/agentscope/harness/agent/gateway/channel/chatui/ChatUiRequest.java:44–49

方法详情Method Detail

of

public static ChatUiRequest of(String text)
static

创建并返回实例。

Single user-text message in single-session mode (no peer).

参数Parameters
名称Name类型Type说明Description
textString文本(类型 `String`)。The text.
返回Returns ChatUiRequest
返回ChatUiRequest。Returns chat ui request.
源码Source io/agentscope/harness/agent/gateway/channel/chatui/ChatUiRequest.java:52–55

withPeer

public static ChatUiRequest withPeer(String peerId, String text)
static

执行使用对端相关操作。

Single user-text message associated with a specific peer id.

参数Parameters
名称Name类型Type说明Description
peerIdString对端标识(类型 `String`)。The peer id.
textString文本(类型 `String`)。The text.
返回Returns ChatUiRequest
返回ChatUiRequest。Returns chat ui request.
源码Source io/agentscope/harness/agent/gateway/channel/chatui/ChatUiRequest.java:58–62

forAgent

public static ChatUiRequest forAgent(String peerId, String agentId, String text)
static

执行用于智能体相关操作。

Single user-text message targeted at a specific agent.

参数Parameters
名称Name类型Type说明Description
peerIdString对端标识(类型 `String`)。The peer id.
agentIdString智能体标识(类型 `String`)。The agent id.
textString文本(类型 `String`)。The text.
返回Returns ChatUiRequest
返回ChatUiRequest。Returns chat ui request.
源码Source io/agentscope/harness/agent/gateway/channel/chatui/ChatUiRequest.java:65–69

toSubagent

public static ChatUiRequest toSubagent(String subagentId, String text)
static

执行到子智能体相关操作。

Single user-text message routed directly to an exposed subagent.

参数Parameters
名称Name类型Type说明Description
subagentIdString子智能体标识(类型 `String`)。The subagent id.
textString文本(类型 `String`)。The text.
返回Returns ChatUiRequest
返回ChatUiRequest。Returns chat ui request.
源码Source io/agentscope/harness/agent/gateway/channel/chatui/ChatUiRequest.java:72–76

of

public static ChatUiRequest of(List<Msg> messages)
static

创建并返回实例。

Multi-message request without a peer (single-session mode).

参数Parameters
名称Name类型Type说明Description
messagesList<Msg>消息列表(类型 `List`)。The messages.
返回Returns ChatUiRequest
返回ChatUiRequest。Returns chat ui request.
源码Source io/agentscope/harness/agent/gateway/channel/chatui/ChatUiRequest.java:79–81

withPeer

public static ChatUiRequest withPeer(String peerId, List<Msg> messages)
static

执行使用对端相关操作。

Multi-message request for a specific peer.

参数Parameters
名称Name类型Type说明Description
peerIdString对端标识(类型 `String`)。The peer id.
messagesList<Msg>消息列表(类型 `List`)。The messages.
返回Returns ChatUiRequest
返回ChatUiRequest。Returns chat ui request.
源码Source io/agentscope/harness/agent/gateway/channel/chatui/ChatUiRequest.java:84–86
基于官方固定版本源码静态生成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.