类class io.agentscope.core.message 2.x

ToolResultBlock

public final class ToolResultBlock extends ContentBlock

源码Source io/agentscope/core/message/ToolResultBlock.java:35–433

表示结果的工具执行。位于 io.agentscope.core.message 包，继承自 ContentBlock。核心成员包括 getId、getName、getOutput、getMetadata、getState、withState。

Represents the result of a tool execution.

This class serves two purposes: 1. As a return value from tool methods (id and name are null) 2. As a ContentBlock in messages (id and name are required)

Supports metadata for passing additional execution information.

嵌套类摘要Nested Class Summary

类Class	类型Kind	说明Description
`Builder`	类class	构建器，用于构建并配置目标实例。 Builder for constructing ToolResultBlock instances.

字段摘要Field Summary

字段Field	类型Type	说明Description
`METADATA_SUSPENDED` staticfinal	String	元数据 SUSPENDED字段。 Metadata key indicating this result is suspended for external execution.

构造器摘要Constructor Summary

构造器Constructor	说明Description
`public` `ToolResultBlock(String id, String name, List<ContentBlock> output, Map<String, Object> metadata, ToolResultState state)`	初始化 `ToolResultBlock` 实例。 Creates a new instance.
`public` `ToolResultBlock(String id, String name, List<ContentBlock> output, Map<String, Object> metadata)`	初始化 `ToolResultBlock` 实例。 Creates a new instance.
`public` `ToolResultBlock(String id, String name, ContentBlock output)`	初始化 `ToolResultBlock` 实例。 Creates a tool result block with a single content block output.
`public` `ToolResultBlock(String id, String name, List<ContentBlock> output)`	初始化 `ToolResultBlock` 实例。 Creates a tool result block with a list of content blocks as output.

方法摘要Method Summary

方法Method	说明Description
`public String getId()`	获取工具调用标识。 Gets the tool call ID.
`public String getName()`	获取工具名称。 Gets the tool name.
`public List<ContentBlock> getOutput()`	获取输出。 Gets the output content blocks.
`public Map<String, Object> getMetadata()`	获取元数据。 Gets the metadata associated with the tool result.
`public` `ToolResultState getState()`	获取工具结果状态。 Gets the tool result state.
`public` `ToolResultBlock withState(ToolResultState state)`	执行使用状态相关操作。 Returns a copy of this block with the given state.
`public boolean isSuspended()`	判断是否 `isSuspended`。 Checks if this result is suspended for external execution.
`public static` `ToolResultBlock suspended(ToolUseBlock toolUse, ToolSuspendException exception)` static	执行 `suspended` 方法。 Creates a suspended tool result from a ToolSuspendException.
`public static` `ToolResultBlock suspended(ToolUseBlock toolUse)` static	设置该参数。 Creates a suspended tool result with default message.
`public static` `ToolResultBlock text(String text)` static	设置文本。 Create a simple text result (for tool method return values).
`public static` `ToolResultBlock error(String errorMessage)` static	设置错误。 Create an error result (for tool method return values).
`public static` `ToolResultBlock error(String toolId, String errorMessage)` static	创建错误结果用于工具调用。 Create an error result for a tool call.
`public static` `ToolResultBlock of(ContentBlock output)` static	创建并返回实例。 Create a result with output only (for tool method return values).
`public static` `ToolResultBlock of(List<ContentBlock> output)` static	创建并返回实例。 Create a result with output list only (for tool method return values).
`public static` `ToolResultBlock of(ContentBlock output, Map<String, Object> metadata)` static	创建并返回实例。 Create a result with output and metadata (for tool method return values).
`public static` `ToolResultBlock of(List<ContentBlock> output, Map<String, Object> metadata)` static	创建并返回实例。 Create a result with output list and metadata (for tool method return values).
`public static` `ToolResultBlock of(String id, String name, ContentBlock output)` static	创建结果使用标识,名称,和输出(用于消息 ContentBlock)。 Create a result with id, name, and output (for message ContentBlock).
`public static` `ToolResultBlock of(String id, String name, List<ContentBlock> output)` static	创建结果使用标识,名称,和输出列出(用于消息 ContentBlock)。 Create a result with id, name, and output list (for message ContentBlock).
`public static` `ToolResultBlock of(String id, String name, ContentBlock output, Map<String, Object> metadata)` static	创建并返回实例。 Create a result with all fields (for message ContentBlock with metadata).
`public static` `ToolResultBlock of(String id, String name, List<ContentBlock> output, Map<String, Object> metadata)` static	创建并返回实例。 Create a result with all fields including output list (for message ContentBlock with metadata).
`public` `ToolResultBlock withIdAndName(String id, String name)`	创建ToolResultBlock 用于使用 in 消息通过设置标识和名称。 Create a ToolResultBlock for use in messages by setting id and name.
`public static Builder builder()` static	返回构建器实例。 Creates a new builder for constructing ToolResultBlock instances.

