Class DisabledModerationModel

java.lang.Object

dev.langchain4j.model.moderation.DisabledModerationModel

All Implemented Interfaces:

ModerationModel

public class DisabledModerationModel
extends Object
implements ModerationModel

A ModerationModel which throws a ModelDisabledException for all of its methods

This could be used in tests, or in libraries that extend this one to conditionally enable or disable functionality.

Constructor Summary

Constructors

Constructor	Description
DisabledModerationModel()

Method Summary

Modifier and Type	Method	Description
ModerationResponse	doModerate(ModerationRequest moderationRequest)	Performs the actual moderation.
Response<Moderation>	moderate(ChatMessage message)	Moderates the given chat message.
Response<Moderation>	moderate(TextSegment textSegment)	Moderates the given text segment.
Response<Moderation>	moderate(Prompt prompt)	Moderates the given prompt.
Response<Moderation>	moderate(String text)	Moderates the given text.
Response<Moderation>	moderate(List<ChatMessage> messages)	Moderates the given list of chat messages.

Methods inherited from class Object

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

Methods inherited from interface ModerationModel

listeners, modelName, moderate, provider

Constructor Details

DisabledModerationModel

public DisabledModerationModel()

Method Details

moderate

public Response<Moderation> moderate(String text)

Description copied from interface: ModerationModel

Moderates the given text.

Specified by:

moderate in interface ModerationModel

Parameters:

text - the text to moderate.

Returns:

the moderation Response.

moderate

public Response<Moderation> moderate(Prompt prompt)

Description copied from interface: ModerationModel

Moderates the given prompt.

Specified by:

moderate in interface ModerationModel

Parameters:

prompt - the prompt to moderate.

Returns:

the moderation Response.

moderate

public Response<Moderation> moderate(ChatMessage message)

Description copied from interface: ModerationModel

Moderates the given chat message.

Specified by:

moderate in interface ModerationModel

Parameters:

message - the chat message to moderate.

Returns:

the moderation Response.

moderate

public Response<Moderation> moderate(List<ChatMessage> messages)

Description copied from interface: ModerationModel

Moderates the given list of chat messages.

Specified by:

moderate in interface ModerationModel

Parameters:

messages - the list of chat messages to moderate.

Returns:

the moderation Response.

moderate

public Response<Moderation> moderate(TextSegment textSegment)

Description copied from interface: ModerationModel

Moderates the given text segment.

Specified by:

moderate in interface ModerationModel

Parameters:

textSegment - the text segment to moderate.

Returns:

the moderation Response.

doModerate

public ModerationResponse doModerate(ModerationRequest moderationRequest)

Description copied from interface: ModerationModel

Performs the actual moderation. This method should be overridden by implementations.

Specified by:

doModerate in interface ModerationModel

Parameters:

moderationRequest - the moderation request.

Returns:

the moderation response.