Package dev.langchain4j.guardrail

Class OutputGuardrailResult

java.lang.Object

dev.langchain4j.guardrail.OutputGuardrailResult

All Implemented Interfaces:

GuardrailResult<OutputGuardrailResult>

public final class OutputGuardrailResult
extends Object
implements GuardrailResult<OutputGuardrailResult>

The result of the validation of an OutputGuardrail

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OutputGuardrailResult.Failure	Represents an output guardrail failure

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

GuardrailResult.Result

Method Summary

Modifier and Type	Method	Description
OutputGuardrailResult	blockRetry()	Block all retries for this result
boolean	equals(Object o)
static OutputGuardrailResult	failure(List<OutputGuardrailResult.Failure> failures)	Produces a non-fatal failure
<F extends GuardrailResult.Failure> List<F>	failures()
Optional<String>	getReprompt()	Gets the reprompt message
int	hashCode()
boolean	isReprompt()	Whether or not the guardrail is forcing a reprompt
boolean	isRetry()	Whether or not the guardrail is forcing a retry
<T> T	response(OutputGuardrailRequest request)	Gets the response computed from the combination of the original ChatResponse in the OutputGuardrailRequest and this result
GuardrailResult.Result	result()	The result of the guardrail
static OutputGuardrailResult	success()	Gets a successful output guardrail result
Object	successfulResult()
String	successfulText()	The message of the successful result
static OutputGuardrailResult	successWith(String successfulText)	Produces a successful result with specific success text
static OutputGuardrailResult	successWith(String successfulText, Object successfulResult)	Produces a non-fatal failure
String	toString()

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 OutputGuardrailResult success()

Gets a successful output guardrail result

successWith

public static OutputGuardrailResult 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 output guardrail validation with a specific text.

successWith

public static OutputGuardrailResult successWith(String successfulText,
 Object successfulResult)

Produces a non-fatal failure

Parameters:

successfulText - The text of the successful result.

successfulResult - The object generated by this successful result.

Returns:

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

failure

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

Produces a non-fatal failure

Parameters:

failures - A list of OutputGuardrailResult.Failures

Returns:

The result of a failed output guardrail validation.

isRetry

public boolean isRetry()

Whether or not the guardrail is forcing a retry

isReprompt

public boolean isReprompt()

Whether or not the guardrail is forcing a reprompt

blockRetry

public OutputGuardrailResult blockRetry()

Block all retries for this result

getReprompt

public Optional<String> getReprompt()

Gets the reprompt message

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

response

public <T> T response(OutputGuardrailRequest request)

Gets the response computed from the combination of the original ChatResponse in the OutputGuardrailRequest and this result

Type Parameters:

T - The type of response

Parameters:

request - The output guardrail request

Returns:

A response computed from the combination of the original ChatResponse in the OutputGuardrailRequest and this result

result

public GuardrailResult.Result result()

Description copied from interface: GuardrailResult

The result of the guardrail

Specified by:

result in interface GuardrailResult<OutputGuardrailResult>

failures

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

Specified by:

failures in interface GuardrailResult<OutputGuardrailResult>

Returns:

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

successfulText

public String successfulText()

Description copied from interface: GuardrailResult

The message of the successful result

Specified by:

successfulText in interface GuardrailResult<OutputGuardrailResult>

successfulResult

public Object successfulResult()