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, Ilayaperumal Gopinathan

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenAiModerationApi.Builder	Builder to construct OpenAiModerationApi instance.
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)	Deprecated, for removal: This API element is subject to removal in a future version. use OpenAiModerationApi.Builder instead.
OpenAiModerationApi(String baseUrl, String openAiToken, org.springframework.web.client.RestClient.Builder restClientBuilder, org.springframework.web.client.ResponseErrorHandler responseErrorHandler)	Deprecated, for removal: This API element is subject to removal in a future version. use OpenAiModerationApi.Builder instead.
OpenAiModerationApi(String baseUrl, ApiKey apiKey, org.springframework.util.MultiValueMap<String,String> headers, org.springframework.web.client.RestClient.Builder restClientBuilder, org.springframework.web.client.ResponseErrorHandler responseErrorHandler)	Create a new OpenAI Moderation API with the provided base URL.

Method Summary

Modifier and Type	Method	Description
static OpenAiModerationApi.Builder	builder()
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

@Deprecated(forRemoval=true,
            since="1.0.0-M6")
public OpenAiModerationApi(String openAiToken)

Deprecated, for removal: This API element is subject to removal in a future version.

use OpenAiModerationApi.Builder instead.

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

Parameters:

openAiToken - OpenAI apiKey.

OpenAiModerationApi

@Deprecated(forRemoval=true,
            since="1.0.0-M6")
public OpenAiModerationApi(String baseUrl,
 String openAiToken,
 org.springframework.web.client.RestClient.Builder restClientBuilder,
 org.springframework.web.client.ResponseErrorHandler responseErrorHandler)

Deprecated, for removal: This API element is subject to removal in a future version.

use OpenAiModerationApi.Builder instead.

OpenAiModerationApi

public OpenAiModerationApi(String baseUrl,
 ApiKey apiKey,
 org.springframework.util.MultiValueMap<String,String> headers,
 org.springframework.web.client.RestClient.Builder restClientBuilder,
 org.springframework.web.client.ResponseErrorHandler responseErrorHandler)

Create a new OpenAI Moderation API with the provided base URL.

Parameters:

baseUrl - the base URL for the OpenAI API.

apiKey - OpenAI apiKey.

restClientBuilder - the rest client builder to use.

Method Details

createModeration

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

builder

public static OpenAiModerationApi.Builder builder()