Package org.springframework.ai.openai.api

Class OpenAiModerationApi

java.lang.Object

org.springframework.ai.openai.api.OpenAiModerationApi

public class OpenAiModerationApi
extends Object

OpenAI Moderation API.

Author:

Ahmed Yousri

See Also:

• https://platform.openai.com/docs/api-reference/moderations

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	OpenAiModerationApi.Categories
static final record	OpenAiModerationApi.CategoryScores
static final record	OpenAiModerationApi.Data
static final record	OpenAiModerationApi.OpenAiModerationRequest
static final record	OpenAiModerationApi.OpenAiModerationResponse
static final record	OpenAiModerationApi.OpenAiModerationResult

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_MODERATION_MODEL

Constructor Summary

Constructors

Constructor	Description
OpenAiModerationApi(String openAiToken)	Create a new OpenAI Moderation api with base URL set to https://api.openai.com
OpenAiModerationApi(String baseUrl, String openAiToken, org.springframework.web.client.RestClient.Builder restClientBuilder, org.springframework.web.client.ResponseErrorHandler responseErrorHandler)

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<OpenAiModerationApi.OpenAiModerationResponse>	createModeration(OpenAiModerationApi.OpenAiModerationRequest openAiModerationRequest)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_MODERATION_MODEL

public static final String DEFAULT_MODERATION_MODEL

See Also:

• Constant Field Values

Constructor Details

OpenAiModerationApi

public OpenAiModerationApi(String openAiToken)

Create a new OpenAI Moderation api with base URL set to https://api.openai.com

Parameters:

openAiToken - OpenAI apiKey.

OpenAiModerationApi

public OpenAiModerationApi(String baseUrl,
 String openAiToken,
 org.springframework.web.client.RestClient.Builder restClientBuilder,
 org.springframework.web.client.ResponseErrorHandler responseErrorHandler)

Method Details

createModeration

public org.springframework.http.ResponseEntity<OpenAiModerationApi.OpenAiModerationResponse> createModeration(OpenAiModerationApi.OpenAiModerationRequest openAiModerationRequest)