Class OutputGuardrailExecutor

java.lang.Object

dev.langchain4j.guardrail.AbstractGuardrailExecutor<OutputGuardrailsConfig, OutputGuardrailRequest, OutputGuardrailResult, OutputGuardrail, OutputGuardrailExecutedEvent, OutputGuardrailResult.Failure>

dev.langchain4j.guardrail.OutputGuardrailExecutor

All Implemented Interfaces:

GuardrailExecutor<OutputGuardrailsConfig, OutputGuardrailRequest, OutputGuardrailResult, OutputGuardrail, OutputGuardrailExecutedEvent>

public non-sealed class OutputGuardrailExecutor
extends AbstractGuardrailExecutor<OutputGuardrailsConfig, OutputGuardrailRequest, OutputGuardrailResult, OutputGuardrail, OutputGuardrailExecutedEvent, OutputGuardrailResult.Failure>

The GuardrailExecutor for OutputGuardrails.

When executing output guardrails, if any OutputGuardrail triggers a reprompt or retry, the new response has to go back through the entire chain of output guardrails to ensure the new response passes all the output guardrails.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OutputGuardrailExecutor.OutputGuardrailExecutorBuilder	Builder class for constructing instances of OutputGuardrailExecutor.

Nested classes/interfaces inherited from class AbstractGuardrailExecutor

AbstractGuardrailExecutor.GuardrailExecutorBuilder<C,R,P,G,E,B>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MAX_RETRIES_MESSAGE_TEMPLATE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OutputGuardrailExecutor(OutputGuardrailsConfig config, List<OutputGuardrail> guardrails)

Method Summary

Modifier and Type	Method	Description
static OutputGuardrailExecutor.OutputGuardrailExecutorBuilder	builder()	Creates a new instance of OutputGuardrailExecutor.OutputGuardrailExecutorBuilder.
protected OutputGuardrailExecutedEvent.OutputGuardrailExecutedEventBuilder	createEmptyObservabilityEventBuilderInstance()	Creates an empty instance of GuardrailExecutedEvent.GuardrailExecutedEventBuilder used for constructing observability event objects.
protected OutputGuardrailResult	createFailure(List<OutputGuardrailResult.Failure> failures)	Creates a failure result from some OutputGuardrailResult.Failures.
protected OutputGuardrailException	createGuardrailException(String message, Throwable cause)	Creates a GuardrailException using the provided message and optional cause.
protected OutputGuardrailResult	createSuccess()	Creates a success result.
OutputGuardrailResult	execute(OutputGuardrailRequest request)	Executes the OutputGuardrails on the given OutputGuardrailRequest.
protected OutputGuardrailResult	handleFatalResult(OutputGuardrailResult accumulatedResult, OutputGuardrailResult result)	Handles a fatal result.

Methods inherited from class AbstractGuardrailExecutor

composeResult, config, executeGuardrails, fireObservabilityEvent, guardrails, validate

Methods inherited from class Object

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

Field Details

MAX_RETRIES_MESSAGE_TEMPLATE

public static final String MAX_RETRIES_MESSAGE_TEMPLATE

See Also:

• Constant Field Values

Constructor Details

OutputGuardrailExecutor

protected OutputGuardrailExecutor(OutputGuardrailsConfig config,
 List<OutputGuardrail> guardrails)

Method Details

execute

public OutputGuardrailResult execute(OutputGuardrailRequest request)

Executes the OutputGuardrails on the given OutputGuardrailRequest.

Parameters:

request - The OutputGuardrailRequest to validate

Returns:

The OutputGuardrailResult of the validation

createFailure

protected OutputGuardrailResult createFailure(List<OutputGuardrailResult.Failure> failures)

Creates a failure result from some OutputGuardrailResult.Failures.

Specified by:

createFailure in class AbstractGuardrailExecutor<OutputGuardrailsConfig, OutputGuardrailRequest, OutputGuardrailResult, OutputGuardrail, OutputGuardrailExecutedEvent, OutputGuardrailResult.Failure>

Parameters:

failures - The failures

Returns:

A OutputGuardrailResult containing the failures

createSuccess

protected OutputGuardrailResult createSuccess()

Creates a success result.

Specified by:

createSuccess in class AbstractGuardrailExecutor<OutputGuardrailsConfig, OutputGuardrailRequest, OutputGuardrailResult, OutputGuardrail, OutputGuardrailExecutedEvent, OutputGuardrailResult.Failure>

Returns:

A OutputGuardrailResult representing success

createGuardrailException

protected OutputGuardrailException createGuardrailException(String message,
 Throwable cause)

Description copied from class: AbstractGuardrailExecutor

Creates a GuardrailException using the provided message and optional cause.

Specified by:

createGuardrailException in class AbstractGuardrailExecutor<OutputGuardrailsConfig, OutputGuardrailRequest, OutputGuardrailResult, OutputGuardrail, OutputGuardrailExecutedEvent, OutputGuardrailResult.Failure>

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.

handleFatalResult

protected OutputGuardrailResult handleFatalResult(OutputGuardrailResult accumulatedResult,
 OutputGuardrailResult result)

Description copied from class: AbstractGuardrailExecutor

Handles a fatal result.

Overrides:

handleFatalResult in class AbstractGuardrailExecutor<OutputGuardrailsConfig, OutputGuardrailRequest, OutputGuardrailResult, OutputGuardrail, OutputGuardrailExecutedEvent, OutputGuardrailResult.Failure>

Parameters:

accumulatedResult - The accumulated result

result - The fatal result

Returns:

The fatal result, possibly wrapped/modified in some way

createEmptyObservabilityEventBuilderInstance

protected OutputGuardrailExecutedEvent.OutputGuardrailExecutedEventBuilder createEmptyObservabilityEventBuilderInstance()

Description copied from class: AbstractGuardrailExecutor

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

Specified by:

createEmptyObservabilityEventBuilderInstance in class AbstractGuardrailExecutor<OutputGuardrailsConfig, OutputGuardrailRequest, OutputGuardrailResult, OutputGuardrail, OutputGuardrailExecutedEvent, OutputGuardrailResult.Failure>

Returns:

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

builder

public static OutputGuardrailExecutor.OutputGuardrailExecutorBuilder builder()

Creates a new instance of OutputGuardrailExecutor.OutputGuardrailExecutorBuilder. The builder is used to construct and configure instances of OutputGuardrailExecutor.OutputGuardrailExecutorBuilder.

Returns:

A new OutputGuardrailExecutor.OutputGuardrailExecutorBuilder instance.