Package org.springframework.ai.openai

Class OpenAiModerationModel

java.lang.Object

org.springframework.ai.openai.OpenAiModerationModel

All Implemented Interfaces:

Model<ModerationPrompt,ModerationResponse>, ModerationModel

public final class OpenAiModerationModel
extends Object
implements ModerationModel

OpenAI SDK Moderation Model implementation.

This model provides content moderation capabilities using the OpenAI Moderation API through the official OpenAI Java SDK.

Author:

Ahmed Yousri, Ilayaperumal Gopinathan

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OpenAiModerationModel.Builder

Method Summary

Modifier and Type	Method	Description
static OpenAiModerationModel.Builder	builder()
ModerationResponse	call(ModerationPrompt moderationPrompt)	Executes a method call to the AI model.
OpenAiModerationOptions	getOptions()
OpenAiModerationModel.Builder	mutate()

Methods inherited from class java.lang.Object

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

Method Details

builder

public static OpenAiModerationModel.Builder builder()

mutate

public OpenAiModerationModel.Builder mutate()

call

public ModerationResponse call(ModerationPrompt moderationPrompt)

Description copied from interface: Model

Executes a method call to the AI model.

Specified by:

call in interface Model<ModerationPrompt,ModerationResponse>

Specified by:

call in interface ModerationModel

Parameters:

moderationPrompt - the request object to be sent to the AI model

Returns:

the response from the AI model

getOptions

public OpenAiModerationOptions getOptions()