字段详情Field Detail

METADATA_SUSPENDED

public static final String METADATA_SUSPENDED

staticfinal

元数据 SUSPENDED字段。声明为 public static final String METADATA_SUSPENDED。

Metadata key indicating this result is suspended for external execution.

源码Source io/agentscope/core/message/ToolResultBlock.java:38

构造器详情Constructor Detail

ToolResultBlock

public ToolResultBlock(String id, String name, List<ContentBlock> output, Map<String, Object> metadata, ToolResultState state)

初始化 ToolResultBlock 实例。

Creates a new instance.

参数Parameters

名称Name	类型Type	说明Description
`id`	String	标识（类型 `String`）。The id.
`name`	String	名称（类型 `String`）。The name.
`output`	List<ContentBlock>	输出（类型 `List`）。The output.
`metadata`	Map<String, Object>	元数据（类型 `Map`）。The metadata.
`state`	ToolResultState	状态对象（类型 `ToolResultState`）。The state.

源码Source io/agentscope/core/message/ToolResultBlock.java:46–58

ToolResultBlock

public ToolResultBlock(String id, String name, List<ContentBlock> output, Map<String, Object> metadata)

初始化 ToolResultBlock 实例。

Creates a new instance.

参数Parameters

名称Name	类型Type	说明Description
`id`	String	标识（类型 `String`）。The id.
`name`	String	名称（类型 `String`）。The name.
`output`	List<ContentBlock>	输出（类型 `List`）。The output.
`metadata`	Map<String, Object>	元数据（类型 `Map`）。The metadata.

源码Source io/agentscope/core/message/ToolResultBlock.java:60–63

ToolResultBlock

public ToolResultBlock(String id, String name, ContentBlock output)

初始化 ToolResultBlock 实例。

Creates a tool result block with a single content block output.

参数Parameters

名称Name	类型Type	说明Description
`id`	String	标识（类型 `String`）。Tool call ID
`name`	String	名称（类型 `String`）。Tool name
`output`	ContentBlock	输出（类型 `ContentBlock`）。Single content block as output

源码Source io/agentscope/core/message/ToolResultBlock.java:72–74

ToolResultBlock

public ToolResultBlock(String id, String name, List<ContentBlock> output)

初始化 ToolResultBlock 实例。

Creates a tool result block with a list of content blocks as output.

参数Parameters

名称Name	类型Type	说明Description
`id`	String	标识（类型 `String`）。Tool call ID
`name`	String	名称（类型 `String`）。Tool name
`output`	List<ContentBlock>	输出（类型 `List`）。List of content blocks as output

源码Source io/agentscope/core/message/ToolResultBlock.java:83–85

方法详情Method Detail

getId

public String getId()

获取工具调用标识。

Gets the tool call ID.

返回Returns String

返回字符串结果。The tool call ID, or null if not set

源码Source io/agentscope/core/message/ToolResultBlock.java:92–94

getName

public String getName()

获取工具名称。

Gets the tool name.

返回Returns String

返回字符串结果。The tool name, or null if not set

源码Source io/agentscope/core/message/ToolResultBlock.java:101–103

getOutput

public List<ContentBlock> getOutput()

获取输出。

Gets the output content blocks.

返回Returns List<ContentBlock>

返回列出。Immutable list of content blocks representing the tool output

源码Source io/agentscope/core/message/ToolResultBlock.java:110–112

getMetadata

public Map<String, Object> getMetadata()

获取元数据。

Gets the metadata associated with the tool result.

返回Returns Map<String, Object>

返回映射。Immutable metadata map, or empty map if not set

源码Source io/agentscope/core/message/ToolResultBlock.java:119–121

getState

public ToolResultState getState()

获取工具结果状态。

Gets the tool result state.

返回Returns ToolResultState

工具结果状态。The tool result state

源码Source io/agentscope/core/message/ToolResultBlock.java:128–130

withState

public ToolResultBlock withState(ToolResultState state)

执行使用状态相关操作。

