Class OpenAiModerationModel

java.lang.Object

dev.langchain4j.model.openai.OpenAiModerationModel

All Implemented Interfaces:

ModerationModel

public class OpenAiModerationModel
extends Object
implements ModerationModel

Represents an OpenAI moderation model, such as text-moderation-latest.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenAiModerationModel.OpenAiModerationModelBuilder

Constructor Summary

Constructors

Constructor	Description
OpenAiModerationModel(OpenAiModerationModel.OpenAiModerationModelBuilder builder)

Method Summary

Modifier and Type	Method	Description
static OpenAiModerationModel.OpenAiModerationModelBuilder	builder()
ModerationResponse	doModerate(ModerationRequest moderationRequest)	Performs the actual moderation.
List<ModerationModelListener>	listeners()	Returns the list of listeners for this moderation model.
String	modelName()	Returns the model name for this moderation model.
ModelProvider	provider()	Returns the model provider for this moderation model.

Methods inherited from class Object

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

Methods inherited from interface ModerationModel

moderate, moderate, moderate, moderate, moderate, moderate

Constructor Details

OpenAiModerationModel

public OpenAiModerationModel(OpenAiModerationModel.OpenAiModerationModelBuilder builder)

Method Details

modelName

public String modelName()

Description copied from interface: ModerationModel

Returns the model name for this moderation model.

Specified by:

modelName in interface ModerationModel

Returns:

the model name, or null if not available.

listeners

public List<ModerationModelListener> listeners()

Description copied from interface: ModerationModel

Returns the list of listeners for this moderation model.

Specified by:

listeners in interface ModerationModel

Returns:

the list of listeners, or an empty list if none are registered.

provider

public ModelProvider provider()

Description copied from interface: ModerationModel

Returns the model provider for this moderation model.

Specified by:

provider in interface ModerationModel

Returns:

the model provider.

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.

builder

public static OpenAiModerationModel.OpenAiModerationModelBuilder builder()