Package org.springframework.ai.openai

Class OpenAiModerationModel

java.lang.Object

org.springframework.ai.openai.OpenAiModerationModel

All Implemented Interfaces:

Model<ModerationPrompt,ModerationResponse>, ModerationModel

public class OpenAiModerationModel
extends Object
implements ModerationModel

OpenAiModerationModel is a class that implements the ModerationModel interface. It provides a client for calling the OpenAI moderation generation API.

Since:

1.0.0

Author:

Ahmed Yousri

Constructor Summary

Constructors

Constructor	Description
OpenAiModerationModel(OpenAiModerationApi openAiModerationApi)
OpenAiModerationModel(OpenAiModerationApi openAiModerationApi, org.springframework.retry.support.RetryTemplate retryTemplate)

Method Summary

Modifier and Type	Method	Description
ModerationResponse	call(ModerationPrompt moderationPrompt)	Executes a method call to the AI model.
OpenAiModerationOptions	getDefaultOptions()
OpenAiModerationModel	withDefaultOptions(OpenAiModerationOptions defaultOptions)

Methods inherited from class java.lang.Object

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

Constructor Details

OpenAiModerationModel

public OpenAiModerationModel(OpenAiModerationApi openAiModerationApi)

OpenAiModerationModel

public OpenAiModerationModel(OpenAiModerationApi openAiModerationApi,
 org.springframework.retry.support.RetryTemplate retryTemplate)

Method Details

getDefaultOptions

public OpenAiModerationOptions getDefaultOptions()

withDefaultOptions

public OpenAiModerationModel withDefaultOptions(OpenAiModerationOptions defaultOptions)

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