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

Interface BaseAdvisor

All Superinterfaces:

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

All Known Subinterfaces:

BaseChatMemoryAdvisor

All Known Implementing Classes:

MessageChatMemoryAdvisor, PromptChatMemoryAdvisor

public interface BaseAdvisor
extends CallAdvisor, StreamAdvisor

Base advisor that implements common aspects of the CallAdvisor and StreamAdvisor, reducing the boilerplate code needed to implement an advisor.

It provides default implementations for the adviseCall(ChatClientRequest, CallAdvisorChain) and adviseStream(ChatClientRequest, StreamAdvisorChain) methods, delegating the actual logic to the before(ChatClientRequest, AdvisorChain advisorChain) and after(ChatClientResponse, AdvisorChain advisorChain) methods.

Since:

1.0.0

Author:

Thomas Vitale

Field Summary

Fields

Modifier and Type	Field	Description
static final reactor.core.scheduler.Scheduler	DEFAULT_SCHEDULER

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
default ChatClientResponse	adviseCall(ChatClientRequest chatClientRequest, CallAdvisorChain callAdvisorChain)
default reactor.core.publisher.Flux<ChatClientResponse>	adviseStream(ChatClientRequest chatClientRequest, StreamAdvisorChain streamAdvisorChain)
ChatClientResponse	after(ChatClientResponse chatClientResponse, AdvisorChain advisorChain)	Logic to be executed after the rest of the advisor chain is called.
ChatClientRequest	before(ChatClientRequest chatClientRequest, AdvisorChain advisorChain)	Logic to be executed before the rest of the advisor chain is called.
default String	getName()	Return the name of the advisor.
default reactor.core.scheduler.Scheduler	getScheduler()	Scheduler used for processing the advisor logic when streaming.

Methods inherited from interface org.springframework.core.Ordered

getOrder

Field Details

DEFAULT_SCHEDULER

static final reactor.core.scheduler.Scheduler DEFAULT_SCHEDULER

Method Details

adviseCall

default ChatClientResponse adviseCall(ChatClientRequest chatClientRequest,
 CallAdvisorChain callAdvisorChain)

Specified by:

adviseCall in interface CallAdvisor

adviseStream

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

Specified by:

adviseStream in interface StreamAdvisor

getName

default String getName()

Description copied from interface: Advisor

Return the name of the advisor.

Specified by:

getName in interface Advisor

Returns:

the advisor name.

before

ChatClientRequest before(ChatClientRequest chatClientRequest,
 AdvisorChain advisorChain)

Logic to be executed before the rest of the advisor chain is called.

after

ChatClientResponse after(ChatClientResponse chatClientResponse,
 AdvisorChain advisorChain)

Logic to be executed after the rest of the advisor chain is called.

getScheduler

default reactor.core.scheduler.Scheduler getScheduler()

Scheduler used for processing the advisor logic when streaming.