Class DefaultGuardrailExecutedEvent<P extends GuardrailRequest<P>, R extends GuardrailResult<R>, G extends Guardrail<P,R>, E extends GuardrailExecutedEvent<P,R,G>>

java.lang.Object

dev.langchain4j.observability.event.AbstractAiServiceEvent

dev.langchain4j.observability.event.DefaultGuardrailExecutedEvent<P,R,G,E>

Type Parameters:

P - the type of guardrail parameters used in the validation process

R - the type of guardrail result produced by the validation process

G - the type of guardrail class used in the validation process

All Implemented Interfaces:

AiServiceEvent, GuardrailExecutedEvent<P,R,G>

Direct Known Subclasses:

DefaultInputGuardrailExecutedEvent, DefaultOutputGuardrailExecutedEvent

public abstract class DefaultGuardrailExecutedEvent<P extends GuardrailRequest<P>, R extends GuardrailResult<R>, G extends Guardrail<P,R>, E extends GuardrailExecutedEvent<P,R,G>>
extends AbstractAiServiceEvent
implements GuardrailExecutedEvent<P,R,G>

Represents an event that is executed when a guardrail validation occurs. This interface serves as a marker for events that contain both parameters and results associated with guardrail validation.

Nested Class Summary

Nested classes/interfaces inherited from interface AiServiceEvent

AiServiceEvent.Builder<T>

Nested classes/interfaces inherited from interface GuardrailExecutedEvent

GuardrailExecutedEvent.GuardrailExecutedEventBuilder<P,R,G,T>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DefaultGuardrailExecutedEvent(GuardrailExecutedEvent.GuardrailExecutedEventBuilder<P,R,G,E> builder)

Method Summary

Modifier and Type	Method	Description
Duration	duration()	Retrieves the duration of the guardrail execution.
Class<G>	guardrailClass()	Retrieves the guardrail class associated with the validation process.
P	request()	Retrieves the request used for input guardrail validation.
R	result()	Retrieves the result of the input guardrail validation process.

Methods inherited from class AbstractAiServiceEvent

invocationContext

Methods inherited from class Object

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

Methods inherited from interface AiServiceEvent

eventClass, invocationContext, toBuilder

Constructor Details

DefaultGuardrailExecutedEvent

protected DefaultGuardrailExecutedEvent(GuardrailExecutedEvent.GuardrailExecutedEventBuilder<P,R,G,E> builder)

Method Details

request

public P request()

Description copied from interface: GuardrailExecutedEvent

Retrieves the request used for input guardrail validation.

Specified by:

request in interface GuardrailExecutedEvent<P extends GuardrailRequest<P>, R extends GuardrailResult<R>, G extends Guardrail<P,R>>

Returns:

the parameters containing user message, memory, augmentation result, user message template, and associated variables for input guardrail validation.

result

public R result()

Description copied from interface: GuardrailExecutedEvent

Retrieves the result of the input guardrail validation process.

Specified by:

result in interface GuardrailExecutedEvent<P extends GuardrailRequest<P>, R extends GuardrailResult<R>, G extends Guardrail<P,R>>

Returns:

the result of the input guardrail validation, including the validation outcome and any associated failures, if present.

guardrailClass

public Class<G> guardrailClass()

Description copied from interface: GuardrailExecutedEvent

Retrieves the guardrail class associated with the validation process.

Specified by:

guardrailClass in interface GuardrailExecutedEvent<P extends GuardrailRequest<P>, R extends GuardrailResult<R>, G extends Guardrail<P,R>>

Returns:

the guardrail class that implements the logic for validating the interaction between user and LLM, represented as an instance of the type extending Guardrail<P, R>.

duration

public Duration duration()

Description copied from interface: GuardrailExecutedEvent

Retrieves the duration of the guardrail execution.

Specified by:

duration in interface GuardrailExecutedEvent<P extends GuardrailRequest<P>, R extends GuardrailResult<R>, G extends Guardrail<P,R>>

Returns:

the duration of the guardrail validation process.