Returns a copy of this block with the given state.

参数Parameters

名称Name	类型Type	说明Description
`state`	ToolResultState	新的状态。The new state

返回Returns ToolResultBlock

一种新的ToolResultBlock 使用已更新状态。A new ToolResultBlock with the updated state

源码Source io/agentscope/core/message/ToolResultBlock.java:138–140

isSuspended

public boolean isSuspended()

判断是否 isSuspended。

Checks if this result is suspended for external execution.

返回Returns boolean

返回布尔值，表示判断结果。true if this result is suspended, false otherwise

源码Source io/agentscope/core/message/ToolResultBlock.java:150–154

suspended

public static ToolResultBlock suspended(ToolUseBlock toolUse, ToolSuspendException exception)

static

执行 suspended 方法。

Creates a suspended tool result from a ToolSuspendException.

参数Parameters

名称Name	类型Type	说明Description
`toolUse`	ToolUseBlock	工具使用（类型 `ToolUseBlock`）。The tool use block that triggered the exception
`exception`	ToolSuspendException	异常（类型 `ToolSuspendException`）。The exception thrown by the tool

返回Returns ToolResultBlock

返回ToolResultBlock。A suspended ToolResultBlock

源码Source io/agentscope/core/message/ToolResultBlock.java:166–176

suspended

public static ToolResultBlock suspended(ToolUseBlock toolUse)

static

设置该参数。

Creates a suspended tool result with default message.

参数Parameters

名称Name	类型Type	说明Description
`toolUse`	ToolUseBlock	工具使用（类型 `ToolUseBlock`）。The tool use block that requires external execution

返回Returns ToolResultBlock

返回ToolResultBlock。A suspended ToolResultBlock

源码Source io/agentscope/core/message/ToolResultBlock.java:184–186

text

public static ToolResultBlock text(String text)

static

设置文本。

Create a simple text result (for tool method return values).

参数Parameters

名称Name	类型Type	说明Description
`text`	String	文本（类型 `String`）。Text content

返回Returns ToolResultBlock

返回ToolResultBlock。ToolResultBlock with text output

源码Source io/agentscope/core/message/ToolResultBlock.java:194–197

error

public static ToolResultBlock error(String errorMessage)

static

设置错误。

Create an error result (for tool method return values).

参数Parameters

名称Name	类型Type	说明Description
`errorMessage`	String	错误消息（类型 `String`）。Error message

返回Returns ToolResultBlock

返回ToolResultBlock。ToolResultBlock with error output

源码Source io/agentscope/core/message/ToolResultBlock.java:205–212

error

public static ToolResultBlock error(String toolId, String errorMessage)

static

创建错误结果用于工具调用。

Create an error result for a tool call.

参数Parameters

名称Name	类型Type	说明Description
`toolId`	String	工具标识（类型 `String`）。Tool call ID
`errorMessage`	String	错误消息（类型 `String`）。Error message

返回Returns ToolResultBlock

用于使用 in 消息的错误 ToolResultBlock。Error ToolResultBlock for use in a message

源码Source io/agentscope/core/message/ToolResultBlock.java:224–231

of

public static ToolResultBlock of(ContentBlock output)

static

创建并返回实例。

Create a result with output only (for tool method return values).

参数Parameters

名称Name	类型Type	说明Description
`output`	ContentBlock	输出（类型 `ContentBlock`）。Content block output

返回Returns ToolResultBlock

返回ToolResultBlock。ToolResultBlock with the given output

源码Source io/agentscope/core/message/ToolResultBlock.java:239–241

of

public static ToolResultBlock of(List<ContentBlock> output)

static

创建并返回实例。

Create a result with output list only (for tool method return values).

参数Parameters

名称Name	类型Type	说明Description
`output`	List<ContentBlock>	输出（类型 `List`）。List of content blocks

返回Returns ToolResultBlock

返回ToolResultBlock。ToolResultBlock with the given output

源码Source io/agentscope/core/message/ToolResultBlock.java:249–251

of

public static ToolResultBlock of(ContentBlock output, Map<String, Object> metadata)

static

创建并返回实例。

Create a result with output and metadata (for tool method return values).

参数Parameters

名称Name	类型Type	说明Description
`output`	ContentBlock	输出（类型 `ContentBlock`）。Content block output
`metadata`	Map<String, Object>	元数据（类型 `Map`）。Metadata map

返回Returns ToolResultBlock

返回ToolResultBlock。ToolResultBlock with output and metadata

