Class OutputGuardrailException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

dev.langchain4j.exception.LangChain4jException

dev.langchain4j.guardrail.GuardrailException

dev.langchain4j.guardrail.OutputGuardrailException

All Implemented Interfaces:

Serializable

public final class OutputGuardrailException
extends GuardrailException

Exception thrown when an output guardrail validation fails.

This class is not intended to be thrown within guardrail implementations. It is for the framework only. It is ok to catch it.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
OutputGuardrailException(String message)
OutputGuardrailException(String message, Throwable cause)
OutputGuardrailException(String message, Throwable cause, OutputGuardrailResult result)

Method Summary

Modifier and Type	Method	Description
OutputGuardrailResult	result()	Returns the OutputGuardrailResult that caused this exception, or null if not available.

Methods inherited from class Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

OutputGuardrailException

public OutputGuardrailException(String message)

OutputGuardrailException

public OutputGuardrailException(String message,
 Throwable cause)

OutputGuardrailException

public OutputGuardrailException(String message,
 Throwable cause,
 OutputGuardrailResult result)

Method Details

result

public OutputGuardrailResult result()

Returns the OutputGuardrailResult that caused this exception, or null if not available. Callers catching this exception can inspect the result to understand which guardrail failed and whether the violating message was removed from memory.