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

Class SimpleLoggerAdvisor

java.lang.Object

org.springframework.ai.chat.client.advisor.SimpleLoggerAdvisor

All Implemented Interfaces:

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

public class SimpleLoggerAdvisor
extends Object
implements CallAdvisor, StreamAdvisor

A simple logger advisor that logs the request and response messages.

Author:

Christian Tzolov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SimpleLoggerAdvisor.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final Function<ChatClientRequest,String>	DEFAULT_REQUEST_TO_STRING
static final Function<org.springframework.ai.chat.model.ChatResponse,String>	DEFAULT_RESPONSE_TO_STRING

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

Constructor Summary

Constructors

Constructor	Description
SimpleLoggerAdvisor()
SimpleLoggerAdvisor(int order)
SimpleLoggerAdvisor(Function<ChatClientRequest,String> requestToString, Function<org.springframework.ai.chat.model.ChatResponse,String> responseToString, int order)

Method Summary

Modifier and Type	Method	Description
ChatClientResponse	adviseCall(ChatClientRequest chatClientRequest, CallAdvisorChain callAdvisorChain)
reactor.core.publisher.Flux<ChatClientResponse>	adviseStream(ChatClientRequest chatClientRequest, StreamAdvisorChain streamAdvisorChain)
static SimpleLoggerAdvisor.Builder	builder()
String	getName()	Return the name of the advisor.
int	getOrder()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_REQUEST_TO_STRING

public static final Function<ChatClientRequest,String> DEFAULT_REQUEST_TO_STRING

DEFAULT_RESPONSE_TO_STRING

public static final Function<org.springframework.ai.chat.model.ChatResponse,String> DEFAULT_RESPONSE_TO_STRING

Constructor Details

SimpleLoggerAdvisor

public SimpleLoggerAdvisor()

SimpleLoggerAdvisor

public SimpleLoggerAdvisor(int order)

SimpleLoggerAdvisor

public SimpleLoggerAdvisor(@Nullable
 Function<ChatClientRequest,String> requestToString,
 @Nullable
 Function<org.springframework.ai.chat.model.ChatResponse,String> responseToString,
 int order)

Method Details

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

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

toString

public String toString()

Overrides:

toString in class Object

builder

public static SimpleLoggerAdvisor.Builder builder()