源码Source io/agentscope/core/message/ToolResultBlock.java:260–262

of

public static ToolResultBlock of(List<ContentBlock> output, Map<String, Object> metadata)

static

创建并返回实例。

Create a result with output list and metadata (for tool method return values).

参数Parameters

名称Name	类型Type	说明Description
`output`	List<ContentBlock>	输出（类型 `List`）。List of content blocks
`metadata`	Map<String, Object>	元数据（类型 `Map`）。Metadata map

返回Returns ToolResultBlock

返回ToolResultBlock。ToolResultBlock with output and metadata

源码Source io/agentscope/core/message/ToolResultBlock.java:271–273

of

public static ToolResultBlock of(String id, String name, ContentBlock output)

static

创建结果使用标识,名称,和输出(用于消息 ContentBlock)。

Create a result with id, name, and output (for message ContentBlock).

参数Parameters

名称Name	类型Type	说明Description
`id`	String	标识（类型 `String`）。Tool call ID
`name`	String	名称（类型 `String`）。Tool name
`output`	ContentBlock	输出（类型 `ContentBlock`）。Content block output

返回Returns ToolResultBlock

用于使用 in 消息的ToolResultBlock。ToolResultBlock for use in messages

源码Source io/agentscope/core/message/ToolResultBlock.java:283–285

of

public static ToolResultBlock of(String id, String name, List<ContentBlock> output)

static

创建结果使用标识,名称,和输出列出(用于消息 ContentBlock)。

Create a result with id, name, and output list (for message ContentBlock).

参数Parameters

名称Name	类型Type	说明Description
`id`	String	标识（类型 `String`）。Tool call ID
`name`	String	名称（类型 `String`）。Tool name
`output`	List<ContentBlock>	输出（类型 `List`）。List of content blocks

返回Returns ToolResultBlock

用于使用 in 消息的ToolResultBlock。ToolResultBlock for use in messages

源码Source io/agentscope/core/message/ToolResultBlock.java:295–297

of

public static ToolResultBlock of(String id, String name, ContentBlock output, Map<String, Object> metadata)

static

创建并返回实例。

Create a result with all fields (for message ContentBlock with metadata).

参数Parameters

名称Name	类型Type	说明Description
`id`	String	标识（类型 `String`）。Tool call ID
`name`	String	名称（类型 `String`）。Tool name
`output`	ContentBlock	输出（类型 `ContentBlock`）。Content block output
`metadata`	Map<String, Object>	元数据（类型 `Map`）。Metadata map

返回Returns ToolResultBlock

返回ToolResultBlock。ToolResultBlock with all fields

源码Source io/agentscope/core/message/ToolResultBlock.java:308–311

of

public static ToolResultBlock of(String id, String name, List<ContentBlock> output, Map<String, Object> metadata)

static

创建并返回实例。

Create a result with all fields including output list (for message ContentBlock with metadata).

参数Parameters

名称Name	类型Type	说明Description
`id`	String	标识（类型 `String`）。Tool call ID
`name`	String	名称（类型 `String`）。Tool name
`output`	List<ContentBlock>	输出（类型 `List`）。List of content blocks
`metadata`	Map<String, Object>	元数据（类型 `Map`）。Metadata map

返回Returns ToolResultBlock

返回ToolResultBlock。ToolResultBlock with all fields

源码Source io/agentscope/core/message/ToolResultBlock.java:323–326

withIdAndName

public ToolResultBlock withIdAndName(String id, String name)

创建ToolResultBlock 用于使用 in 消息通过设置标识和名称。

Create a ToolResultBlock for use in messages by setting id and name.

参数Parameters

名称Name	类型Type	说明Description
`id`	String	标识（类型 `String`）。Tool call ID
`name`	String	名称（类型 `String`）。Tool name

返回Returns ToolResultBlock

返回ToolResultBlock。New ToolResultBlock with id and name set

源码Source io/agentscope/core/message/ToolResultBlock.java:335–337

builder

public static Builder builder()

static

返回构建器实例。

Creates a new builder for constructing ToolResultBlock instances.

返回Returns Builder

一种新的构建器实例。A new builder instance

源码Source io/agentscope/core/message/ToolResultBlock.java:344–346

嵌套类详情Nested Class Detail

Builder

public static class Builder

构建器，用于构建并配置目标实例。位于 io.agentscope.core.message 包。核心成员包括 id、name、output、metadata、state、build。

Builder for constructing ToolResultBlock instances.