Class GuardrailRequestParams

java.lang.Object

dev.langchain4j.guardrail.GuardrailRequestParams

public final class GuardrailRequestParams
extends Object

Represents the common parameters shared across guardrail checks when validating interactions between a user and a language model. This class encapsulates the chat memory, user message template, and additional variables required for guardrail processing.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GuardrailRequestParams.Builder	Builder for GuardrailRequestParams.

Method Summary

Modifier and Type	Method	Description
AiServiceListenerRegistrar	aiservicelistenerregistrar()	Returns the AiServiceListenerRegistrar, which provides functionality for registering, unregistering, and notifying listeners of AI service invocation events.
AugmentationResult	augmentationResult()	Returns the augmentation result.
static GuardrailRequestParams.Builder	builder()	Creates a new builder for GuardrailRequestParams.
ChatMemory	chatMemory()	Returns the chat memory.
InvocationContext	invocationContext()	Returns the InvocationContext, which contains general information about the AI Service invocation.
GuardrailRequestParams.Builder	toBuilder()	Converts the current GuardrailRequestParams instance to a builder, allowing modifications to the current state or creation of a new modified object.
String	userMessageTemplate()	Returns the user message template.
Map<String,Object>	variables()	Returns the variables.

Methods inherited from class Object

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

Method Details

chatMemory

public ChatMemory chatMemory()

Returns the chat memory.

Returns:

the chat memory, may be null

augmentationResult

public AugmentationResult augmentationResult()

Returns the augmentation result.

Returns:

the augmentation result, may be null

userMessageTemplate

public String userMessageTemplate()

Returns the user message template.

Returns:

the user message template, never null

variables

public Map<String,Object> variables()

Returns the variables.

Returns:

the variables, never null

invocationContext

public InvocationContext invocationContext()

Returns the InvocationContext, which contains general information about the AI Service invocation.

Returns:

the invocation context

aiservicelistenerregistrar

public AiServiceListenerRegistrar aiservicelistenerregistrar()

Returns the AiServiceListenerRegistrar, which provides functionality for registering, unregistering, and notifying listeners of AI service invocation events.

Returns:

the AiServiceListenerRegistrar

toBuilder

public GuardrailRequestParams.Builder toBuilder()

Converts the current GuardrailRequestParams instance to a builder, allowing modifications to the current state or creation of a new modified object.

Returns:

a GuardrailRequestParams.Builder pre-populated with the current state's values

builder

public static GuardrailRequestParams.Builder builder()

Creates a new builder for GuardrailRequestParams.

Returns:

a new builder