程序包 io.agentscope.core.message

类 UserMessage.Builder

java.lang.Object

io.agentscope.core.message.Msg.Builder

io.agentscope.core.message.UserMessage.Builder

封闭类:

UserMessage

public static final class UserMessage.Builder
extends Msg.Builder

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

字段概要

从类继承的字段 io.agentscope.core.message.Msg.Builder

content, id, metadata, name, role, timestamp, usage

构造器概要

构造器

构造器	说明
Builder()

方法概要

修饰符和类型	方法	说明
UserMessage	build()	Builds a new message instance with the configured properties.
UserMessage.Builder	content(ContentBlock block)	Set content from a single content block (convenience method).
UserMessage.Builder	content(ContentBlock... blocks)	Set content from varargs content blocks (convenience method).
UserMessage.Builder	content(List<ContentBlock> content)	Set content from a list of content blocks.
UserMessage.Builder	generateReason(GenerateReason reason)
UserMessage.Builder	id(String id)	Sets the unique identifier for the message.
UserMessage.Builder	metadata(Map<String,Object> metadata)	Set metadata for structured output.
UserMessage.Builder	name(String name)	Sets the optional name for the message.
UserMessage.Builder	role(MsgRole role)	Unsupported on UserMessage.Builder: role is fixed to USER.
UserMessage.Builder	textContent(String text)	Set text content from a string.
UserMessage.Builder	timestamp(String timestamp)	Sets the timestamp for the message.
UserMessage.Builder	usage(ChatUsage usage)	Sets the token usage information for this message.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

Builder

public Builder()

方法详细资料

role

public UserMessage.Builder role(MsgRole role)

Unsupported on UserMessage.Builder: role is fixed to USER.

覆盖:

role 在类中 Msg.Builder

参数:

role - The message role (user, assistant, system, or tool)

返回:

This builder for chaining

id

public UserMessage.Builder id(String id)

从类复制的说明: Msg.Builder

Sets the unique identifier for the message.

覆盖:

id 在类中 Msg.Builder

参数:

id - The message ID

返回:

This builder for chaining

name

public UserMessage.Builder name(String name)

从类复制的说明: Msg.Builder

Sets the optional name for the message.

覆盖:

name 在类中 Msg.Builder

参数:

name - The message name

返回:

This builder for chaining

content

public UserMessage.Builder content(List<ContentBlock> content)

从类复制的说明: Msg.Builder

Set content from a list of content blocks.

覆盖:

content 在类中 Msg.Builder

参数:

content - List of content blocks

返回:

This builder

content

public UserMessage.Builder content(ContentBlock block)

从类复制的说明: Msg.Builder

Set content from a single content block (convenience method). The block will be wrapped in a list automatically.

覆盖:

content 在类中 Msg.Builder

参数:

block - Single content block

返回:

This builder

content

public UserMessage.Builder content(ContentBlock... blocks)

从类复制的说明: Msg.Builder

Set content from varargs content blocks (convenience method).

覆盖:

content 在类中 Msg.Builder

参数:

blocks - Content blocks

返回:

This builder

textContent

public UserMessage.Builder textContent(String text)

从类复制的说明: Msg.Builder

Set text content from a string.

覆盖:

textContent 在类中 Msg.Builder

参数:

text - Text content

返回:

This builder

metadata

public UserMessage.Builder metadata(Map<String,Object> metadata)

从类复制的说明: Msg.Builder

Set metadata for structured output.

覆盖:

metadata 在类中 Msg.Builder

参数:

metadata - Metadata map

返回:

This builder

timestamp

public UserMessage.Builder timestamp(String timestamp)

从类复制的说明: Msg.Builder

Sets the timestamp for the message.

覆盖:

timestamp 在类中 Msg.Builder

参数:

timestamp - The timestamp string

返回:

This builder for chaining

usage

public UserMessage.Builder usage(ChatUsage usage)

从类复制的说明: Msg.Builder

Sets the token usage information for this message.

覆盖:

usage 在类中 Msg.Builder

参数:

usage - The ChatUsage containing token counts

返回:

This builder for chaining

generateReason

public UserMessage.Builder generateReason(GenerateReason reason)

覆盖:

generateReason 在类中 Msg.Builder

build

public UserMessage build()

从类复制的说明: Msg.Builder

Builds a new message instance with the configured properties. If timestamp is not set, it will be auto-generated.

覆盖:

build 在类中 Msg.Builder

返回:

A new immutable message