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

Class DefaultAroundAdvisorChain

java.lang.Object

org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain

All Implemented Interfaces:

AdvisorChain, BaseAdvisorChain, CallAdvisorChain, StreamAdvisorChain

public class DefaultAroundAdvisorChain
extends Object
implements BaseAdvisorChain

Default implementation for the BaseAdvisorChain. Used by the ChatClient to delegate the call to the next CallAdvisor or StreamAdvisor in the chain.

Since:

1.0.0

Author:

Christian Tzolov, Dariusz Jedrzejczyk, Thomas Vitale

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DefaultAroundAdvisorChain.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final AdvisorObservationConvention	DEFAULT_OBSERVATION_CONVENTION

Method Summary

Modifier and Type	Method	Description
static DefaultAroundAdvisorChain.Builder	builder(io.micrometer.observation.ObservationRegistry observationRegistry)	Creates a new BaseAdvisorChain.Builder for the default BaseAdvisorChain implementation.
CallAdvisorChain	copy(CallAdvisor after)	Creates a new CallAdvisorChain copy that contains all advisors after the specified advisor.
StreamAdvisorChain	copy(StreamAdvisor after)	Creates a new StreamAdvisorChain copy that contains all advisors after the specified advisor.
List<CallAdvisor>	getCallAdvisors()	Returns the list of all the CallAdvisor instances included in this chain at the time of its creation.
io.micrometer.observation.ObservationRegistry	getObservationRegistry()
List<StreamAdvisor>	getStreamAdvisors()	Returns the list of all the StreamAdvisor instances included in this chain at the time of its creation.
DefaultAroundAdvisorChain.Builder	mutate()	Returns a new BaseAdvisorChain.Builder initialized with this chain's advisors and configuration, allowing it to be selectively modified before building a new chain.
ChatClientResponse	nextCall(ChatClientRequest chatClientRequest)	Invokes the next CallAdvisor in the CallAdvisorChain with the given request.
reactor.core.publisher.Flux<ChatClientResponse>	nextStream(ChatClientRequest chatClientRequest)	Invokes the next StreamAdvisor in the StreamAdvisorChain with the given request.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_OBSERVATION_CONVENTION

public static final AdvisorObservationConvention DEFAULT_OBSERVATION_CONVENTION

Method Details

builder

public static DefaultAroundAdvisorChain.Builder builder(io.micrometer.observation.ObservationRegistry observationRegistry)

Description copied from interface: BaseAdvisorChain

Creates a new BaseAdvisorChain.Builder for the default BaseAdvisorChain implementation.

Parameters:

observationRegistry - the observation registry to use

Returns:

a new BaseAdvisorChain.Builder

nextCall

public ChatClientResponse nextCall(ChatClientRequest chatClientRequest)

Description copied from interface: CallAdvisorChain

Invokes the next CallAdvisor in the CallAdvisorChain with the given request.

Specified by:

nextCall in interface CallAdvisorChain

nextStream

public reactor.core.publisher.Flux<ChatClientResponse> nextStream(ChatClientRequest chatClientRequest)

Description copied from interface: StreamAdvisorChain

Invokes the next StreamAdvisor in the StreamAdvisorChain with the given request.

Specified by:

nextStream in interface StreamAdvisorChain

copy

public CallAdvisorChain copy(CallAdvisor after)

Description copied from interface: CallAdvisorChain

Creates a new CallAdvisorChain copy that contains all advisors after the specified advisor.

Specified by:

copy in interface CallAdvisorChain

Parameters:

after - the CallAdvisor after which to copy the chain

Returns:

a new CallAdvisorChain containing all advisors after the specified advisor

copy

public StreamAdvisorChain copy(StreamAdvisor after)

Description copied from interface: StreamAdvisorChain

Creates a new StreamAdvisorChain copy that contains all advisors after the specified advisor.

Specified by:

copy in interface StreamAdvisorChain

Parameters:

after - the StreamAdvisor after which to copy the chain

Returns:

a new StreamAdvisorChain containing all advisors after the specified advisor

getCallAdvisors

public List<CallAdvisor> getCallAdvisors()

Description copied from interface: CallAdvisorChain

Returns the list of all the CallAdvisor instances included in this chain at the time of its creation.

Specified by:

getCallAdvisors in interface CallAdvisorChain

getStreamAdvisors

public List<StreamAdvisor> getStreamAdvisors()

Description copied from interface: StreamAdvisorChain

Returns the list of all the StreamAdvisor instances included in this chain at the time of its creation.

Specified by:

getStreamAdvisors in interface StreamAdvisorChain

getObservationRegistry

public io.micrometer.observation.ObservationRegistry getObservationRegistry()

Specified by:

getObservationRegistry in interface AdvisorChain

mutate

public DefaultAroundAdvisorChain.Builder mutate()

Description copied from interface: BaseAdvisorChain

Returns a new BaseAdvisorChain.Builder initialized with this chain's advisors and configuration, allowing it to be selectively modified before building a new chain.

Concrete BaseAdvisorChain classes must override this to return the most concrete builder implementation.

Specified by:

mutate in interface BaseAdvisorChain

Returns:

a pre-populated BaseAdvisorChain.Builder