Builder
public static final class Builder extends Msg.Builder源码Source
io/agentscope/core/message/ToolResultMessage.java:104–219构建器，用于构建并配置目标实例。位于 io.agentscope.core.message 包，继承自 Msg.Builder。核心成员包括 role、result、results、id、name、content。
Fluent builder for ToolResultMessage. The role is fixed to
MsgRole#TOOL and #role(MsgRole) is unsupported.
#result(String, String, String) and #result(ToolResultBlock)
append to the accumulating result list; #results(ToolResultBlock...)
and #results(List) (and the inherited content(...) setters)
replace it wholesale.
构造器摘要Constructor Summary
| 构造器Constructor | 说明Description |
|---|---|
public Builder() | 初始化 `Builder` 实例。 Creates a new instance. |
方法摘要Method Summary
构造器详情Constructor Detail
Builder
public Builder()初始化 Builder 实例。
Creates a new instance.
源码Source
io/agentscope/core/message/ToolResultMessage.java:106–109方法详情Method Detail
role
public Builder role(MsgRole role)设置角色。
Unsupported on ToolResultMessage.Builder: role is fixed to TOOL.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
role | MsgRole | 角色（类型 `MsgRole`）。The role. |
Builder返回当前实例，以支持链式调用。Returns the current instance for chaining.
源码Source
io/agentscope/core/message/ToolResultMessage.java:112–116result
public Builder result(String toolCallId, String toolName, String resultText)设置结果。
Appends a ToolResultBlock built from a tool call id, tool name and result text.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
toolCallId | String | 工具调用标识（类型 `String`）。The tool call id. |
toolName | String | 工具名称（类型 `String`）。The tool name. |
resultText | String | 结果文本（类型 `String`）。The result text. |
Builder返回当前实例，以支持链式调用。Returns the current instance for chaining.
源码Source
io/agentscope/core/message/ToolResultMessage.java:122–128result
public Builder result(ToolResultBlock block)设置结果。
Appends a single ToolResultBlock.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
block | ToolResultBlock | 内容块（类型 `ToolResultBlock`）。The block. |
Builder返回当前实例，以支持链式调用。Returns the current instance for chaining.
源码Source
io/agentscope/core/message/ToolResultMessage.java:131–139results
public Builder results(List<ToolResultBlock> results)设置结果。
Replaces all accumulated results with the given list.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
results | List<ToolResultBlock> | 结果（类型 `List`）。The results. |
Builder返回当前实例，以支持链式调用。Returns the current instance for chaining.
源码Source
io/agentscope/core/message/ToolResultMessage.java:142–145results
public Builder results(ToolResultBlock... results)设置结果。
Replaces all accumulated results with the given blocks.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
results varargs | ToolResultBlock... | 结果（类型 `ToolResultBlock...`）。The results. |
Builder返回当前实例，以支持链式调用。Returns the current instance for chaining.
源码Source
io/agentscope/core/message/ToolResultMessage.java:148–152id
public Builder id(String id)设置标识。
Performs the id operation.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
id | String | 标识（类型 `String`）。The id. |
Builder返回当前实例，以支持链式调用。Returns the current instance for chaining.
源码Source
io/agentscope/core/message/ToolResultMessage.java:154–158name
public Builder name(String name)设置名称。
Performs the name operation.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
name | String | 名称（类型 `String`）。The name. |
Builder返回当前实例，以支持链式调用。Returns the current instance for chaining.
源码Source
io/agentscope/core/message/ToolResultMessage.java:160–164content
public Builder content(List<ContentBlock> content)设置内容。
Performs the content operation.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
content | List<ContentBlock> | 内容（类型 `List`）。The content. |
Builder返回当前实例，以支持链式调用。Returns the current instance for chaining.
源码Source
io/agentscope/core/message/ToolResultMessage.java:166–170content
public Builder content(ContentBlock block)设置内容。
Performs the content operation.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
block | ContentBlock | 内容块（类型 `ContentBlock`）。The block. |
Builder返回当前实例，以支持链式调用。Returns the current instance for chaining.
源码Source
io/agentscope/core/message/ToolResultMessage.java:172–176content
public Builder content(ContentBlock... blocks)设置内容。
Performs the content operation.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
blocks varargs | ContentBlock... | 内容块列表（类型 `ContentBlock...`）。The blocks. |
Builder返回当前实例，以支持链式调用。Returns the current instance for chaining.
源码Source
io/agentscope/core/message/ToolResultMessage.java:178–182textContent
public Builder textContent(String text)设置文本内容。
Performs the text content operation.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
text | String | 文本（类型 `String`）。The text. |
Builder返回当前实例，以支持链式调用。Returns the current instance for chaining.
源码Source
io/agentscope/core/message/ToolResultMessage.java:184–188metadata
public Builder metadata(Map<String, Object> metadata)设置元数据。
Performs the metadata operation.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
metadata | Map<String, Object> | 元数据（类型 `Map`）。The metadata. |
Builder返回当前实例，以支持链式调用。Returns the current instance for chaining.
源码Source
io/agentscope/core/message/ToolResultMessage.java:190–194timestamp
public Builder timestamp(String timestamp)设置时间戳。
Performs the timestamp operation.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
timestamp | String | 时间戳（类型 `String`）。The timestamp. |
Builder返回当前实例，以支持链式调用。Returns the current instance for chaining.
源码Source
io/agentscope/core/message/ToolResultMessage.java:196–200usage
public Builder usage(ChatUsage usage)设置用量。
Performs the usage operation.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
usage | ChatUsage | 用量（类型 `ChatUsage`）。The usage. |
Builder返回当前实例，以支持链式调用。Returns the current instance for chaining.
源码Source
io/agentscope/core/message/ToolResultMessage.java:202–206generateReason
public Builder generateReason(GenerateReason reason)设置该配置项。
Performs the generate reason operation.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
reason | GenerateReason | 原因（类型 `GenerateReason`）。The reason. |
Builder返回当前实例，以支持链式调用。Returns the current instance for chaining.
源码Source
io/agentscope/core/message/ToolResultMessage.java:208–212build
public ToolResultMessage build()构建并返回最终实例。
Creates and returns an instance.
ToolResultMessage返回ToolResultMessage。Returns tool result message.
源码Source
io/agentscope/core/message/ToolResultMessage.java:214–218