Package org.springframework.ai.model.function

Class ToolCallHelper

java.lang.Object

org.springframework.ai.chat.model.AbstractToolCallSupport

org.springframework.ai.model.function.ToolCallHelper

public class ToolCallHelper
extends AbstractToolCallSupport

Helper class that reuses the AbstractToolCallSupport to implement the function call handling logic on the client side. Used when the withProxyToolCalls(true) option is enabled.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ToolCallHelper.FunctionDefinition	Helper used to provide only the function definition, without the actual function call implementation.

Field Summary

Fields inherited from class org.springframework.ai.chat.model.AbstractToolCallSupport

functionCallbackContext, functionCallbackRegister, IS_RUNTIME_CALL

Constructor Summary

Constructors

Constructor	Description
ToolCallHelper()
ToolCallHelper(FunctionCallbackContext functionCallbackContext, FunctionCallingOptions functionCallingOptions, List<FunctionCallback> toolFunctionCallbacks)

Method Summary

Modifier and Type	Method	Description
List<Message>	buildToolCallConversation(List<Message> previousMessages, AssistantMessage assistantMessage, ToolResponseMessage toolResponseMessage)
List<Message>	handleToolCalls(Prompt prompt, ChatResponse response)
boolean	isToolCall(ChatResponse chatResponse, Set<String> toolCallFinishReasons)
ChatResponse	processCall(ChatModel chatModel, Prompt prompt, Set<String> finishReasons, Function<AssistantMessage.ToolCall,String> customFunction)
reactor.core.publisher.Flux<ChatResponse>	processStream(ChatModel chatModel, Prompt prompt, Set<String> finishReasons, Function<AssistantMessage.ToolCall,String> customFunction)

Methods inherited from class org.springframework.ai.chat.model.AbstractToolCallSupport

executeFunctions, getFunctionCallbackRegister, isProxyToolCalls, isToolCall, resolveFunctionCallbacks, runtimeFunctionCallbackConfigurations

Methods inherited from class java.lang.Object

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

Constructor Details

ToolCallHelper

public ToolCallHelper()

ToolCallHelper

public ToolCallHelper(FunctionCallbackContext functionCallbackContext,
 FunctionCallingOptions functionCallingOptions,
 List<FunctionCallback> toolFunctionCallbacks)

Method Details

isToolCall

public boolean isToolCall(ChatResponse chatResponse,
 Set<String> toolCallFinishReasons)

Overrides:

isToolCall in class AbstractToolCallSupport

buildToolCallConversation

public List<Message> buildToolCallConversation(List<Message> previousMessages,
 AssistantMessage assistantMessage,
 ToolResponseMessage toolResponseMessage)

Overrides:

buildToolCallConversation in class AbstractToolCallSupport

handleToolCalls

public List<Message> handleToolCalls(Prompt prompt,
 ChatResponse response)

Overrides:

handleToolCalls in class AbstractToolCallSupport

processStream

public reactor.core.publisher.Flux<ChatResponse> processStream(ChatModel chatModel,
 Prompt prompt,
 Set<String> finishReasons,
 Function<AssistantMessage.ToolCall,String> customFunction)

processCall

public ChatResponse processCall(ChatModel chatModel,
 Prompt prompt,
 Set<String> finishReasons,
 Function<AssistantMessage.ToolCall,String> customFunction)