Class AbstractGuardrailExecutor<C extends GuardrailsConfig, P extends GuardrailRequest<P>, R extends GuardrailResult<R>, G extends Guardrail<P,R>, E extends GuardrailExecutedEvent<P,R,G>, F extends GuardrailResult.Failure>

java.lang.Object

dev.langchain4j.guardrail.AbstractGuardrailExecutor<C,P,R,G,E,F>

Type Parameters:

C - The type of GuardrailsConfig to use for configuration

P - The type of GuardrailRequest to validate

R - The type of GuardrailResult to return

G - The type of Guardrails being executed

E - The type of GuardrailExecutedEvent to be fired

F - The type of GuardrailResult.Failure to return

All Implemented Interfaces:

GuardrailExecutor<C,P,R,G,E>

Direct Known Subclasses:

InputGuardrailExecutor, OutputGuardrailExecutor

public abstract sealed class AbstractGuardrailExecutor<C extends GuardrailsConfig, P extends GuardrailRequest<P>, R extends GuardrailResult<R>, G extends Guardrail<P,R>, E extends GuardrailExecutedEvent<P,R,G>, F extends GuardrailResult.Failure>
extends Object
implements GuardrailExecutor<C,P,R,G,E>
permits InputGuardrailExecutor, OutputGuardrailExecutor

Abstract base class for GuardrailExecutors.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractGuardrailExecutor.GuardrailExecutorBuilder<C extends GuardrailsConfig, R extends GuardrailResult<R>, P extends GuardrailRequest<P>, G extends Guardrail<P,R>, E extends GuardrailExecutedEvent<P,R,G>, B extends AbstractGuardrailExecutor.GuardrailExecutorBuilder<C,R,P,G,E,B>>	A generic abstract builder class for creating instances of GuardrailExecutor.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractGuardrailExecutor(C config, List<G> guardrails)

Method Summary

Modifier and Type	Method	Description
protected R	composeResult(R oldResult, R newResult)
C	config()	The GuardrailsConfig to use for configuration of the guardrail execution
protected abstract GuardrailExecutedEvent.GuardrailExecutedEventBuilder<P,R,G,E>	createEmptyObservabilityEventBuilderInstance()	Creates an empty instance of GuardrailExecutedEvent.GuardrailExecutedEventBuilder used for constructing observability event objects.
protected abstract R	createFailure(List<F> failures)	Creates a failure result from some GuardrailResult.Failures.
protected abstract GuardrailException	createGuardrailException(String message, Throwable cause)	Creates a GuardrailException using the provided message and optional cause.
protected abstract R	createSuccess()	Creates a success result.
protected R	executeGuardrails(P request)
protected CompletableFuture<R>	executeGuardrailsAsync(P request, CancellationChain chain)	Non-blocking counterpart of executeGuardrails(GuardrailRequest): runs the configured guardrails sequentially (each guardrail sees the result of any rewrite by the previous one), firing the observability event and short-circuiting on a fatal result, without blocking the calling thread.
protected void	fireObservabilityEvent(InvocationContext invocationContext, P request, R result, G guardrail, Duration duration)
List<G>	guardrails()	Retrieves the guardrails associated with the implementation.
protected R	handleFatalResult(R accumulatedResult, R result)	Handles a fatal result.
protected R	validate(P request, G guardrail)	Validates a guardrail against a set of request.
protected CompletableFuture<R>	validateAsync(P request, G guardrail, CancellationChain chain)	Non-blocking counterpart of validate(GuardrailRequest, Guardrail): runs a single guardrail's Guardrail.validateAsync(GuardrailRequest) and wraps any failure in a GuardrailException, mirroring the synchronous error handling.

Methods inherited from class Object

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

Methods inherited from interface GuardrailExecutor

execute, executeAsync

Constructor Details

AbstractGuardrailExecutor

protected AbstractGuardrailExecutor(C config,
 List<G> guardrails)

Method Details

createFailure

protected abstract R createFailure(List<F> failures)

Creates a failure result from some GuardrailResult.Failures.

Parameters:

failures - The failures

Returns:

A GuardrailResult containing the failures

createSuccess

protected abstract R createSuccess()

Creates a success result.

Returns:

A GuardrailResult representing success

createGuardrailException

protected abstract GuardrailException createGuardrailException(String message,
 Throwable cause)

Creates a GuardrailException using the provided message and optional cause.

Parameters:

message - The detailed message for the exception.

cause - The underlying cause of the exception, or null if no cause is available.

Returns:

A new instance of GuardrailException constructed with the provided message and cause.

createEmptyObservabilityEventBuilderInstance

protected abstract GuardrailExecutedEvent.GuardrailExecutedEventBuilder<P,R,G,E> createEmptyObservabilityEventBuilderInstance()

Creates an empty instance of GuardrailExecutedEvent.GuardrailExecutedEventBuilder used for constructing observability event objects.

Returns:

An initialized instance of GuardrailExecutedEvent.GuardrailExecutedEventBuilder with the appropriate type parameters.

config

public C config()

Description copied from interface: GuardrailExecutor

The GuardrailsConfig to use for configuration of the guardrail execution

Specified by:

config in interface GuardrailExecutor<C extends GuardrailsConfig, P extends GuardrailRequest<P>, R extends GuardrailResult<R>, G extends Guardrail<P,R>, E extends GuardrailExecutedEvent<P,R,G>>

Returns:

The GuardrailsConfig to use for configuration of the guardrail execution

guardrails

public List<G> guardrails()

Description copied from interface: GuardrailExecutor

Retrieves the guardrails associated with the implementation.

Specified by:

guardrails in interface GuardrailExecutor<C extends GuardrailsConfig, P extends GuardrailRequest<P>, R extends GuardrailResult<R>, G extends Guardrail<P,R>, E extends GuardrailExecutedEvent<P,R,G>>

Returns:

The guardrails which can be used for validating inputs or outputs against predefined rules.

validate

protected R validate(P request,
 G guardrail)

Validates a guardrail against a set of request.

If any kind of Exception is thrown during validation, it will be wrapped in a GuardrailException.

Parameters:

request - The GuardrailRequest to validate

guardrail - The Guardrail to evaluate against

Returns:

The GuardrailResult of the validation

Throws:

GuardrailException - If any kind of Exception is thrown during validation

handleFatalResult

protected R handleFatalResult(R accumulatedResult,
 R result)

Handles a fatal result.

Parameters:

accumulatedResult - The accumulated result

result - The fatal result

Returns:

The fatal result, possibly wrapped/modified in some way

fireObservabilityEvent

protected void fireObservabilityEvent(InvocationContext invocationContext,
 P request,
 R result,
 G guardrail,
 Duration duration)

executeGuardrails

protected R executeGuardrails(P request)

validateAsync

protected CompletableFuture<R> validateAsync(P request,
 G guardrail,
 CancellationChain chain)

Non-blocking counterpart of validate(GuardrailRequest, Guardrail): runs a single guardrail's Guardrail.validateAsync(GuardrailRequest) and wraps any failure in a GuardrailException, mirroring the synchronous error handling.

executeGuardrailsAsync

protected CompletableFuture<R> executeGuardrailsAsync(P request,
 CancellationChain chain)

Non-blocking counterpart of executeGuardrails(GuardrailRequest): runs the configured guardrails sequentially (each guardrail sees the result of any rewrite by the previous one), firing the observability event and short-circuiting on a fatal result, without blocking the calling thread.

composeResult

protected R composeResult(R oldResult,
 R newResult)