Package org.springframework.ai.moderation

Class ModerationPrompt

java.lang.Object

org.springframework.ai.moderation.ModerationPrompt

All Implemented Interfaces:

ModelRequest<ModerationMessage>

public class ModerationPrompt
extends Object
implements ModelRequest<ModerationMessage>

Represents a prompt for moderation containing a single message and the options for the moderation model. This class offers constructors to create a prompt from a single message or a simple instruction string, allowing for customization of moderation options through `ModerationOptions`. It simplifies creating moderation requests for different use cases.

Since:

1.0.0

Author:

Ahmed Yousri

Constructor Summary

Constructors

Constructor	Description
ModerationPrompt(String instructions)
ModerationPrompt(String instructions, ModerationOptions moderationOptions)
ModerationPrompt(ModerationMessage message, ModerationOptions moderationModelOptions)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
ModerationMessage	getInstructions()	Retrieves the instructions or input required by the AI model.
ModerationOptions	getOptions()	Retrieves the customizable options for AI model interactions.
int	hashCode()
void	setOptions(ModerationOptions moderationModelOptions)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ModerationPrompt

public ModerationPrompt(ModerationMessage message,
 ModerationOptions moderationModelOptions)

ModerationPrompt

public ModerationPrompt(String instructions,
 ModerationOptions moderationOptions)

ModerationPrompt

public ModerationPrompt(String instructions)

Method Details

getInstructions

public ModerationMessage getInstructions()

Description copied from interface: ModelRequest

Retrieves the instructions or input required by the AI model.

Specified by:

getInstructions in interface ModelRequest<ModerationMessage>

Returns:

the instructions or input required by the AI model

getOptions

public ModerationOptions getOptions()

Description copied from interface: ModelRequest

Retrieves the customizable options for AI model interactions.

Specified by:

getOptions in interface ModelRequest<ModerationMessage>

Returns:

the customizable options for AI model interactions

setOptions

public void setOptions(ModerationOptions moderationModelOptions)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object