Uses of Class
dev.langchain4j.guardrail.OutputGuardrailResult
Packages that use OutputGuardrailResult
Package
Description
-
Uses of OutputGuardrailResult in dev.langchain4j.guardrail
Subclasses with type arguments of type OutputGuardrailResult in dev.langchain4j.guardrailModifier and TypeClassDescriptionclass
TheGuardrailExecutor
forOutputGuardrail
s.static class
Builder class for constructing instances ofOutputGuardrailExecutor
.Subinterfaces with type arguments of type OutputGuardrailResult in dev.langchain4j.guardrailModifier and TypeInterfaceDescriptioninterface
An output guardrail is a rule that is applied to the output of the model to ensure that the output is safe and meets the expectations.Classes in dev.langchain4j.guardrail that implement interfaces with type arguments of type OutputGuardrailResultMethods in dev.langchain4j.guardrail that return OutputGuardrailResultModifier and TypeMethodDescriptionOutputGuardrailResult.blockRetry()
Block all retries for this resultprotected OutputGuardrailResult
OutputGuardrailExecutor.createFailure
(List<OutputGuardrailResult.Failure> failures) Creates a failure result from someOutputGuardrailResult.Failure
s.protected OutputGuardrailResult
OutputGuardrailExecutor.createSuccess()
Creates a success result.OutputGuardrailExecutor.execute
(OutputGuardrailRequest request) Executes theOutputGuardrail
s on the givenOutputGuardrailRequest
.default OutputGuardrailResult
Produces a non-fatal failuredefault OutputGuardrailResult
Produces a non-fatal failurestatic OutputGuardrailResult
OutputGuardrailResult.failure
(List<OutputGuardrailResult.Failure> failures) Produces a non-fatal failuredefault OutputGuardrailResult
Produces a fatal failuredefault OutputGuardrailResult
Produces a fatal failureprotected OutputGuardrailResult
OutputGuardrailExecutor.handleFatalResult
(OutputGuardrailResult accumulatedResult, OutputGuardrailResult result) protected OutputGuardrailResult
JsonExtractorOutputGuardrail.invokeInvalidJson
(AiMessage aiMessage, String json) default OutputGuardrailResult
default OutputGuardrailResult
default OutputGuardrailResult
default OutputGuardrailResult
default OutputGuardrailResult
OutputGuardrail.success()
Produces a successful result without any successful textstatic OutputGuardrailResult
OutputGuardrailResult.success()
Gets a successful output guardrail resultdefault OutputGuardrailResult
OutputGuardrail.successWith
(String successfulText) Produces a successful result with specific success textdefault OutputGuardrailResult
OutputGuardrail.successWith
(String successfulText, Object successfulResult) Produces a non-fatal failurestatic OutputGuardrailResult
OutputGuardrailResult.successWith
(String successfulText) Produces a successful result with specific success textstatic OutputGuardrailResult
OutputGuardrailResult.successWith
(String successfulText, Object successfulResult) Produces a non-fatal failuredefault OutputGuardrailResult
Validates the response from the LLM.default OutputGuardrailResult
OutputGuardrail.validate
(OutputGuardrailRequest request) Validates the response from the LLM.Methods in dev.langchain4j.guardrail with parameters of type OutputGuardrailResultModifier and TypeMethodDescriptionprotected OutputGuardrailResult
OutputGuardrailExecutor.handleFatalResult
(OutputGuardrailResult accumulatedResult, OutputGuardrailResult result) -
Uses of OutputGuardrailResult in dev.langchain4j.observability.api.event
Subclasses with type arguments of type OutputGuardrailResult in dev.langchain4j.observability.api.eventModifier and TypeClassDescriptionstatic class
Builder forOutputGuardrailExecutedEvent
instances.Subinterfaces with type arguments of type OutputGuardrailResult in dev.langchain4j.observability.api.eventModifier and TypeInterfaceDescriptioninterface
Represents an event executed during the output guardrail validation process. -
Uses of OutputGuardrailResult in dev.langchain4j.observability.api.listener
Subinterfaces with type arguments of type OutputGuardrailResult in dev.langchain4j.observability.api.listenerModifier and TypeInterfaceDescriptioninterface
An event listener specifically designed to handleOutputGuardrailExecutedEvent
. -
Uses of OutputGuardrailResult in dev.langchain4j.observability.event
Subclasses with type arguments of type OutputGuardrailResult in dev.langchain4j.observability.event -
Uses of OutputGuardrailResult in dev.langchain4j.service.guardrail
Methods in dev.langchain4j.service.guardrail that return OutputGuardrailResultModifier and TypeMethodDescription<MethodKey>
OutputGuardrailResultAbstractGuardrailService.executeOutputGuardrails
(MethodKey method, OutputGuardrailRequest request) <MethodKey>
OutputGuardrailResultGuardrailService.executeOutputGuardrails
(MethodKey method, OutputGuardrailRequest request) Executes the output guardrails associated with a givenMethod
. -
Uses of OutputGuardrailResult in dev.langchain4j.spi.guardrail
Subinterfaces with type arguments of type OutputGuardrailResult in dev.langchain4j.spi.guardrailModifier and TypeInterfaceDescriptioninterface
Represents a factory for creating instances ofOutputGuardrailExecutor.OutputGuardrailExecutorBuilder
. -
Uses of OutputGuardrailResult in dev.langchain4j.test.guardrail
Subclasses with type arguments of type OutputGuardrailResult in dev.langchain4j.test.guardrailMethods in dev.langchain4j.test.guardrail with parameters of type OutputGuardrailResultModifier and TypeMethodDescriptionstatic OutputGuardrailResultAssert
GuardrailAssertions.assertThat
(OutputGuardrailResult actual) Returns anOutputGuardrailResultAssert
for assertions on anOutputGuardrailResult
static OutputGuardrailResultAssert
OutputGuardrailResultAssert.assertThat
(OutputGuardrailResult actual) Creates a newOutputGuardrailResultAssert
for the providedOutputGuardrailResult
.