Package org.springframework.ai.chat.messages.part

Record Class ToolCallPart

java.lang.Object

java.lang.Record

org.springframework.ai.chat.messages.part.ToolCallPart

Record Components:

toolCall - the tool call

payload - provider data to replay with this part, or null

attributes - free-form attributes, copied and unmodifiable

All Implemented Interfaces:

MessagePart

public record ToolCallPart(AssistantMessage.ToolCall toolCall, @Nullable OpaquePayload payload, Map<String,String> attributes)
extends Record
implements MessagePart

A tool call requested by the model.

The payload() slot exists on tool calls because some providers attach their reasoning token to the call rather than to a ReasoningPart (for example a Gemini thought_signature).

Since:

2.1.0

Author:

Christian Tzolov

Constructor Summary

Constructors

Constructor	Description
ToolCallPart(AssistantMessage.ToolCall toolCall, @Nullable OpaquePayload payload, Map<String,String> attributes)	Creates an instance of a ToolCallPart record class.

Method Summary

Modifier and Type	Method	Description
Map<String,String>	attributes()	Returns the value of the attributes record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
static ToolCallPart	of(AssistantMessage.ToolCall toolCall)	Creates a tool call part without payload or attributes.
@Nullable OpaquePayload	payload()	Returns the value of the payload record component.
AssistantMessage.ToolCall	toolCall()	Returns the value of the toolCall record component.
final String	toString()	Returns a string representation of this record class.
ToolCallPart	withAttributes(Map<String,String> attributes)	Returns a copy of this part with the given attributes replacing the current ones.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ToolCallPart

public ToolCallPart(AssistantMessage.ToolCall toolCall,
 @Nullable OpaquePayload payload,
 Map<String,String> attributes)

Creates an instance of a ToolCallPart record class.

Parameters:

toolCall - the value for the toolCall record component

payload - the value for the payload record component

attributes - the value for the attributes record component

Method Details

withAttributes

public ToolCallPart withAttributes(Map<String,String> attributes)

Description copied from interface: MessagePart

Returns a copy of this part with the given attributes replacing the current ones. All other components are unchanged.

Specified by:

withAttributes in interface MessagePart

Parameters:

attributes - the new attributes, copied

Returns:

the copy

of

public static ToolCallPart of(AssistantMessage.ToolCall toolCall)

Creates a tool call part without payload or attributes.

Parameters:

toolCall - the tool call

Returns:

the part

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

toolCall

public AssistantMessage.ToolCall toolCall()

Returns the value of the toolCall record component.

Returns:

the value of the toolCall record component

payload

public @Nullable OpaquePayload payload()

Returns the value of the payload record component.

Specified by:

payload in interface MessagePart

Returns:

the value of the payload record component

attributes

public Map<String,String> attributes()

Returns the value of the attributes record component.

Specified by:

attributes in interface MessagePart

Returns:

the value of the attributes record component