Package org.springframework.ai.openai

Class OpenAiModerationOptions

java.lang.Object

org.springframework.ai.openai.AbstractOpenAiOptions

org.springframework.ai.openai.OpenAiModerationOptions

All Implemented Interfaces:

ModelOptions, ModerationOptions

public class OpenAiModerationOptions
extends AbstractOpenAiOptions
implements ModerationOptions

OpenAI SDK Moderation Options.

Author:

Ahmed Yousri, Ilayaperumal Gopinathan

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OpenAiModerationOptions.Builder

Nested classes/interfaces inherited from class org.springframework.ai.openai.AbstractOpenAiOptions

AbstractOpenAiOptions.AbstractBuilder<O extends AbstractOpenAiOptions,B extends AbstractOpenAiOptions.AbstractBuilder<O,B>>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_MODERATION_MODEL	Default moderation model.

Fields inherited from class org.springframework.ai.openai.AbstractOpenAiOptions

DEFAULT_MAX_RETRIES, DEFAULT_TIMEOUT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OpenAiModerationOptions(@Nullable String baseUrl, @Nullable String apiKey, @Nullable com.openai.credential.Credential credential, @Nullable String model, @Nullable String microsoftDeploymentName, @Nullable com.openai.azure.AzureOpenAIServiceVersion microsoftFoundryServiceVersion, @Nullable String organizationId, @Nullable Boolean isMicrosoftFoundry, @Nullable Boolean isGitHubModels, @Nullable Duration timeout, @Nullable Integer maxRetries, @Nullable Proxy proxy, @Nullable Map<String,String> customHeaders)

Method Summary

Modifier and Type	Method	Description
static OpenAiModerationOptions.Builder	builder()
boolean	equals(@Nullable Object o)
int	hashCode()

Methods inherited from class org.springframework.ai.openai.AbstractOpenAiOptions

getApiKey, getBaseUrl, getCredential, getCustomHeaders, getDeploymentName, getMaxRetries, getMicrosoftDeploymentName, getMicrosoftFoundryServiceVersion, getModel, getOrganizationId, getProxy, getTimeout, isGitHubModels, isMicrosoftFoundry

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.ai.moderation.ModerationOptions

getModel

Field Details

DEFAULT_MODERATION_MODEL

public static final String DEFAULT_MODERATION_MODEL

Default moderation model.

See Also:

• Constant Field Values

Constructor Details

OpenAiModerationOptions

protected OpenAiModerationOptions(@Nullable String baseUrl,
 @Nullable String apiKey,
 @Nullable com.openai.credential.Credential credential,
 @Nullable String model,
 @Nullable String microsoftDeploymentName,
 @Nullable com.openai.azure.AzureOpenAIServiceVersion microsoftFoundryServiceVersion,
 @Nullable String organizationId,
 @Nullable Boolean isMicrosoftFoundry,
 @Nullable Boolean isGitHubModels,
 @Nullable Duration timeout,
 @Nullable Integer maxRetries,
 @Nullable Proxy proxy,
 @Nullable Map<String,String> customHeaders)

Method Details

builder

public static OpenAiModerationOptions.Builder builder()

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object