Interface GuardrailResult<GR extends GuardrailResult>

All Known Implementing Classes:

InputGuardrailResult, OutputGuardrailResult

public interface GuardrailResult<GR extends GuardrailResult>

The result of the validation of an interaction between a user and the LLM.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	GuardrailResult.Failure	The message and the cause of the failure of a single validation.
static enum	GuardrailResult.Result	The possible results of a guardrails validation.

Method Summary

Modifier and Type	Method	Description
default GuardrailResult<GR>	blockRetry()
List<? extends GuardrailResult.Failure>	failures()
default Throwable	getFirstFailureException()
GuardrailResult.Result	getResult()
default boolean	hasRewrittenResult()
boolean	isFatal()
default boolean	isSuccess()
default Object	successfulResult()
default String	successfulText()
GR	validatedBy(Class<? extends Guardrail> guardrailClass)

Method Details

getResult

GuardrailResult.Result getResult()

isSuccess

default boolean isSuccess()

hasRewrittenResult

default boolean hasRewrittenResult()

blockRetry

default GuardrailResult<GR> blockRetry()

successfulText

default String successfulText()

successfulResult

default Object successfulResult()

isFatal

boolean isFatal()

failures

List<? extends GuardrailResult.Failure> failures()

Returns:

The list of failures eventually resulting from a set of validations.

getFirstFailureException

default Throwable getFirstFailureException()

validatedBy

GR validatedBy(Class<? extends Guardrail> guardrailClass)