Skip to content

Allow OllamaApiAutoConfiguration conditional instantiation based on chat model and embedding model properties #5077

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.

Sign up for GitHub

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

Open
nicolaskrier wants to merge 1 commit into
base: main
Choose a base branch
from
+76 −2
Open

Allow OllamaApiAutoConfiguration conditional instantiation based on chat model and embedding model properties #5077

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
40 changes: 39 additions & 1 deletion ...in/java/org/springframework/ai/model/ollama/autoconfigure/OllamaApiAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,26 @@

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

import org.jspecify.annotations.NonNull;

import org.springframework.ai.model.SpringAIModelProperties;
import org.springframework.ai.model.SpringAIModels;
import org.springframework.ai.ollama.api.OllamaApi;
import org.springframework.ai.retry.autoconfigure.SpringAiRetryAutoConfiguration;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionMessage;
import org.springframework.boot.autoconfigure.condition.ConditionOutcome;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.SpringBootCondition;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.boot.restclient.autoconfigure.RestClientAutoConfiguration;
import org.springframework.boot.webclient.autoconfigure.WebClientAutoConfiguration;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.context.annotation.Conditional;
import org.springframework.core.type.AnnotatedTypeMetadata;
import org.springframework.web.client.ResponseErrorHandler;
import org.springframework.web.client.RestClient;
import org.springframework.web.reactive.function.client.WebClient;
Expand All @@ -37,11 +47,13 @@
* @author Eddú Meléndez
* @author Thomas Vitale
* @author Ilayaperumal Gopinathan
* @author Nicolas Krier
* @since 0.8.0
*/
@AutoConfiguration(after = { RestClientAutoConfiguration.class, WebClientAutoConfiguration.class,
SpringAiRetryAutoConfiguration.class })
@ConditionalOnClass(OllamaApi.class)
@Conditional(OllamaApiAutoConfiguration.OllamaChatOrEmbeddingCondition.class)
@EnableConfigurationProperties(OllamaConnectionProperties.class)
public class OllamaApiAutoConfiguration {

Expand All @@ -53,7 +65,7 @@ PropertiesOllamaConnectionDetails ollamaConnectionDetails(OllamaConnectionProper

@Bean
@ConditionalOnMissingBean
public OllamaApi ollamaApi(OllamaConnectionDetails connectionDetails,
OllamaApi ollamaApi(OllamaConnectionDetails connectionDetails,
ObjectProvider<RestClient.Builder> restClientBuilderProvider,
ObjectProvider<WebClient.Builder> webClientBuilderProvider, ResponseErrorHandler responseErrorHandler) {
return OllamaApi.builder()
Expand All @@ -79,4 +91,30 @@ public String getBaseUrl() {

}

static class OllamaChatOrEmbeddingCondition extends SpringBootCondition {

@Override
public @NonNull ConditionOutcome getMatchOutcome(@NonNull ConditionContext context,
@NonNull AnnotatedTypeMetadata metadata) {
var messageBuilder = ConditionMessage.forCondition("OllamaChatOrEmbeddingCondition");
var environment = context.getEnvironment();
var chatModel = environment.getProperty(SpringAIModelProperties.CHAT_MODEL, SpringAIModels.OLLAMA);

if (SpringAIModels.OLLAMA.equals(chatModel)) {
return ConditionOutcome.match(messageBuilder.because("Chat model corresponds to Ollama."));
}

var embeddingModel = environment.getProperty(SpringAIModelProperties.EMBEDDING_MODEL,
SpringAIModels.OLLAMA);

if (SpringAIModels.OLLAMA.equals(embeddingModel)) {
return ConditionOutcome.match(messageBuilder.because("Embedding model corresponds to Ollama."));
}

return ConditionOutcome
.noMatch(messageBuilder.because("Neither chat model nor embedding model correspond to Ollama."));
}

}

}
38 changes: 37 additions & 1 deletion ...java/org/springframework/ai/model/ollama/autoconfigure/OllamaModelConfigurationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,14 @@

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

import java.util.List;

import org.junit.jupiter.api.Test;

import org.springframework.ai.ollama.OllamaChatModel;
import org.springframework.ai.ollama.OllamaEmbeddingModel;
import org.springframework.ai.ollama.api.OllamaApi;
import org.springframework.ai.utils.SpringAiTestAutoConfigurations;
import org.springframework.boot.test.context.runner.ApplicationContextRunner;

import static org.assertj.core.api.Assertions.assertThat;
Expand All @@ -28,11 +32,43 @@
* Unit Tests for Ollama auto-configurations conditional enabling of models.
*
* @author Ilayaperumal Gopinathan
* @author Nicolas Krier
*/
public class OllamaModelConfigurationTests {
class OllamaModelConfigurationTests {

private final ApplicationContextRunner contextRunner = new ApplicationContextRunner();

@Test
void apiActivation() {
this.contextRunner.withConfiguration(SpringAiTestAutoConfigurations.of(OllamaApiAutoConfiguration.class))
.withPropertyValues("spring.ai.model.chat=none", "spring.ai.model.embedding=none")
.run(context -> {
assertThat(context).hasNotFailed();
assertThat(context).doesNotHaveBean(OllamaApiAutoConfiguration.PropertiesOllamaConnectionDetails.class);
assertThat(context).doesNotHaveBean(OllamaApi.class);
});

List.of(
// @formatter:off
this.contextRunner
.withConfiguration(SpringAiTestAutoConfigurations.of(OllamaApiAutoConfiguration.class)),
this.contextRunner
.withConfiguration(SpringAiTestAutoConfigurations.of(OllamaApiAutoConfiguration.class))
.withPropertyValues("spring.ai.model.chat=ollama", "spring.ai.model.embedding=ollama"),
this.contextRunner
.withConfiguration(SpringAiTestAutoConfigurations.of(OllamaApiAutoConfiguration.class))
.withPropertyValues("spring.ai.model.chat=ollama", "spring.ai.model.embedding=none"),
this.contextRunner
.withConfiguration(SpringAiTestAutoConfigurations.of(OllamaApiAutoConfiguration.class))
.withPropertyValues("spring.ai.model.chat=none", "spring.ai.model.embedding=ollama")
// @formatter:on
).forEach(runner -> runner.run(context -> {
assertThat(context).hasNotFailed();
assertThat(context).hasSingleBean(OllamaApiAutoConfiguration.PropertiesOllamaConnectionDetails.class);
assertThat(context).hasSingleBean(OllamaApi.class);
}));
}

@Test
void chatModelActivation() {
this.contextRunner.withConfiguration(BaseOllamaIT.ollamaAutoConfig(OllamaChatAutoConfiguration.class))
Expand Down