Package dev.langchain4j.guardrail

Class InputGuardrailResult

java.lang.Object

dev.langchain4j.guardrail.InputGuardrailResult

All Implemented Interfaces:

GuardrailResult<InputGuardrailResult>

public final class InputGuardrailResult
extends Object
implements GuardrailResult<InputGuardrailResult>

The result of the validation of an InputGuardrail

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	InputGuardrailResult.Failure	Represents an input guardrail failure

Nested classes/interfaces inherited from interface dev.langchain4j.guardrail.GuardrailResult

GuardrailResult.Result

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
<F extends GuardrailResult.Failure> List<F>	failures()
int	hashCode()
GuardrailResult.Result	result()	The result of the guardrail
static InputGuardrailResult	success()	Gets a successful input guardrail result
String	successfulText()	The message of the successful result
static InputGuardrailResult	successWith(String successfulText)	Produces a successful result with specific success text
String	toString()
UserMessage	userMessage(InputGuardrailRequest params)	Gets the UserMessage computed from the combination of the original UserMessage in the InputGuardrailRequest and this result

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface dev.langchain4j.guardrail.GuardrailResult

asString, getFirstFailureException, hasRewrittenResult, isFatal, isSuccess, validatedBy

Method Details

success

public static InputGuardrailResult success()

Gets a successful input guardrail result

successWith

public static InputGuardrailResult successWith(String successfulText)

Produces a successful result with specific success text

Parameters:

successfulText - The text of the successful result.

Returns:

The result of a successful input guardrail validation with a specific text.

result

public GuardrailResult.Result result()

Description copied from interface: GuardrailResult

The result of the guardrail

Specified by:

result in interface GuardrailResult<InputGuardrailResult>

successfulText

public String successfulText()

Description copied from interface: GuardrailResult

The message of the successful result

Specified by:

successfulText in interface GuardrailResult<InputGuardrailResult>

failures

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

Specified by:

failures in interface GuardrailResult<InputGuardrailResult>

Returns:

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

toString

public String toString()

Overrides:

toString in class Object

userMessage

public UserMessage userMessage(InputGuardrailRequest params)

Gets the UserMessage computed from the combination of the original UserMessage in the InputGuardrailRequest and this result

Parameters:

params - The input guardrail params

Returns:

A UserMessage computed from the combination of the original UserMessage in the InputGuardrailRequest * and this result

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object