Interface InputGuardrailExecutedEvent

All Superinterfaces:

AiServiceEvent, GuardrailExecutedEvent<InputGuardrailRequest, InputGuardrailResult, InputGuardrail>

All Known Implementing Classes:

DefaultInputGuardrailExecutedEvent

public interface InputGuardrailExecutedEvent
extends GuardrailExecutedEvent<InputGuardrailRequest, InputGuardrailResult, InputGuardrail>

Represents an event that is triggered upon the execution of an input guardrail validation. This interface extends GuardrailExecutedEvent and ties specifically to input-based guardrail validations. It provides methods to access information such as the request details, result, and the associated input guardrail, all encapsulating the logic for validating input interactions within the system.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	InputGuardrailExecutedEvent.InputGuardrailExecutedEventBuilder	Builder for InputGuardrailExecutedEvent instances.

Nested classes/interfaces inherited from interface AiServiceEvent

AiServiceEvent.Builder<T>

Nested classes/interfaces inherited from interface GuardrailExecutedEvent

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

Method Summary

Modifier and Type	Method	Description
static InputGuardrailExecutedEvent.InputGuardrailExecutedEventBuilder	builder()
default Class<InputGuardrailExecutedEvent>	eventClass()	Retrieves the class type of the event, representing the specific category of the AI Service invocation event.
UserMessage	rewrittenUserMessage()	Retrieves a rewritten user message if a successful rewritten result exists.
default InputGuardrailExecutedEvent.InputGuardrailExecutedEventBuilder	toBuilder()	Creates a new builder instance initialized with the properties of this AiServiceEvent.

Methods inherited from interface AiServiceEvent

invocationContext

Methods inherited from interface GuardrailExecutedEvent

guardrailClass, request, result

Method Details

rewrittenUserMessage

UserMessage rewrittenUserMessage()

Retrieves a rewritten user message if a successful rewritten result exists. If the result contains a rewritten message, it constructs a new user message with the rewritten text; otherwise, it returns the original user message.

Returns:

The rewritten user message if a rewritten result exists; otherwise, the original user message.

eventClass

default Class<InputGuardrailExecutedEvent> eventClass()

Description copied from interface: AiServiceEvent

Retrieves the class type of the event, representing the specific category of the AI Service invocation event.

Specified by:

eventClass in interface AiServiceEvent

toBuilder

default InputGuardrailExecutedEvent.InputGuardrailExecutedEventBuilder toBuilder()

Description copied from interface: AiServiceEvent

Creates a new builder instance initialized with the properties of this AiServiceEvent. This allows modification of the existing properties and reconstruction of the event.

Specified by:

toBuilder in interface AiServiceEvent

builder

static InputGuardrailExecutedEvent.InputGuardrailExecutedEventBuilder builder()