Package org.springframework.ai.chat.messages

Class ToolResponseMessage.Builder

java.lang.Object

org.springframework.ai.chat.messages.ToolResponseMessage.Builder

Enclosing class:

ToolResponseMessage

public static final class ToolResponseMessage.Builder
extends Object

Builder for ToolResponseMessage.

Parts added through result(ToolResultPart), results(List) and parts(List) keep their order. The legacy responses(List) setter replaces the ToolResultParts at build() with one text-only result part per response: the new results take the place of the first result part, or are appended when there is none.

Method Summary

Modifier and Type	Method	Description
ToolResponseMessage	build()
ToolResponseMessage.Builder	metadata(Map<String,Object> metadata)
ToolResponseMessage.Builder	parts(List<MessagePart> parts)	Adds parts, in order, for example when rebuilding a persisted message.
ToolResponseMessage.Builder	responses(List<ToolResponseMessage.ToolResponse> responses)
ToolResponseMessage.Builder	result(ToolResultPart result)	Adds a tool result.
ToolResponseMessage.Builder	results(List<ToolResultPart> results)	Adds tool results, in order.

Methods inherited from class java.lang.Object

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

Method Details

result

public ToolResponseMessage.Builder result(ToolResultPart result)

Adds a tool result.

Parameters:

result - the result part

Returns:

this builder

Since:

2.1.0

results

public ToolResponseMessage.Builder results(List<ToolResultPart> results)

Adds tool results, in order.

Parameters:

results - the result parts

Returns:

this builder

Since:

2.1.0

parts

public ToolResponseMessage.Builder parts(List<MessagePart> parts)

Adds parts, in order, for example when rebuilding a persisted message.

Parameters:

parts - the parts

Returns:

this builder

Since:

2.1.0

responses

public ToolResponseMessage.Builder responses(List<ToolResponseMessage.ToolResponse> responses)

metadata

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

build

public ToolResponseMessage build()