OpenAI: moderation model support moderationPath configuration

Signed-off-by: lambochen <[email protected]>

Author: lambochen

auto-configurations/models/spring-ai-autoconfigure-model-openai/src/main/java/org/springframework/ai/model/openai/autoconfigure/OpenAiModerationAutoConfiguration.java

@@ -46,6 +46,7 @@
  * @author Stefan Vassilev
  * @author Thomas Vitale
  * @author Ilayaperumal Gopinathan
+ * @author lambochen
  */
 @AutoConfiguration(after = { RestClientAutoConfiguration.class, WebClientAutoConfiguration.class,
 		SpringAiRetryAutoConfiguration.class })
@@ -68,6 +69,7 @@ public OpenAiModerationModel openAiModerationModel(OpenAiConnectionProperties co
 
 		var openAiModerationApi = OpenAiModerationApi.builder()
 			.baseUrl(resolved.baseUrl())
+			.moderationPath(moderationProperties.getModerationPath())
 			.apiKey(new SimpleApiKey(resolved.apiKey()))
 			.headers(resolved.headers())
 			.restClientBuilder(restClientBuilderProvider.getIfAvailable(RestClient::builder))

auto-configurations/models/spring-ai-autoconfigure-model-openai/src/main/java/org/springframework/ai/model/openai/autoconfigure/OpenAiModerationProperties.java

@@ -17,13 +17,15 @@
 package org.springframework.ai.model.openai.autoconfigure;
 
 import org.springframework.ai.openai.OpenAiModerationOptions;
+import org.springframework.ai.openai.api.common.OpenAiApiConstants;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.boot.context.properties.NestedConfigurationProperty;
 
 /**
  * OpenAI Moderation autoconfiguration properties.
  *
  * @author Ahmed Yousri
+ * @author lambochen
  * @since 0.9.0
  */
 @ConfigurationProperties(OpenAiModerationProperties.CONFIG_PREFIX)
@@ -37,6 +39,8 @@ public class OpenAiModerationProperties extends OpenAiParentProperties {
 	@NestedConfigurationProperty
 	private OpenAiModerationOptions options = OpenAiModerationOptions.builder().build();
 
+	private String moderationPath = OpenAiApiConstants.DEFAULT_MODERATION_PATH;
+
 	public OpenAiModerationOptions getOptions() {
 		return this.options;
 	}
@@ -45,4 +49,12 @@ public void setOptions(OpenAiModerationOptions options) {
 		this.options = options;
 	}
 
+	public String getModerationPath() {
+		return moderationPath;
+	}
+
+	public void setModerationPath(String moderationPath) {
+		this.moderationPath = moderationPath;
+	}
+
 }

models/spring-ai-openai/src/main/java/org/springframework/ai/openai/api/OpenAiModerationApi.java

@@ -25,6 +25,8 @@
 import org.springframework.ai.model.ApiKey;
 import org.springframework.ai.model.NoopApiKey;
 import org.springframework.ai.model.SimpleApiKey;
+import org.springframework.ai.moderation.Categories;
+import org.springframework.ai.moderation.CategoryScores;
 import org.springframework.ai.openai.api.common.OpenAiApiConstants;
 import org.springframework.ai.retry.RetryUtils;
 import org.springframework.http.HttpHeaders;
@@ -42,6 +44,7 @@
  * @author Ahmed Yousri
  * @author Ilayaperumal Gopinathan
  * @author Filip Hrisafov
+ * @author lambochen
  * @see <a href=
  * "https://platform.openai.com/docs/api-reference/moderations">https://platform.openai.com/docs/api-reference/moderations</a>
  */
@@ -55,6 +58,8 @@ public class OpenAiModerationApi {
 
 	private final ObjectMapper objectMapper;
 
+	private final String moderationPath;
+
 	/**
 	 * Create a new OpenAI Moderation API with the provided base URL.
 	 * @param baseUrl the base URL for the OpenAI API.
@@ -63,31 +68,47 @@ public class OpenAiModerationApi {
 	 */
 	public OpenAiModerationApi(String baseUrl, ApiKey apiKey, MultiValueMap<String, String> headers,
 			RestClient.Builder restClientBuilder, ResponseErrorHandler responseErrorHandler) {
+		this(baseUrl, OpenAiApiConstants.DEFAULT_MODERATION_PATH, apiKey, headers, restClientBuilder,
+				responseErrorHandler);
+	}
 
+	/**
+	 * Create a new OpenAI Moderation API with the provided base URL.
+	 * @param baseUrl the base URL for the OpenAI API.
+	 * @param apiKey OpenAI apiKey.
+	 * @param restClientBuilder the rest client builder to use.
+	 * @param moderationPath the moderation path to use.
+	 */
+	public OpenAiModerationApi(String baseUrl, String moderationPath, ApiKey apiKey,
+			MultiValueMap<String, String> headers, RestClient.Builder restClientBuilder,
+			ResponseErrorHandler responseErrorHandler) {
+		Assert.hasText(moderationPath, "moderationPath cannot be null or empty");
+
+		this.moderationPath = moderationPath;
 		this.objectMapper = new ObjectMapper().configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
 
 		// @formatter:off
 		this.restClient = restClientBuilder.clone()
-			.baseUrl(baseUrl)
-			.defaultHeaders(h -> {
-				h.setContentType(MediaType.APPLICATION_JSON);
-				h.addAll(headers);
-			})
-			.defaultStatusHandler(responseErrorHandler)
-			.defaultRequest(requestHeadersSpec -> {
-				if (!(apiKey instanceof NoopApiKey)) {
-					requestHeadersSpec.header(HttpHeaders.AUTHORIZATION, "Bearer " + apiKey.getValue());
-				}
-			})
-			.build(); // @formatter:on
+				.baseUrl(baseUrl)
+				.defaultHeaders(h -> {
+					h.setContentType(MediaType.APPLICATION_JSON);
+					h.addAll(headers);
+				})
+				.defaultStatusHandler(responseErrorHandler)
+				.defaultRequest(requestHeadersSpec -> {
+					if (!(apiKey instanceof NoopApiKey)) {
+						requestHeadersSpec.header(HttpHeaders.AUTHORIZATION, "Bearer " + apiKey.getValue());
+					}
+				})
+				.build(); // @formatter:on
 	}
 
 	public ResponseEntity<OpenAiModerationResponse> createModeration(OpenAiModerationRequest openAiModerationRequest) {
 		Assert.notNull(openAiModerationRequest, "Moderation request cannot be null.");
 		Assert.hasLength(openAiModerationRequest.prompt(), "Prompt cannot be empty.");
 
 		return this.restClient.post()
-			.uri("v1/moderations")
+			.uri(this.moderationPath)
 			.body(openAiModerationRequest)
 			.retrieve()
 			.toEntity(OpenAiModerationResponse.class);
@@ -176,6 +197,8 @@ public static class Builder {
 
 		private String baseUrl = OpenAiApiConstants.DEFAULT_BASE_URL;
 
+		private String moderationPath = OpenAiApiConstants.DEFAULT_MODERATION_PATH;
+
 		private ApiKey apiKey;
 
 		private MultiValueMap<String, String> headers = new LinkedMultiValueMap<>();
@@ -190,6 +213,12 @@ public Builder baseUrl(String baseUrl) {
 			return this;
 		}
 
+		public Builder moderationPath(String moderationPath) {
+			Assert.hasText(moderationPath, "moderationPath cannot be null or empty");
+			this.moderationPath = moderationPath;
+			return this;
+		}
+
 		public Builder apiKey(ApiKey apiKey) {
 			Assert.notNull(apiKey, "apiKey cannot be null");
 			this.apiKey = apiKey;
@@ -222,8 +251,8 @@ public Builder responseErrorHandler(ResponseErrorHandler responseErrorHandler) {
 
 		public OpenAiModerationApi build() {
 			Assert.notNull(this.apiKey, "apiKey must be set");
-			return new OpenAiModerationApi(this.baseUrl, this.apiKey, this.headers, this.restClientBuilder,
-					this.responseErrorHandler);
+			return new OpenAiModerationApi(this.baseUrl, this.moderationPath, this.apiKey, this.headers,
+					this.restClientBuilder, this.responseErrorHandler);
 		}
 
 	}

models/spring-ai-openai/src/main/java/org/springframework/ai/openai/api/common/OpenAiApiConstants.java

@@ -36,6 +36,8 @@ public final class OpenAiApiConstants {
 
 	public static final String DEFAULT_AUDIO_TRANSLATION_PATH = "/v1/audio/translations";
 
+	public static final String DEFAULT_MODERATION_PATH = "v1/moderations";
+
 	public static final String PROVIDER_NAME = AiProvider.OPENAI.value();
 
 	private OpenAiApiConstants() {

models/spring-ai-openai/src/test/java/org/springframework/ai/openai/moderation/api/OpenAiModerationApiBuilderTests.java

@@ -55,6 +55,8 @@ class OpenAiModerationApiBuilderTests {
 
 	private static final String TEST_BASE_URL = "https://test.openai.com";
 
+	private static final String TEST_MODERATION_PATH = "/v1/moderations";
+
 	@Test
 	void testMinimalBuilder() {
 		OpenAiModerationApi api = OpenAiModerationApi.builder().apiKey(TEST_API_KEY).build();
@@ -71,6 +73,7 @@ void testFullBuilder() {
 
 		OpenAiModerationApi api = OpenAiModerationApi.builder()
 			.baseUrl(TEST_BASE_URL)
+			.moderationPath(TEST_MODERATION_PATH)
 			.apiKey(TEST_API_KEY)
 			.headers(headers)
 			.restClientBuilder(restClientBuilder)
@@ -97,6 +100,17 @@ void testInvalidBaseUrl() {
 			.hasMessageContaining("baseUrl cannot be null or empty");
 	}
 
+	@Test
+	void testInvalidModerationPath() {
+		assertThatThrownBy(() -> OpenAiModerationApi.builder().moderationPath("").build())
+			.isInstanceOf(IllegalArgumentException.class)
+			.hasMessageContaining("moderationPath cannot be null or empty");
+
+		assertThatThrownBy(() -> OpenAiModerationApi.builder().moderationPath(null).build())
+			.isInstanceOf(IllegalArgumentException.class)
+			.hasMessageContaining("moderationPath cannot be null or empty");
+	}
+
 	@Test
 	void testInvalidHeaders() {
 		assertThatThrownBy(() -> OpenAiModerationApi.builder().headers(null).build())