Skip to content

Fix Mistral Moderation Auto Config #2736

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@
import org.springframework.ai.chat.observation.ChatModelObservationConvention;
import org.springframework.ai.mistralai.MistralAiChatModel;
import org.springframework.ai.mistralai.api.MistralAiApi;
import org.springframework.ai.mistralai.api.MistralAiModerationApi;
import org.springframework.ai.mistralai.moderation.MistralAiModerationModel;
import org.springframework.ai.model.SpringAIModelProperties;
import org.springframework.ai.model.SpringAIModels;
import org.springframework.ai.model.function.DefaultFunctionCallbackResolver;
Expand Down Expand Up @@ -59,8 +57,7 @@
*/
@AutoConfiguration(after = { RestClientAutoConfiguration.class, SpringAiRetryAutoConfiguration.class,
ToolCallingAutoConfiguration.class })
@EnableConfigurationProperties({ MistralAiCommonProperties.class, MistralAiChatProperties.class,
MistralAiModerationProperties.class })
@EnableConfigurationProperties({ MistralAiCommonProperties.class, MistralAiChatProperties.class })
@ConditionalOnProperty(name = SpringAIModelProperties.CHAT_MODEL, havingValue = SpringAIModels.MISTRAL,
matchIfMissing = true)
@ConditionalOnClass(MistralAiApi.class)
Expand Down Expand Up @@ -96,27 +93,6 @@ public MistralAiChatModel mistralAiChatModel(MistralAiCommonProperties commonPro
return chatModel;
}

@Bean
@ConditionalOnMissingBean
public MistralAiModerationModel mistralAiModerationModel(MistralAiCommonProperties commonProperties,
MistralAiModerationProperties moderationProperties, RetryTemplate retryTemplate,
ObjectProvider<RestClient.Builder> restClientBuilderProvider, ResponseErrorHandler responseErrorHandler) {

var apiKey = moderationProperties.getApiKey();
var baseUrl = moderationProperties.getBaseUrl();

var resolvedApiKey = StringUtils.hasText(apiKey) ? apiKey : commonProperties.getApiKey();
var resoledBaseUrl = StringUtils.hasText(baseUrl) ? baseUrl : commonProperties.getBaseUrl();

Assert.hasText(resolvedApiKey, "Mistral API key must be set");
Assert.hasText(resoledBaseUrl, "Mistral base URL must be set");

var mistralAiModerationAi = new MistralAiModerationApi(resoledBaseUrl, resolvedApiKey,
restClientBuilderProvider.getIfAvailable(RestClient::builder), responseErrorHandler);

return new MistralAiModerationModel(mistralAiModerationAi, retryTemplate, moderationProperties.getOptions());
}

