Package org.springframework.ai.chat.client.advisor

Class ToolCallAdvisor

java.lang.Object

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

All Implemented Interfaces:

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

public final 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 final class	ToolCallAdvisor.Builder	Builder for creating instances of ToolCallAdvisor.

Field Summary

Fields inherited from interface org.springframework.ai.chat.client.advisor.api.Advisor

DEFAULT_CHAT_MEMORY_PRECEDENCE_ORDER

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

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.
String	getName()	Return the name of the advisor.
int	getOrder()

Methods inherited from class java.lang.Object

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

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

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