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 ClassesModifier and TypeClassDescriptionstatic classBuilder class for constructing instances ofInputGuardrailExecutor.Nested classes/interfaces inherited from class AbstractGuardrailExecutor
AbstractGuardrailExecutor.GuardrailExecutorBuilder<C,R, P, G, E, B> -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedInputGuardrailExecutor(InputGuardrailsConfig config, List<InputGuardrail> guardrails) -
Method Summary
Modifier and TypeMethodDescriptionbuilder()Creates and returns a new builder forInputGuardrailExecutor.Creates an empty instance ofGuardrailExecutedEvent.GuardrailExecutedEventBuilderused for constructing observability event objects.protected InputGuardrailResultcreateFailure(List<InputGuardrailResult.Failure> failures) Creates a failure result from someInputGuardrailResult.Failures.protected InputGuardrailExceptioncreateGuardrailException(String message, Throwable cause) Creates aGuardrailExceptionusing the provided message and optional cause.protected InputGuardrailResultCreates a success result.execute(InputGuardrailRequest request) Execeutes theInputGuardrails on the givenInputGuardrailRequest.Methods inherited from class AbstractGuardrailExecutor
composeResult, config, executeGuardrails, fireObservabilityEvent, guardrails, handleFatalResult, validate
-
Constructor Details
-
InputGuardrailExecutor
-
-
Method Details
-
createFailure
Creates a failure result from someInputGuardrailResult.Failures.- Specified by:
createFailurein classAbstractGuardrailExecutor<InputGuardrailsConfig, InputGuardrailRequest, InputGuardrailResult, InputGuardrail, InputGuardrailExecutedEvent, InputGuardrailResult.Failure>- Parameters:
failures- The failures- Returns:
- A
InputGuardrailResultcontaining the failures
-
createSuccess
Creates a success result.- Specified by:
createSuccessin classAbstractGuardrailExecutor<InputGuardrailsConfig, InputGuardrailRequest, InputGuardrailResult, InputGuardrail, InputGuardrailExecutedEvent, InputGuardrailResult.Failure>- Returns:
- A
InputGuardrailResultrepresenting success
-
createGuardrailException
Description copied from class:AbstractGuardrailExecutorCreates aGuardrailExceptionusing the provided message and optional cause.- Specified by:
createGuardrailExceptionin classAbstractGuardrailExecutor<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
GuardrailExceptionconstructed with the provided message and cause.
-
createEmptyObservabilityEventBuilderInstance
protected InputGuardrailExecutedEvent.InputGuardrailExecutedEventBuilder createEmptyObservabilityEventBuilderInstance()Description copied from class:AbstractGuardrailExecutorCreates an empty instance ofGuardrailExecutedEvent.GuardrailExecutedEventBuilderused for constructing observability event objects.- Specified by:
createEmptyObservabilityEventBuilderInstancein classAbstractGuardrailExecutor<InputGuardrailsConfig, InputGuardrailRequest, InputGuardrailResult, InputGuardrail, InputGuardrailExecutedEvent, InputGuardrailResult.Failure>- Returns:
- An initialized instance of
GuardrailExecutedEvent.GuardrailExecutedEventBuilderwith the appropriate type parameters.
-
execute
Execeutes theInputGuardrails on the givenInputGuardrailRequest.- Parameters:
request- TheInputGuardrailRequestto validate- Returns:
- The
InputGuardrailResultof the validation
-
builder
Creates and returns a new builder forInputGuardrailExecutor. This builder allows for constructing and configuring anInputGuardrailExecutorinstance, enabling customization of parameters such as the configuration and input guardrails.- Returns:
- An
InputGuardrailExecutor.InputGuardrailExecutorBuilderused to createInputGuardrailExecutorinstances
-