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

Class SafeGuardAdvisor

java.lang.Object

org.springframework.ai.chat.client.advisor.SafeGuardAdvisor

All Implemented Interfaces:

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

public class SafeGuardAdvisor
extends Object
implements CallAdvisor, StreamAdvisor

An advisor that blocks the call to the model provider if the user input contains any of the sensitive words.

Since:

1.0.0

Author:

Christian Tzolov, Ilayaperumal Gopinathan, Thomas Vitale

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SafeGuardAdvisor.Builder

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

Constructor Summary

Constructors

Constructor	Description
SafeGuardAdvisor(List<String> sensitiveWords)
SafeGuardAdvisor(List<String> sensitiveWords, String failureResponse, 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 SafeGuardAdvisor.Builder	builder()
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

Constructor Details

SafeGuardAdvisor

public SafeGuardAdvisor(List<String> sensitiveWords)

SafeGuardAdvisor

public SafeGuardAdvisor(List<String> sensitiveWords,
 String failureResponse,
 int order)

Method Details

builder

public static SafeGuardAdvisor.Builder builder()

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.

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

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered