Package dev.langchain4j.guardrail

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
AugmentationResult	augmentationResult()	Returns the augmentation result.
static GuardrailRequestParams.Builder	builder()	Creates a new builder for GuardrailRequestParams.
ChatMemory	chatMemory()	Returns the chat memory.
String	userMessageTemplate()	Returns the user message template.
Map<String,Object>	variables()	Returns the variables.

Methods inherited from class java.lang.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

builder

public static GuardrailRequestParams.Builder builder()

Creates a new builder for GuardrailRequestParams.

Returns:

a new builder