Package dev.langchain4j.guardrail

Interface GuardrailResult<GR extends GuardrailResult<GR>>

Type Parameters:

GR - The type of guardrail result to expect

All Known Implementing Classes:

InputGuardrailResult, OutputGuardrailResult

public sealed interface GuardrailResult<GR extends GuardrailResult<GR>>
permits InputGuardrailResult, OutputGuardrailResult

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

See Also:

• InputGuardrailResult
• OutputGuardrailResult

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 String	asString()
<F extends GuardrailResult.Failure> List<F>	failures()
default Throwable	getFirstFailureException()	Gets the exception from the first failure
default boolean	hasRewrittenResult()	Whether or not the result is successful, but the result was re-written, potentially due to re-prompting
default boolean	isFatal()	Whether or not the result is considered fatal
default boolean	isSuccess()	Whether or not the result is considered successful
GuardrailResult.Result	result()	The result of the guardrail
String	successfulText()	The message of the successful result
default GR	validatedBy(Class<? extends Guardrail> guardrailClass)	The Guardrail class which performed this validation

Method Details

result

GuardrailResult.Result result()

The result of the guardrail

failures

<F extends GuardrailResult.Failure> List<F> failures()

Returns:

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

successfulText

String successfulText()

The message of the successful result

hasRewrittenResult

default boolean hasRewrittenResult()

Whether or not the result is successful, but the result was re-written, potentially due to re-prompting

isFatal

default boolean isFatal()

Whether or not the result is considered fatal

isSuccess

default boolean isSuccess()

Whether or not the result is considered successful

getFirstFailureException

default Throwable getFirstFailureException()

Gets the exception from the first failure

validatedBy

default GR validatedBy(Class<? extends Guardrail> guardrailClass)

The Guardrail class which performed this validation

asString

default String asString()