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

Interface BaseAdvisorChain

All Superinterfaces:

AdvisorChain, CallAdvisorChain, StreamAdvisorChain

All Known Implementing Classes:

DefaultAroundAdvisorChain

public interface BaseAdvisorChain
extends CallAdvisorChain, StreamAdvisorChain

A base interface for advisor chains that can be used to chain multiple advisors together, both for call and stream advisors.

Since:

1.0.0

Author:

Thomas Vitale, Christian Tzolov

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	BaseAdvisorChain.Builder<B extends BaseAdvisorChain.Builder<B>>	Builder for creating a BaseAdvisorChain instance.

Method Summary

Modifier and Type	Method	Description
static BaseAdvisorChain.Builder<?>	builder(io.micrometer.observation.ObservationRegistry observationRegistry)	Creates a new BaseAdvisorChain.Builder for the default BaseAdvisorChain implementation.
default BaseAdvisorChain.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.

Methods inherited from interface org.springframework.ai.chat.client.advisor.api.AdvisorChain

getObservationRegistry

Methods inherited from interface org.springframework.ai.chat.client.advisor.api.CallAdvisorChain

copy, getCallAdvisors, nextCall

Methods inherited from interface org.springframework.ai.chat.client.advisor.api.StreamAdvisorChain

copy, getStreamAdvisors, nextStream

Method Details

mutate

default BaseAdvisorChain.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.

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

Returns:

a pre-populated BaseAdvisorChain.Builder

builder

static BaseAdvisorChain.Builder<?> builder(io.micrometer.observation.ObservationRegistry observationRegistry)

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

Parameters:

observationRegistry - the observation registry to use

Returns:

a new BaseAdvisorChain.Builder