Class InputGuardrailExecutor

java.lang.Object

dev.langchain4j.guardrail.AbstractGuardrailExecutor<InputGuardrailsConfig, InputGuardrailRequest, InputGuardrailResult, InputGuardrail, InputGuardrailExecutedEvent, InputGuardrailResult.Failure>

dev.langchain4j.guardrail.InputGuardrailExecutor

All Implemented Interfaces:

GuardrailExecutor<InputGuardrailsConfig, InputGuardrailRequest, InputGuardrailResult, InputGuardrail, InputGuardrailExecutedEvent>

public non-sealed class InputGuardrailExecutor
extends AbstractGuardrailExecutor<InputGuardrailsConfig, InputGuardrailRequest, InputGuardrailResult, InputGuardrail, InputGuardrailExecutedEvent, InputGuardrailResult.Failure>

The GuardrailExecutor for InputGuardrails.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InputGuardrailExecutor.InputGuardrailExecutorBuilder	Builder class for constructing instances of InputGuardrailExecutor.

Nested classes/interfaces inherited from class AbstractGuardrailExecutor

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InputGuardrailExecutor(InputGuardrailsConfig config, List<InputGuardrail> guardrails)

Method Summary

Modifier and Type	Method	Description
static InputGuardrailExecutor.InputGuardrailExecutorBuilder	builder()	Creates and returns a new builder for InputGuardrailExecutor.
protected InputGuardrailExecutedEvent.InputGuardrailExecutedEventBuilder	createEmptyObservabilityEventBuilderInstance()	Creates an empty instance of GuardrailExecutedEvent.GuardrailExecutedEventBuilder used for constructing observability event objects.
protected InputGuardrailResult	createFailure(List<InputGuardrailResult.Failure> failures)	Creates a failure result from some InputGuardrailResult.Failures.
protected InputGuardrailException	createGuardrailException(String message, Throwable cause)	Creates a GuardrailException using the provided message and optional cause.
protected InputGuardrailResult	createSuccess()	Creates a success result.
InputGuardrailResult	execute(InputGuardrailRequest request)	Execeutes the InputGuardrails on the given InputGuardrailRequest.

Methods inherited from class AbstractGuardrailExecutor

composeResult, config, executeGuardrails, fireObservabilityEvent, guardrails, handleFatalResult, validate

Methods inherited from class Object

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

Constructor Details

InputGuardrailExecutor

protected InputGuardrailExecutor(InputGuardrailsConfig config,
 List<InputGuardrail> guardrails)

Method Details

createFailure

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

Creates a failure result from some InputGuardrailResult.Failures.

Specified by:

createFailure in class AbstractGuardrailExecutor<InputGuardrailsConfig, InputGuardrailRequest, InputGuardrailResult, InputGuardrail, InputGuardrailExecutedEvent, InputGuardrailResult.Failure>

Parameters:

failures - The failures

Returns:

A InputGuardrailResult containing the failures

createSuccess

protected InputGuardrailResult createSuccess()

Creates a success result.

Specified by:

createSuccess in class AbstractGuardrailExecutor<InputGuardrailsConfig, InputGuardrailRequest, InputGuardrailResult, InputGuardrail, InputGuardrailExecutedEvent, InputGuardrailResult.Failure>

Returns:

A InputGuardrailResult representing success

createGuardrailException

protected InputGuardrailException 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<InputGuardrailsConfig, InputGuardrailRequest, InputGuardrailResult, InputGuardrail, InputGuardrailExecutedEvent, InputGuardrailResult.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.

createEmptyObservabilityEventBuilderInstance

protected InputGuardrailExecutedEvent.InputGuardrailExecutedEventBuilder 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<InputGuardrailsConfig, InputGuardrailRequest, InputGuardrailResult, InputGuardrail, InputGuardrailExecutedEvent, InputGuardrailResult.Failure>

Returns:

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

execute

public InputGuardrailResult execute(InputGuardrailRequest request)

Execeutes the InputGuardrails on the given InputGuardrailRequest.

Parameters:

request - The InputGuardrailRequest to validate

Returns:

The InputGuardrailResult of the validation

builder

public static InputGuardrailExecutor.InputGuardrailExecutorBuilder builder()

Creates and returns a new builder for InputGuardrailExecutor. This builder allows for constructing and configuring an InputGuardrailExecutor instance, enabling customization of parameters such as the configuration and input guardrails.

Returns:

An InputGuardrailExecutor.InputGuardrailExecutorBuilder used to create InputGuardrailExecutor instances