Package dev.langchain4j.guardrail

Class InputGuardrailRequest

java.lang.Object

dev.langchain4j.guardrail.InputGuardrailRequest

All Implemented Interfaces:

GuardrailRequest<InputGuardrailRequest>

public final class InputGuardrailRequest
extends Object
implements GuardrailRequest<InputGuardrailRequest>

Represents the parameter passed to InputGuardrail.validate(InputGuardrailRequest).

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static InputGuardrailRequest.Builder	builder()	Creates a new builder for InputGuardrailRequest.
GuardrailRequestParams	requestParams()	Returns the common parameters shared between types of guardrails.
UserMessage	rewriteUserMessage(String text)
UserMessage	userMessage()	Returns the user message.
InputGuardrailRequest	withText(String text)	Recreate this guardrail param with the given input or output text.

Methods inherited from class java.lang.Object

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

Method Details

userMessage

public UserMessage userMessage()

Returns the user message.

Returns:

the user message

requestParams

public GuardrailRequestParams requestParams()

Returns the common parameters shared between types of guardrails.

Specified by:

requestParams in interface GuardrailRequest<InputGuardrailRequest>

Returns:

the common parameters

withText

public InputGuardrailRequest withText(String text)

Description copied from interface: GuardrailRequest

Recreate this guardrail param with the given input or output text.

Specified by:

withText in interface GuardrailRequest<InputGuardrailRequest>

Parameters:

text - The text of the rewritten param.

Returns:

A clone of this guardrail params with the given input or output text.

rewriteUserMessage

public UserMessage rewriteUserMessage(String text)

builder

public static InputGuardrailRequest.Builder builder()

Creates a new builder for InputGuardrailRequest.

Returns:

a new builder