Class ToolCallAdvisor

java.lang.Object

org.springframework.ai.chat.client.advisor.ToolCallAdvisor

All Implemented Interfaces:

Advisor, CallAdvisor, StreamAdvisor, org.springframework.core.Ordered

public class ToolCallAdvisor
extends Object
implements CallAdvisor, StreamAdvisor

Recursive Advisor that disables the internal tool execution flow and instead implements the tool calling loop as part of the advisor chain.

It uses the CallAdvisorChainUtil to implement looping advisor chain calls.

This enables intercepting the tool calling loop by the rest of the advisors next in the chain.

Author:

Christian Tzolov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ToolCallAdvisor.Builder<T extends ToolCallAdvisor.Builder<T>>	Builder for creating instances of ToolCallAdvisor.

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.springframework.ai.model.tool.ToolCallingManager	toolCallingManager

Fields inherited from interface Advisor

DEFAULT_CHAT_MEMORY_PRECEDENCE_ORDER

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ToolCallAdvisor(org.springframework.ai.model.tool.ToolCallingManager toolCallingManager, int advisorOrder)
protected	ToolCallAdvisor(org.springframework.ai.model.tool.ToolCallingManager toolCallingManager, int advisorOrder, boolean conversationHistoryEnabled)

Method Summary

Modifier and Type	Method	Description
ChatClientResponse	adviseCall(ChatClientRequest chatClientRequest, CallAdvisorChain callAdvisorChain)
reactor.core.publisher.Flux<ChatClientResponse>	adviseStream(ChatClientRequest chatClientRequest, StreamAdvisorChain streamAdvisorChain)
static ToolCallAdvisor.Builder<?>	builder()	Creates a new Builder instance for constructing a ToolCallAdvisor.
protected ChatClientResponse	doAfterCall(ChatClientResponse chatClientResponse, CallAdvisorChain callAdvisorChain)
protected ChatClientRequest	doBeforeCall(ChatClientRequest chatClientRequest, CallAdvisorChain callAdvisorChain)
protected ChatClientResponse	doFinalizeLoop(ChatClientResponse chatClientResponse, CallAdvisorChain callAdvisorChain)
protected List<org.springframework.ai.chat.messages.Message>	doGetNextInstructionsForToolCall(ChatClientRequest chatClientRequest, ChatClientResponse chatClientResponse, org.springframework.ai.model.tool.ToolExecutionResult toolExecutionResult)
protected ChatClientRequest	doInitializeLoop(ChatClientRequest chatClientRequest, CallAdvisorChain callAdvisorChain)
String	getName()	Return the name of the advisor.
int	getOrder()

Methods inherited from class Object

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

Field Details

toolCallingManager

protected final org.springframework.ai.model.tool.ToolCallingManager toolCallingManager

Constructor Details

ToolCallAdvisor

protected ToolCallAdvisor(org.springframework.ai.model.tool.ToolCallingManager toolCallingManager,
 int advisorOrder)

ToolCallAdvisor

protected ToolCallAdvisor(org.springframework.ai.model.tool.ToolCallingManager toolCallingManager,
 int advisorOrder,
 boolean conversationHistoryEnabled)

Method Details

getName

public String getName()

Description copied from interface: Advisor

Return the name of the advisor.

Specified by:

getName in interface Advisor

Returns:

the advisor name.

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

adviseCall

public ChatClientResponse adviseCall(ChatClientRequest chatClientRequest,
 CallAdvisorChain callAdvisorChain)

Specified by:

adviseCall in interface CallAdvisor

doGetNextInstructionsForToolCall

protected List<org.springframework.ai.chat.messages.Message> doGetNextInstructionsForToolCall(ChatClientRequest chatClientRequest,
 ChatClientResponse chatClientResponse,
 org.springframework.ai.model.tool.ToolExecutionResult toolExecutionResult)

doFinalizeLoop

protected ChatClientResponse doFinalizeLoop(ChatClientResponse chatClientResponse,
 CallAdvisorChain callAdvisorChain)

doInitializeLoop

protected ChatClientRequest doInitializeLoop(ChatClientRequest chatClientRequest,
 CallAdvisorChain callAdvisorChain)

doBeforeCall

protected ChatClientRequest doBeforeCall(ChatClientRequest chatClientRequest,
 CallAdvisorChain callAdvisorChain)

doAfterCall

protected ChatClientResponse doAfterCall(ChatClientResponse chatClientResponse,
 CallAdvisorChain callAdvisorChain)

adviseStream

public reactor.core.publisher.Flux<ChatClientResponse> adviseStream(ChatClientRequest chatClientRequest,
 StreamAdvisorChain streamAdvisorChain)

Specified by:

adviseStream in interface StreamAdvisor

builder

public static ToolCallAdvisor.Builder<?> builder()

Creates a new Builder instance for constructing a ToolCallAdvisor.

Returns:

a new Builder instance