Record Class OutputGuardrailResult

java.lang.Object

java.lang.Record

io.quarkiverse.langchain4j.guardrails.OutputGuardrailResult

Record Components:

result - The result of the output guardrail validation.

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

All Implemented Interfaces:

GuardrailResult<OutputGuardrailResult>

public record OutputGuardrailResult(GuardrailResult.Result result, String successfulText, Object successfulResult, List<OutputGuardrailResult.Failure> failures)
extends Record
implements GuardrailResult<OutputGuardrailResult>

The result of the validation of an OutputGuardrail

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	OutputGuardrailResult.Failure

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

GuardrailResult.Result

Constructor Summary

Constructors

Constructor	Description
OutputGuardrailResult(GuardrailResult.Result result, String successfulText, Object successfulResult, List<OutputGuardrailResult.Failure> failures)	Creates an instance of a OutputGuardrailResult record class.

Method Summary

Modifier and Type	Method	Description
OutputGuardrailResult	blockRetry()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static OutputGuardrailResult	failure(List<? extends GuardrailResult.Failure> failures)
List<OutputGuardrailResult.Failure>	failures()	Returns the value of the failures record component.
String	getReprompt()
GuardrailResult.Result	getResult()
final int	hashCode()	Returns a hash code value for this object.
boolean	isFatal()
boolean	isRetry()
GuardrailResult.Result	result()	Returns the value of the result record component.
static OutputGuardrailResult	success()
Object	successfulResult()	Returns the value of the successfulResult record component.
String	successfulText()	Returns the value of the successfulText record component.
static OutputGuardrailResult	successWith(String successfulText)
static OutputGuardrailResult	successWith(String successfulText, Object successfulResult)
String	toString()	Returns a string representation of this record class.
OutputGuardrailResult	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

getFirstFailureException, hasRewrittenResult, isSuccess

Constructor Details

OutputGuardrailResult

public OutputGuardrailResult(GuardrailResult.Result result,
 String successfulText,
 Object successfulResult,
 List<OutputGuardrailResult.Failure> failures)

Creates an instance of a OutputGuardrailResult record class.

Parameters:

result - the value for the result record component

successfulText - the value for the successfulText record component

successfulResult - the value for the successfulResult record component

failures - the value for the failures record component

Method Details

success

public static OutputGuardrailResult success()

successWith

public static OutputGuardrailResult successWith(String successfulText)

successWith

public static OutputGuardrailResult successWith(String successfulText,
 Object successfulResult)

failure

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

getResult

public GuardrailResult.Result getResult()

Specified by:

getResult in interface GuardrailResult<OutputGuardrailResult>

isRetry

public boolean isRetry()

blockRetry

public OutputGuardrailResult blockRetry()

Specified by:

blockRetry in interface GuardrailResult<OutputGuardrailResult>

getReprompt

public String getReprompt()

isFatal

public boolean isFatal()

Specified by:

isFatal in interface GuardrailResult<OutputGuardrailResult>

validatedBy

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

Specified by:

validatedBy in interface GuardrailResult<OutputGuardrailResult>

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<OutputGuardrailResult>

Returns:

the value of the successfulText record component

successfulResult

public Object successfulResult()

Returns the value of the successfulResult record component.

Specified by:

successfulResult in interface GuardrailResult<OutputGuardrailResult>

Returns:

the value of the successfulResult record component

failures

public List<OutputGuardrailResult.Failure> failures()

Returns the value of the failures record component.

Specified by:

failures in interface GuardrailResult<OutputGuardrailResult>

Returns:

the value of the failures record component