Uses of Interface
dev.langchain4j.guardrail.Guardrail
Packages that use Guardrail
Package
Description
-
Uses of Guardrail in dev.langchain4j.guardrail
Classes in dev.langchain4j.guardrail with type parameters of type GuardrailModifier and TypeClassDescriptionclass
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> Abstract base class forGuardrailExecutor
s.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 ofGuardrailExecutor
.interface
GuardrailExecutor<C extends GuardrailsConfig, P extends GuardrailRequest<P>, R extends GuardrailResult<R>, G extends Guardrail<P,
R>, E extends GuardrailExecutedEvent<P, R, G>> Represents a mechanism to execute a set of guardrails on given parameters.Subinterfaces of Guardrail in dev.langchain4j.guardrailModifier and TypeInterfaceDescriptioninterface
An input guardrail is a rule that is applied to the input of the model to ensure that the input (i.e.interface
An output guardrail is a rule that is applied to the output of the model to ensure that the output is safe and meets the expectations.Classes in dev.langchain4j.guardrail that implement GuardrailModifier and TypeClassDescriptionclass
AnOutputGuardrail
that will check whether or not a response can be successfully deserialized to an object of typeT
from JSONMethods in dev.langchain4j.guardrail that return types with arguments of type GuardrailModifier and TypeMethodDescriptionGuardrailResult.Failure.guardrailClass()
TheGuardrail
classInputGuardrailResult.Failure.guardrailClass()
OutputGuardrailResult.Failure.guardrailClass()
Methods in dev.langchain4j.guardrail with parameters of type GuardrailModifier and TypeMethodDescriptionAbstractGuardrailExecutor.GuardrailExecutorBuilder.guardrails
(G... guardrails) Updates the builder with the specified guardrails.Method parameters in dev.langchain4j.guardrail with type arguments of type GuardrailModifier and TypeMethodDescriptiondefault GR
GuardrailResult.validatedBy
(Class<? extends Guardrail> guardrailClass) TheGuardrail
class which performed this validationGuardrailResult.Failure.withGuardrailClass
(Class<? extends Guardrail> guardrailClass) Build a failure from a specificGuardrail
classInputGuardrailResult.Failure.withGuardrailClass
(Class<? extends Guardrail> guardrailClass) Adds a guardrail class name to a failureOutputGuardrailResult.Failure.withGuardrailClass
(Class<? extends Guardrail> guardrailClass) -
Uses of Guardrail in dev.langchain4j.observability.api.event
Classes in dev.langchain4j.observability.api.event with type parameters of type GuardrailModifier and TypeInterfaceDescriptioninterface
GuardrailExecutedEvent<P extends GuardrailRequest<P>, R extends GuardrailResult<R>, G extends Guardrail<P,
R>> Represents an event that is executed when a guardrail validation occurs.static class
GuardrailExecutedEvent.GuardrailExecutedEventBuilder<P extends GuardrailRequest<P>, R extends GuardrailResult<R>, G extends Guardrail<P,
R>, T extends GuardrailExecutedEvent<P, R, G>> -
Uses of Guardrail in dev.langchain4j.observability.api.listener
Classes in dev.langchain4j.observability.api.listener with type parameters of type GuardrailModifier and TypeInterfaceDescriptioninterface
GuardrailExecutedListener<E extends GuardrailExecutedEvent<P,
R, G>, P extends GuardrailRequest<P>, R extends GuardrailResult<R>, G extends Guardrail<P, R>> Represents a listener for events of typeGuardrailExecutedEvent
, which are triggered when a guardrail validation is executed. -
Uses of Guardrail in dev.langchain4j.observability.event
Classes in dev.langchain4j.observability.event with type parameters of type GuardrailModifier and TypeClassDescriptionclass
DefaultGuardrailExecutedEvent<P extends GuardrailRequest<P>, R extends GuardrailResult<R>, G extends Guardrail<P,
R>, E extends GuardrailExecutedEvent<P, R, G>> Represents an event that is executed when a guardrail validation occurs. -
Uses of Guardrail in dev.langchain4j.spi.guardrail
Classes in dev.langchain4j.spi.guardrail with type parameters of type GuardrailModifier and TypeInterfaceDescriptioninterface
GuardrailExecutorBuilderFactory<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>> Represents a factory for creating instances ofAbstractGuardrailExecutor.GuardrailExecutorBuilder
.