Record Class InputGuardrailResult

java.lang.Object

java.lang.Record

io.quarkiverse.langchain4j.guardrails.InputGuardrailResult

Record Components:

result - The result of the input guardrail validation.

failures - The list of failures, empty if the validation succeeded.

All Implemented Interfaces:

GuardrailResult<InputGuardrailResult>

public record InputGuardrailResult(GuardrailResult.Result result, String successfulText, List<io.quarkiverse.langchain4j.guardrails.InputGuardrailResult.Failure> failures)
extends Record
implements GuardrailResult<InputGuardrailResult>

The result of the validation of an InputGuardrail

Nested Class Summary

Nested classes/interfaces inherited from interface io.quarkiverse.langchain4j.guardrails.GuardrailResult

GuardrailResult.Result

Constructor Summary

Constructors

Constructor	Description
InputGuardrailResult(GuardrailResult.Result result, String successfulText, List<io.quarkiverse.langchain4j.guardrails.InputGuardrailResult.Failure> failures)	Creates an instance of a InputGuardrailResult record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static InputGuardrailResult	failure(List<? extends GuardrailResult.Failure> failures)
List<io.quarkiverse.langchain4j.guardrails.InputGuardrailResult.Failure>	failures()	Returns the value of the failures record component.
GuardrailResult.Result	getResult()
final int	hashCode()	Returns a hash code value for this object.
boolean	isFatal()
GuardrailResult.Result	result()	Returns the value of the result record component.
static InputGuardrailResult	success()
String	successfulText()	Returns the value of the successfulText record component.
static InputGuardrailResult	successWith(String successfulText)
String	toString()	Returns a string representation of this record class.
InputGuardrailResult	validatedBy(Class<? extends Guardrail> guardrailClass)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.quarkiverse.langchain4j.guardrails.GuardrailResult

blockRetry, getFirstFailureException, hasRewrittenResult, isSuccess, successfulResult

Constructor Details

InputGuardrailResult

public InputGuardrailResult(GuardrailResult.Result result,
 String successfulText,
 List<io.quarkiverse.langchain4j.guardrails.InputGuardrailResult.Failure> failures)

Creates an instance of a InputGuardrailResult record class.

Parameters:

result - the value for the result record component

successfulText - the value for the successfulText record component

failures - the value for the failures record component

Method Details

success

public static InputGuardrailResult success()

successWith

public static InputGuardrailResult successWith(String successfulText)

failure

public static InputGuardrailResult failure(List<? extends GuardrailResult.Failure> failures)

getResult

public GuardrailResult.Result getResult()

Specified by:

getResult in interface GuardrailResult<InputGuardrailResult>

isFatal

public boolean isFatal()

Specified by:

isFatal in interface GuardrailResult<InputGuardrailResult>

validatedBy

public InputGuardrailResult validatedBy(Class<? extends Guardrail> guardrailClass)

Specified by:

validatedBy in interface GuardrailResult<InputGuardrailResult>

toString

public String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

result

public GuardrailResult.Result result()

Returns the value of the result record component.

Returns:

the value of the result record component

successfulText

public String successfulText()

Returns the value of the successfulText record component.

Specified by:

successfulText in interface GuardrailResult<InputGuardrailResult>

Returns:

the value of the successfulText record component

failures

public List<io.quarkiverse.langchain4j.guardrails.InputGuardrailResult.Failure> failures()

Returns the value of the failures record component.

Specified by:

failures in interface GuardrailResult<InputGuardrailResult>

Returns:

the value of the failures record component