private MistralAiApi mistralAiApi(String apiKey, String commonApiKey, String baseUrl, String commonBaseUrl,
RestClient.Builder restClientBuilder, ResponseErrorHandler responseErrorHandler) {

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
/*
* Copyright 2023-2025 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.springframework.ai.model.mistralai.autoconfigure;

import org.springframework.ai.mistralai.api.MistralAiApi;
import org.springframework.ai.mistralai.api.MistralAiModerationApi;
import org.springframework.ai.mistralai.moderation.MistralAiModerationModel;
import org.springframework.ai.model.SpringAIModelProperties;
import org.springframework.ai.model.SpringAIModels;
import org.springframework.ai.retry.autoconfigure.SpringAiRetryAutoConfiguration;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.autoconfigure.web.client.RestClientAutoConfiguration;
import org.springframework.boot.autoconfigure.web.reactive.function.client.WebClientAutoConfiguration;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.retry.support.RetryTemplate;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;
import org.springframework.web.client.ResponseErrorHandler;
import org.springframework.web.client.RestClient;

/**
* Moderation {@link AutoConfiguration Auto-configuration} for Mistral AI.
*
* @author Ricken Bazolo
*/
@AutoConfiguration(after = { RestClientAutoConfiguration.class, SpringAiRetryAutoConfiguration.class,
WebClientAutoConfiguration.class })
@EnableConfigurationProperties({ MistralAiCommonProperties.class, MistralAiModerationProperties.class })
@ConditionalOnProperty(name = SpringAIModelProperties.MODERATION_MODEL, havingValue = SpringAIModels.MISTRAL,
matchIfMissing = true)
@ConditionalOnClass(MistralAiApi.class)
@ImportAutoConfiguration(classes = { SpringAiRetryAutoConfiguration.class, RestClientAutoConfiguration.class,
WebClientAutoConfiguration.class })
public class MistralAiModerationAutoConfiguration {

@Bean
@ConditionalOnMissingBean
public MistralAiModerationModel mistralAiModerationModel(MistralAiCommonProperties commonProperties,
MistralAiModerationProperties moderationProperties, RetryTemplate retryTemplate,
ObjectProvider<RestClient.Builder> restClientBuilderProvider, ResponseErrorHandler responseErrorHandler) {

var apiKey = moderationProperties.getApiKey();
var baseUrl = moderationProperties.getBaseUrl();

var resolvedApiKey = StringUtils.hasText(apiKey) ? apiKey : commonProperties.getApiKey();
var resoledBaseUrl = StringUtils.hasText(baseUrl) ? baseUrl : commonProperties.getBaseUrl();

Assert.hasText(resolvedApiKey, "Mistral API key must be set");
Assert.hasText(resoledBaseUrl, "Mistral base URL must be set");

var mistralAiModerationAi = new MistralAiModerationApi(resoledBaseUrl, resolvedApiKey,
restClientBuilderProvider.getIfAvailable(RestClient::builder), responseErrorHandler);

return new MistralAiModerationModel(mistralAiModerationAi, retryTemplate, moderationProperties.getOptions());
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@
#
org.springframework.ai.model.mistralai.autoconfigure.MistralAiChatAutoConfiguration
org.springframework.ai.model.mistralai.autoconfigure.MistralAiEmbeddingAutoConfiguration
org.springframework.ai.model.mistralai.autoconfigure.MistralAiModerationAutoConfiguration
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ public void moderationOptionsTest() {
.withPropertyValues("spring.ai.mistralai.base-url=TEST_BASE_URL", "spring.ai.mistralai.api-key=abc123",
"spring.ai.mistralai.moderation.options.model=MODERATION_MODEL")
.withConfiguration(AutoConfigurations.of(SpringAiRetryAutoConfiguration.class,
RestClientAutoConfiguration.class, MistralAiChatAutoConfiguration.class))
RestClientAutoConfiguration.class, MistralAiModerationAutoConfiguration.class))
.run(context -> {
var moderationProperties = context.getBean(MistralAiModerationProperties.class);
assertThat(moderationProperties.getOptions().getModel()).isEqualTo("MODERATION_MODEL");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@

import org.springframework.ai.mistralai.MistralAiChatModel;
import org.springframework.ai.mistralai.MistralAiEmbeddingModel;
import org.springframework.ai.mistralai.moderation.MistralAiModerationModel;
import org.springframework.boot.autoconfigure.AutoConfigurations;
import org.springframework.boot.test.context.runner.ApplicationContextRunner;

Expand All @@ -29,6 +30,7 @@
* Unit Tests for Mistral AI auto-configurations conditional enabling of models.
*
* @author Ilayaperumal Gopinathan
* @author Ricken Bazolo
*/
public class MistralModelConfigurationTests {

Expand All @@ -43,6 +45,8 @@ void chatModelActivation() {
assertThat(context.getBeansOfType(MistralAiChatModel.class)).isNotEmpty();
assertThat(context.getBeansOfType(MistralAiEmbeddingProperties.class)).isEmpty();
assertThat(context.getBeansOfType(MistralAiEmbeddingModel.class)).isEmpty();
assertThat(context.getBeansOfType(MistralAiModerationProperties.class)).isEmpty();
assertThat(context.getBeansOfType(MistralAiModerationModel.class)).isEmpty();
});

this.contextRunner.withConfiguration(AutoConfigurations.of(MistralAiChatAutoConfiguration.class))
Expand All @@ -61,6 +65,8 @@ void chatModelActivation() {
assertThat(context.getBeansOfType(MistralAiChatModel.class)).isNotEmpty();
assertThat(context.getBeansOfType(MistralAiEmbeddingProperties.class)).isEmpty();
assertThat(context.getBeansOfType(MistralAiEmbeddingModel.class)).isEmpty();
assertThat(context.getBeansOfType(MistralAiModerationProperties.class)).isEmpty();
assertThat(context.getBeansOfType(MistralAiModerationModel.class)).isEmpty();
});
}

Expand All @@ -84,4 +90,42 @@ void embeddingModelActivation() {
});
}

@Test
void moderationModelActivation() {
this.contextRunner.withConfiguration(AutoConfigurations.of(MistralAiModerationAutoConfiguration.class))
.run(context -> {
assertThat(context.getBeansOfType(MistralAiModerationModel.class)).isNotEmpty();
assertThat(context.getBeansOfType(MistralAiModerationProperties.class)).isNotEmpty();
assertThat(context.getBeansOfType(MistralAiChatModel.class)).isEmpty();
assertThat(context.getBeansOfType(MistralAiChatProperties.class)).isEmpty();
assertThat(context.getBeansOfType(MistralAiEmbeddingProperties.class)).isEmpty();
assertThat(context.getBeansOfType(MistralAiEmbeddingModel.class)).isEmpty();
});

this.contextRunner.withConfiguration(AutoConfigurations.of(MistralAiModerationAutoConfiguration.class))
.withPropertyValues("spring.ai.model.moderation=none")
.run(context -> {
assertThat(context.getBeansOfType(MistralAiModerationProperties.class)).isEmpty();
assertThat(context.getBeansOfType(MistralAiModerationModel.class)).isEmpty();
});

this.contextRunner.withConfiguration(AutoConfigurations.of(MistralAiModerationAutoConfiguration.class))
.withPropertyValues("spring.ai.model.moderation=mistral")
.run(context -> {
assertThat(context.getBeansOfType(MistralAiModerationProperties.class)).isNotEmpty();
assertThat(context.getBeansOfType(MistralAiModerationModel.class)).isNotEmpty();
});

this.contextRunner
.withConfiguration(AutoConfigurations.of(MistralAiChatAutoConfiguration.class,
MistralAiEmbeddingAutoConfiguration.class, MistralAiModerationAutoConfiguration.class))
.withPropertyValues("spring.ai.model.chat=none", "spring.ai.model.embedding=none",
"spring.ai.model.moderation=mistral")
.run(context -> {
assertThat(context.getBeansOfType(MistralAiModerationModel.class)).isNotEmpty();
assertThat(context.getBeansOfType(MistralAiEmbeddingModel.class)).isEmpty();
assertThat(context.getBeansOfType(MistralAiChatModel.class)).isEmpty();
});
}

}