AS AgentScopeAPI 手册 / API Reference

UserMessage

public final class UserMessage extends Msg
源码Source io/agentscope/core/message/UserMessage.java:37–174

用户消息,在智能体、模型与前端之间传递结构化消息和事件。位于 io.agentscope.core.message 包,继承自 Msg。核心成员包括 builder、UserMessage。

A Msg with MsgRole#USER pinned at construction time.

Provides convenience constructors that take a String directly (wrapped into a TextBlock) or any combination of ContentBlocks, removing the boilerplate of Msg.builder().role(USER).content(...).build().

Also offers an independent Builder for cases that need to set metadata, timestamp, usage or generateReason.

Allowed content blocks follow the rules enforced by Msg's constructor: text, image, audio, video, and data blocks.

嵌套类摘要Nested Class Summary

类Class类型Kind说明Description
Builder类class
构建器,用于构建并配置目标实例。
Fluent builder for `UserMessage`.

构造器摘要Constructor Summary

构造器Constructor说明Description
public UserMessage(String text)
初始化 `UserMessage` 实例。
Creates a new instance.
public UserMessage(String name, String text)
初始化 `UserMessage` 实例。
Creates a new instance.
public UserMessage(ContentBlock... blocks)
初始化 `UserMessage` 实例。
Creates a new instance.
public UserMessage(String name, ContentBlock... blocks)
初始化 `UserMessage` 实例。
Creates a new instance.
public UserMessage(List<ContentBlock> blocks)
初始化 `UserMessage` 实例。
Creates a new instance.

方法摘要Method Summary

方法Method说明Description
public static Builder builder()
static
返回构建器实例。
Creates a builder for `UserMessage` with a randomly generated ID and the current timestamp pre-populated.

构造器详情Constructor Detail

UserMessage

public UserMessage(String text)

初始化 UserMessage 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
textString文本(类型 `String`)。The text.
源码Source io/agentscope/core/message/UserMessage.java:39–41

UserMessage

public UserMessage(String name, String text)

初始化 UserMessage 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
nameString名称(类型 `String`)。The name.
textString文本(类型 `String`)。The text.
源码Source io/agentscope/core/message/UserMessage.java:43–52

UserMessage

public UserMessage(ContentBlock... blocks)

初始化 UserMessage 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
blocks varargsContentBlock...内容块列表(类型 `ContentBlock...`)。The blocks.
源码Source io/agentscope/core/message/UserMessage.java:54–56

UserMessage

public UserMessage(String name, ContentBlock... blocks)

初始化 UserMessage 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
nameString名称(类型 `String`)。The name.
blocks varargsContentBlock...内容块列表(类型 `ContentBlock...`)。The blocks.
源码Source io/agentscope/core/message/UserMessage.java:58–67

UserMessage

public UserMessage(List<ContentBlock> blocks)

初始化 UserMessage 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
blocksList<ContentBlock>内容块列表(类型 `List`)。The blocks.
源码Source io/agentscope/core/message/UserMessage.java:69–71

方法详情Method Detail

builder

public static Builder builder()
static

返回构建器实例。

Creates a builder for UserMessage with a randomly generated ID and the current timestamp pre-populated.

返回Returns Builder
返回当前实例,以支持链式调用。Returns the current instance for chaining.
源码Source io/agentscope/core/message/UserMessage.java:88–90

嵌套类详情Nested Class Detail

Builder

public static final class Builder extends Msg.Builder

构建器,用于构建并配置目标实例。位于 io.agentscope.core.message 包,继承自 Msg.Builder。核心成员包括 role、id、name、content、textContent、metadata。

Fluent builder for UserMessage. The role is fixed to MsgRole#USER and #role(MsgRole) is unsupported.

继承成员Inherited Members

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