Class OpenAiModerationApi

java.lang.Object

org.springframework.ai.openai.api.OpenAiModerationApi

public class OpenAiModerationApi
extends Object

OpenAI Moderation API.

Author:

Ahmed Yousri, Ilayaperumal Gopinathan, Filip Hrisafov

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final 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 baseUrl, org.springframework.ai.model.ApiKey apiKey, String moderationPath, org.springframework.http.HttpHeaders 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.
OpenAiModerationApi(String moderationPath, org.springframework.web.client.RestClient restClient)	Create a new OpenAI Moderation API with the provided rest client.

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 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 baseUrl,
 org.springframework.ai.model.ApiKey apiKey,
 String moderationPath,
 org.springframework.http.HttpHeaders 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.

moderationPath - The path to the moderation endpoint.

restClientBuilder - the rest client builder to use.

OpenAiModerationApi

public OpenAiModerationApi(String moderationPath,
 org.springframework.web.client.RestClient restClient)

Create a new OpenAI Moderation API with the provided rest client.

Parameters:

moderationPath - The path to the moderation endpoint.

restClient - the rest client instance to use.

Method Details

createModeration

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

builder

public static OpenAiModerationApi.Builder builder()