AS AgentScopeAPI 手册 / API Reference

Builder

public static class Builder
源码Source io/agentscope/core/message/ToolResultBlock.java:351–432

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

Builder for constructing ToolResultBlock instances.

方法摘要Method Summary

方法Method说明Description
public Builder id(String id)
设置工具调用标识。
Sets the tool call ID.
public Builder name(String name)
设置工具名称。
Sets the tool name.
public Builder output(ContentBlock output)
设置输出。
Sets a single content block as output.
public Builder output(List<ContentBlock> output)
设置输出。
Sets a list of content blocks as output.
public Builder metadata(Map<String, Object> metadata)
设置元数据用于工具结果。
Sets the metadata for the tool result.
public Builder state(ToolResultState state)
设置工具结果状态。
Sets the tool result state.
public ToolResultBlock build()
构建并返回最终实例。
Builds a new ToolResultBlock with the configured properties.

方法详情Method Detail

id

public Builder id(String id)

设置工具调用标识。

Sets the tool call ID.

参数Parameters
名称Name类型Type说明Description
idString工具调用标识。The tool call ID
返回Returns Builder
返回当前实例,以支持链式调用。This builder for chaining
源码Source io/agentscope/core/message/ToolResultBlock.java:364–367

name

public Builder name(String name)

设置工具名称。

Sets the tool name.

参数Parameters
名称Name类型Type说明Description
nameString工具名称。The tool name
返回Returns Builder
返回当前实例,以支持链式调用。This builder for chaining
源码Source io/agentscope/core/message/ToolResultBlock.java:375–378

output

public Builder output(ContentBlock output)

设置输出。

Sets a single content block as output.

参数Parameters
名称Name类型Type说明Description
outputContentBlock输出(类型 `ContentBlock`)。Single content block
返回Returns Builder
返回当前实例,以支持链式调用。This builder for chaining
源码Source io/agentscope/core/message/ToolResultBlock.java:386–389

output

public Builder output(List<ContentBlock> output)

设置输出。

Sets a list of content blocks as output.

参数Parameters
名称Name类型Type说明Description
outputList<ContentBlock>输出(类型 `List`)。List of content blocks
返回Returns Builder
返回当前实例,以支持链式调用。This builder for chaining
源码Source io/agentscope/core/message/ToolResultBlock.java:397–400

metadata

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

设置元数据用于工具结果。

Sets the metadata for the tool result.

参数Parameters
名称Name类型Type说明Description
metadataMap<String, Object>元数据(类型 `Map`)。Metadata map
返回Returns Builder
返回当前实例,以支持链式调用。This builder for chaining
源码Source io/agentscope/core/message/ToolResultBlock.java:408–411

state

public Builder state(ToolResultState state)

设置工具结果状态。

Sets the tool result state.

参数Parameters
名称Name类型Type说明Description
stateToolResultState工具结果状态。The tool result state
返回Returns Builder
返回当前实例,以支持链式调用。This builder for chaining
源码Source io/agentscope/core/message/ToolResultBlock.java:419–422

build

public ToolResultBlock build()

构建并返回最终实例。

Builds a new ToolResultBlock with the configured properties.

返回Returns ToolResultBlock
一种新的ToolResultBlock 实例。A new ToolResultBlock instance
源码Source io/agentscope/core/message/ToolResultBlock.java:429–431
基于官方固定版本源码静态生成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.