类class io.agentscope.runtime.engine.helpers legacy

ResponseBuilder

public class ResponseBuilder

源码Source io/agentscope/runtime/engine/helpers/ResponseBuilder.java:28–542

响应构建器，用于构建并配置目标实例。位于 io.agentscope.runtime.engine.helpers 包。核心成员包括 reset、getResponseData、created、inProgress、completed、createMessageBuilder。

Response Builder. Responsible for building and managing AgentResponse objects, coordinating MessageBuilder work.

嵌套类摘要Nested Class Summary

类Class	类型Kind	说明Description
`MessageBuilder`	类class	消息构建器，用于构建并配置目标实例。 Responsible for building and managing individual Message objects and updating associated Response.
`ContentBuilder`	类class	内容构建器，用于构建并配置目标实例。 Responsible for building and managing individual Content objects, supporting Text, Image, and Data content types.

构造器摘要Constructor Summary

构造器Constructor	说明Description
`public` `ResponseBuilder()`	初始化 `ResponseBuilder` 实例。 Initialize Response Builder.
`public` `ResponseBuilder(String sessionId)`	初始化 `ResponseBuilder` 实例。 Creates a new instance.
`public` `ResponseBuilder(String sessionId, String responseId)`	初始化 `ResponseBuilder` 实例。 Creates a new instance.

方法摘要Method Summary

方法Method	说明Description
`public void reset()`	清空或重置内部状态。 Reset builder state, generate new ID and object instances.
`public` `AgentResponse getResponseData()`	获取响应数据。 Get dictionary representation of current response.
`public` `AgentResponse created()`	设置响应状态到已创建。 Set response status to created.
`public` `AgentResponse inProgress()`	设置响应状态到进行中。 Set response status to in_progress.
`public` `AgentResponse completed()`	设置响应状态到已完成。 Set response status to completed.
`public` `MessageBuilder createMessageBuilder(String role, String messageType)`	创建消息构建器。 Create Message Builder.
`public void addMessage(Message message)`	添加消息。 Add message to response output list.
`public void updateMessage(Message message)`	设置更新消息。 Update message in response.
`public Stream<Event> generateStreamingResponse(List<String> textTokens, String role)`	设置该配置项。 Generate complete streaming response sequence.

构造器详情Constructor Detail

ResponseBuilder

public ResponseBuilder()

初始化 ResponseBuilder 实例。

Initialize Response Builder.

源码Source io/agentscope/runtime/engine/helpers/ResponseBuilder.java:38–40

ResponseBuilder

public ResponseBuilder(String sessionId)

初始化 ResponseBuilder 实例。

Creates a new instance.

参数Parameters

名称Name	类型Type	说明Description
`sessionId`	String	会话标识（类型 `String`）。The session id.

源码Source io/agentscope/runtime/engine/helpers/ResponseBuilder.java:42–44

ResponseBuilder

public ResponseBuilder(String sessionId, String responseId)

初始化 ResponseBuilder 实例。

Creates a new instance.

参数Parameters

名称Name	类型Type	说明Description
`sessionId`	String	会话标识（类型 `String`）。The session id.
`responseId`	String	响应标识（类型 `String`）。The response id.

源码Source io/agentscope/runtime/engine/helpers/ResponseBuilder.java:46–59

方法详情Method Detail

reset

public void reset()

清空或重置内部状态。

Reset builder state, generate new ID and object instances.

源码Source io/agentscope/runtime/engine/helpers/ResponseBuilder.java:64–76

getResponseData

public AgentResponse getResponseData()

获取响应数据。

Get dictionary representation of current response.

返回Returns AgentResponse

返回AgentResponse。Returns agent response.

源码Source io/agentscope/runtime/engine/helpers/ResponseBuilder.java:81–83

created

public AgentResponse created()

设置响应状态到已创建。

Set response status to created.

返回Returns AgentResponse

返回AgentResponse。Returns agent response.

源码Source io/agentscope/runtime/engine/helpers/ResponseBuilder.java:88–91

inProgress

public AgentResponse inProgress()

设置响应状态到进行中。

Set response status to in_progress.

返回Returns AgentResponse

返回AgentResponse。Returns agent response.

源码Source io/agentscope/runtime/engine/helpers/ResponseBuilder.java:96–99

completed

public AgentResponse completed()

设置响应状态到已完成。

Set response status to completed.

返回Returns AgentResponse

返回AgentResponse。Returns agent response.

源码Source io/agentscope/runtime/engine/helpers/ResponseBuilder.java:104–107

createMessageBuilder

public MessageBuilder createMessageBuilder(String role, String messageType)

创建消息构建器。

Create Message Builder.

参数Parameters

名称Name	类型Type	说明Description
`role`	String	角色（类型 `String`）。Message role, defaults to assistant
`messageType`	String	消息类型（类型 `String`）。Message type, defaults to message

返回Returns MessageBuilder

返回MessageBuilder。Returns message builder.

源码Source io/agentscope/runtime/engine/helpers/ResponseBuilder.java:115–126

addMessage

public void addMessage(Message message)

添加消息。

Add message to response output list.

参数Parameters

名称Name	类型Type	说明Description
`message`	Message	消息（类型 `Message`）。The message.

源码Source io/agentscope/runtime/engine/helpers/ResponseBuilder.java:131–146

updateMessage

public void updateMessage(Message message)

设置更新消息。

Update message in response.

参数Parameters

名称Name	类型Type	说明Description
`message`	Message	消息（类型 `Message`）。The message.

源码Source io/agentscope/runtime/engine/helpers/ResponseBuilder.java:151–163

generateStreamingResponse

public Stream<Event> generateStreamingResponse(List<String> textTokens, String role)

设置该配置项。

Generate complete streaming response sequence.

参数Parameters

名称Name	类型Type	说明Description
`textTokens`	List<String>	文本令牌数（类型 `List`）。Text fragment list
`role`	String	角色（类型 `String`）。Message role, defaults to assistant

返回Returns Stream<Event>

返回流。Stream of response objects generated in order

源码Source io/agentscope/runtime/engine/helpers/ResponseBuilder.java:172–210

嵌套类详情Nested Class Detail

MessageBuilder

public class MessageBuilder

消息构建器，用于构建并配置目标实例。位于 io.agentscope.runtime.engine.helpers 包。核心成员包括 createContentBuilder、addContent、getMessageData、complete、MessageBuilder。

Responsible for building and managing individual Message objects and updating associated Response.

ContentBuilder

public class ContentBuilder

内容构建器，用于构建并配置目标实例。位于 io.agentscope.runtime.engine.helpers 包。核心成员包括 addTextDelta、setText、setImageUrl、setData、addDataDelta、complete。

Responsible for building and managing individual Content objects, supporting Text, Image, and Data content types.