Skip to content

GH-4494: Fix ZhiPuAI auto-configuration #4570

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

Closed
wants to merge 1 commit into from
+104 −84
Closed

GH-4494: Fix ZhiPuAI auto-configuration #4570

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
3 changes: 0 additions & 3 deletions ...java/org/springframework/ai/model/zhipuai/autoconfigure/ZhiPuAiChatAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@
import org.springframework.ai.zhipuai.api.ZhiPuAiApi;
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;
Expand All @@ -57,8 +56,6 @@
@ConditionalOnProperty(name = SpringAIModelProperties.CHAT_MODEL, havingValue = SpringAIModels.ZHIPUAI,
matchIfMissing = true)
@EnableConfigurationProperties({ ZhiPuAiConnectionProperties.class, ZhiPuAiChatProperties.class })
@ImportAutoConfiguration(classes = { SpringAiRetryAutoConfiguration.class, RestClientAutoConfiguration.class,
ToolCallingAutoConfiguration.class })
public class ZhiPuAiChatAutoConfiguration {

@Bean
Expand Down
51 changes: 24 additions & 27 deletions ...t/java/org/springframework/ai/model/zhipuai/autoconfigure/ZhiPuAiAutoConfigurationIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,9 @@
import org.springframework.ai.embedding.EmbeddingResponse;
import org.springframework.ai.image.ImagePrompt;
import org.springframework.ai.image.ImageResponse;
import org.springframework.ai.retry.autoconfigure.SpringAiRetryAutoConfiguration;
import org.springframework.ai.zhipuai.ZhiPuAiChatModel;
import org.springframework.ai.zhipuai.ZhiPuAiEmbeddingModel;
import org.springframework.ai.zhipuai.ZhiPuAiImageModel;
import org.springframework.boot.autoconfigure.AutoConfigurations;
import org.springframework.boot.autoconfigure.web.client.RestClientAutoConfiguration;
import org.springframework.boot.test.context.runner.ApplicationContextRunner;

import static org.assertj.core.api.Assertions.assertThat;
Expand All @@ -51,40 +48,40 @@ public class ZhiPuAiAutoConfigurationIT {
private static final Log logger = LogFactory.getLog(ZhiPuAiAutoConfigurationIT.class);

private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
.withPropertyValues("spring.ai.zhipuai.apiKey=" + System.getenv("ZHIPU_AI_API_KEY"))
.withConfiguration(
AutoConfigurations.of(SpringAiRetryAutoConfiguration.class, RestClientAutoConfiguration.class));
.withPropertyValues("spring.ai.zhipuai.apiKey=" + System.getenv("ZHIPU_AI_API_KEY"));

@Test
void generate() {
this.contextRunner.withConfiguration(AutoConfigurations.of(ZhiPuAiChatAutoConfiguration.class)).run(context -> {
ZhiPuAiChatModel chatModel = context.getBean(ZhiPuAiChatModel.class);
ChatResponse response = chatModel.call(new Prompt("Hello", ChatOptions.builder().build()));
assertThat(response.getResult().getOutput().getText()).isNotEmpty();
logger.info("Response: " + response);
});
this.contextRunner.withConfiguration(ZhiPuAiITUtil.zhiPuAiAutoConfig(ZhiPuAiChatAutoConfiguration.class))
.run(context -> {
ZhiPuAiChatModel chatModel = context.getBean(ZhiPuAiChatModel.class);
ChatResponse response = chatModel.call(new Prompt("Hello", ChatOptions.builder().build()));
assertThat(response.getResult().getOutput().getText()).isNotEmpty();
logger.info("Response: " + response);
});
}

@Test
void generateStreaming() {
this.contextRunner.withConfiguration(AutoConfigurations.of(ZhiPuAiChatAutoConfiguration.class)).run(context -> {
ZhiPuAiChatModel chatModel = context.getBean(ZhiPuAiChatModel.class);
Flux<ChatResponse> responseFlux = chatModel
.stream(new Prompt(new UserMessage("Hello"), ChatOptions.builder().build()));
String response = responseFlux.collectList()
.block()
.stream()
.map(chatResponse -> chatResponse.getResults().get(0).getOutput().getText())
.collect(Collectors.joining());

assertThat(response).isNotEmpty();
logger.info("Response: " + response);
});
this.contextRunner.withConfiguration(ZhiPuAiITUtil.zhiPuAiAutoConfig(ZhiPuAiChatAutoConfiguration.class))
.run(context -> {
ZhiPuAiChatModel chatModel = context.getBean(ZhiPuAiChatModel.class);
Flux<ChatResponse> responseFlux = chatModel
.stream(new Prompt(new UserMessage("Hello"), ChatOptions.builder().build()));
String response = responseFlux.collectList()
.block()
.stream()
.map(chatResponse -> chatResponse.getResults().get(0).getOutput().getText())
.collect(Collectors.joining());

assertThat(response).isNotEmpty();
logger.info("Response: " + response);
});
}

@Test
void embedding() {
this.contextRunner.withConfiguration(AutoConfigurations.of(ZhiPuAiEmbeddingAutoConfiguration.class))
this.contextRunner.withConfiguration(ZhiPuAiITUtil.zhiPuAiAutoConfig(ZhiPuAiEmbeddingAutoConfiguration.class))
.run(context -> {
ZhiPuAiEmbeddingModel embeddingModel = context.getBean(ZhiPuAiEmbeddingModel.class);

Expand All @@ -102,7 +99,7 @@ void embedding() {

@Test
void generateImage() {
this.contextRunner.withConfiguration(AutoConfigurations.of(ZhiPuAiImageAutoConfiguration.class))
this.contextRunner.withConfiguration(ZhiPuAiITUtil.zhiPuAiAutoConfig(ZhiPuAiImageAutoConfiguration.class))
.withPropertyValues("spring.ai.zhipuai.image.options.size=1024x1024")
.run(context -> {
ZhiPuAiImageModel ImageModel = context.getBean(ZhiPuAiImageModel.class);
Expand Down
56 changes: 56 additions & 0 deletions ...ipuai/src/test/java/org/springframework/ai/model/zhipuai/autoconfigure/ZhiPuAiITUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
/*
* Copyright 2025-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.zhipuai.autoconfigure;

import org.springframework.ai.model.tool.autoconfigure.ToolCallingAutoConfiguration;
import org.springframework.ai.retry.autoconfigure.SpringAiRetryAutoConfiguration;
import org.springframework.boot.autoconfigure.AutoConfigurations;
import org.springframework.boot.autoconfigure.web.client.RestClientAutoConfiguration;

/**
* Utility class for ZhiPuAI integration tests.
*
* @author Pawel Potaczala
*/
public final class ZhiPuAiITUtil {

private ZhiPuAiITUtil() {
}

public static AutoConfigurations zhiPuAiToolAutoConfig(Class<?>... additionalAutoConfigurations) {
Class<?>[] dependencies = new Class[] { RestClientAutoConfiguration.class, SpringAiRetryAutoConfiguration.class,
ToolCallingAutoConfiguration.class };
Class<?>[] allAutoConfigurations = new Class[dependencies.length + additionalAutoConfigurations.length];
System.arraycopy(dependencies, 0, allAutoConfigurations, 0, dependencies.length);
System.arraycopy(additionalAutoConfigurations, 0, allAutoConfigurations, dependencies.length,
additionalAutoConfigurations.length);

return AutoConfigurations.of(allAutoConfigurations);
}

public static AutoConfigurations zhiPuAiAutoConfig(Class<?>... additionalAutoConfigurations) {
Class<?>[] dependencies = new Class[] { RestClientAutoConfiguration.class, SpringAiRetryAutoConfiguration.class,
ToolCallingAutoConfiguration.class };
Class<?>[] allAutoConfigurations = new Class[dependencies.length + additionalAutoConfigurations.length];
System.arraycopy(dependencies, 0, allAutoConfigurations, 0, dependencies.length);
System.arraycopy(additionalAutoConfigurations, 0, allAutoConfigurations, dependencies.length,
additionalAutoConfigurations.length);

return AutoConfigurations.of(allAutoConfigurations);
}

}
57 changes: 18 additions & 39 deletions .../test/java/org/springframework/ai/model/zhipuai/autoconfigure/ZhiPuAiPropertiesTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,10 @@
import org.skyscreamer.jsonassert.JSONCompareMode;

import org.springframework.ai.model.ModelOptionsUtils;
import org.springframework.ai.retry.autoconfigure.SpringAiRetryAutoConfiguration;
import org.springframework.ai.zhipuai.ZhiPuAiChatModel;
import org.springframework.ai.zhipuai.ZhiPuAiEmbeddingModel;
import org.springframework.ai.zhipuai.ZhiPuAiImageModel;
import org.springframework.ai.zhipuai.api.ZhiPuAiApi;
import org.springframework.boot.autoconfigure.AutoConfigurations;
import org.springframework.boot.autoconfigure.web.client.RestClientAutoConfiguration;
import org.springframework.boot.test.context.runner.ApplicationContextRunner;

import static org.assertj.core.api.Assertions.assertThat;
Expand All @@ -51,8 +48,7 @@ public void chatProperties() {
"spring.ai.zhipuai.chat.options.model=MODEL_XYZ",
"spring.ai.zhipuai.chat.options.temperature=0.55")
// @formatter:on
.withConfiguration(AutoConfigurations.of(SpringAiRetryAutoConfiguration.class,
RestClientAutoConfiguration.class, ZhiPuAiChatAutoConfiguration.class))
.withConfiguration(ZhiPuAiITUtil.zhiPuAiToolAutoConfig(ZhiPuAiChatAutoConfiguration.class))
.run(context -> {
var chatProperties = context.getBean(ZhiPuAiChatProperties.class);
var connectionProperties = context.getBean(ZhiPuAiConnectionProperties.class);
Expand Down Expand Up @@ -80,8 +76,7 @@ public void chatOverrideConnectionProperties() {
"spring.ai.zhipuai.chat.options.model=MODEL_XYZ",
"spring.ai.zhipuai.chat.options.temperature=0.55")
// @formatter:on
.withConfiguration(AutoConfigurations.of(SpringAiRetryAutoConfiguration.class,
RestClientAutoConfiguration.class, ZhiPuAiChatAutoConfiguration.class))
.withConfiguration(ZhiPuAiITUtil.zhiPuAiToolAutoConfig(ZhiPuAiChatAutoConfiguration.class))
.run(context -> {
var chatProperties = context.getBean(ZhiPuAiChatProperties.class);
var connectionProperties = context.getBean(ZhiPuAiConnectionProperties.class);
Expand All @@ -106,8 +101,7 @@ public void embeddingProperties() {
"spring.ai.zhipuai.api-key=abc123",
"spring.ai.zhipuai.embedding.options.model=MODEL_XYZ")
// @formatter:on
.withConfiguration(AutoConfigurations.of(SpringAiRetryAutoConfiguration.class,
RestClientAutoConfiguration.class, ZhiPuAiEmbeddingAutoConfiguration.class))
.withConfiguration(ZhiPuAiITUtil.zhiPuAiAutoConfig(ZhiPuAiEmbeddingAutoConfiguration.class))
.run(context -> {
var embeddingProperties = context.getBean(ZhiPuAiEmbeddingProperties.class);
var connectionProperties = context.getBean(ZhiPuAiConnectionProperties.class);
Expand All @@ -133,8 +127,7 @@ public void embeddingOverrideConnectionProperties() {
"spring.ai.zhipuai.embedding.api-key=456",
"spring.ai.zhipuai.embedding.options.model=MODEL_XYZ")
// @formatter:on
.withConfiguration(AutoConfigurations.of(SpringAiRetryAutoConfiguration.class,
RestClientAutoConfiguration.class, ZhiPuAiEmbeddingAutoConfiguration.class))
.withConfiguration(ZhiPuAiITUtil.zhiPuAiAutoConfig(ZhiPuAiEmbeddingAutoConfiguration.class))
.run(context -> {
var embeddingProperties = context.getBean(ZhiPuAiEmbeddingProperties.class);
var connectionProperties = context.getBean(ZhiPuAiConnectionProperties.class);
Expand All @@ -157,8 +150,7 @@ public void imageProperties() {
"spring.ai.zhipuai.api-key=abc123",
"spring.ai.zhipuai.image.options.model=MODEL_XYZ")
// @formatter:on
.withConfiguration(AutoConfigurations.of(SpringAiRetryAutoConfiguration.class,
RestClientAutoConfiguration.class, ZhiPuAiImageAutoConfiguration.class))
.withConfiguration(ZhiPuAiITUtil.zhiPuAiAutoConfig(ZhiPuAiImageAutoConfiguration.class))
.run(context -> {
var imageProperties = context.getBean(ZhiPuAiImageProperties.class);
var connectionProperties = context.getBean(ZhiPuAiConnectionProperties.class);
Expand All @@ -183,8 +175,7 @@ public void imageOverrideConnectionProperties() {
"spring.ai.zhipuai.image.api-key=456",
"spring.ai.zhipuai.image.options.model=MODEL_XYZ")
// @formatter:on
.withConfiguration(AutoConfigurations.of(SpringAiRetryAutoConfiguration.class,
RestClientAutoConfiguration.class, ZhiPuAiImageAutoConfiguration.class))
.withConfiguration(ZhiPuAiITUtil.zhiPuAiAutoConfig(ZhiPuAiImageAutoConfiguration.class))
.run(context -> {
var imageProperties = context.getBean(ZhiPuAiImageProperties.class);
var connectionProperties = context.getBean(ZhiPuAiConnectionProperties.class);
Expand Down Expand Up @@ -249,8 +240,7 @@ public void chatOptionsTest() {
"spring.ai.zhipuai.chat.options.thinking.type=disabled"
)
// @formatter:on
.withConfiguration(AutoConfigurations.of(SpringAiRetryAutoConfiguration.class,
RestClientAutoConfiguration.class, ZhiPuAiChatAutoConfiguration.class))
.withConfiguration(ZhiPuAiITUtil.zhiPuAiToolAutoConfig(ZhiPuAiChatAutoConfiguration.class))
.run(context -> {
var chatProperties = context.getBean(ZhiPuAiChatProperties.class);
var connectionProperties = context.getBean(ZhiPuAiConnectionProperties.class);
Expand Down Expand Up @@ -296,8 +286,7 @@ public void embeddingOptionsTest() {
"spring.ai.zhipuai.embedding.options.user=userXYZ"
)
// @formatter:on
.withConfiguration(AutoConfigurations.of(SpringAiRetryAutoConfiguration.class,
RestClientAutoConfiguration.class, ZhiPuAiEmbeddingAutoConfiguration.class))
.withConfiguration(ZhiPuAiITUtil.zhiPuAiAutoConfig(ZhiPuAiEmbeddingAutoConfiguration.class))
.run(context -> {
var connectionProperties = context.getBean(ZhiPuAiConnectionProperties.class);
var embeddingProperties = context.getBean(ZhiPuAiEmbeddingProperties.class);
Expand All @@ -319,8 +308,7 @@ public void imageOptionsTest() {
"spring.ai.zhipuai.image.options.user=userXYZ"
)
// @formatter:on
.withConfiguration(AutoConfigurations.of(SpringAiRetryAutoConfiguration.class,
RestClientAutoConfiguration.class, ZhiPuAiImageAutoConfiguration.class))
.withConfiguration(ZhiPuAiITUtil.zhiPuAiAutoConfig(ZhiPuAiImageAutoConfiguration.class))
.run(context -> {
var imageProperties = context.getBean(ZhiPuAiImageProperties.class);
var connectionProperties = context.getBean(ZhiPuAiConnectionProperties.class);
Expand All @@ -338,17 +326,15 @@ void embeddingActivation() {
new ApplicationContextRunner()
.withPropertyValues("spring.ai.zhipuai.api-key=API_KEY", "spring.ai.zhipuai.base-url=TEST_BASE_URL",
"spring.ai.model.embedding=none")
.withConfiguration(AutoConfigurations.of(SpringAiRetryAutoConfiguration.class,
RestClientAutoConfiguration.class, ZhiPuAiEmbeddingAutoConfiguration.class))
.withConfiguration(ZhiPuAiITUtil.zhiPuAiAutoConfig(ZhiPuAiEmbeddingAutoConfiguration.class))
.run(context -> {
assertThat(context.getBeansOfType(ZhiPuAiEmbeddingProperties.class)).isEmpty();
assertThat(context.getBeansOfType(ZhiPuAiEmbeddingModel.class)).isEmpty();
});

new ApplicationContextRunner()
.withPropertyValues("spring.ai.zhipuai.api-key=API_KEY", "spring.ai.zhipuai.base-url=TEST_BASE_URL")
.withConfiguration(AutoConfigurations.of(SpringAiRetryAutoConfiguration.class,
RestClientAutoConfiguration.class, ZhiPuAiEmbeddingAutoConfiguration.class))
.withConfiguration(ZhiPuAiITUtil.zhiPuAiAutoConfig(ZhiPuAiEmbeddingAutoConfiguration.class))
.run(context -> {
assertThat(context.getBeansOfType(ZhiPuAiEmbeddingProperties.class)).isNotEmpty();
assertThat(context.getBeansOfType(ZhiPuAiEmbeddingModel.class)).isNotEmpty();
Expand All @@ -357,8 +343,7 @@ void embeddingActivation() {
new ApplicationContextRunner()
.withPropertyValues("spring.ai.zhipuai.api-key=API_KEY", "spring.ai.zhipuai.base-url=TEST_BASE_URL",
"spring.ai.model.embedding=zhipuai")
.withConfiguration(AutoConfigurations.of(SpringAiRetryAutoConfiguration.class,
RestClientAutoConfiguration.class, ZhiPuAiEmbeddingAutoConfiguration.class))
.withConfiguration(ZhiPuAiITUtil.zhiPuAiAutoConfig(ZhiPuAiEmbeddingAutoConfiguration.class))
.run(context -> {
assertThat(context.getBeansOfType(ZhiPuAiEmbeddingProperties.class)).isNotEmpty();
assertThat(context.getBeansOfType(ZhiPuAiEmbeddingModel.class)).isNotEmpty();
Expand All @@ -370,17 +355,15 @@ void chatActivation() {
new ApplicationContextRunner()
.withPropertyValues("spring.ai.zhipuai.api-key=API_KEY", "spring.ai.zhipuai.base-url=TEST_BASE_URL",
"spring.ai.model.chat=none")
.withConfiguration(AutoConfigurations.of(SpringAiRetryAutoConfiguration.class,
RestClientAutoConfiguration.class, ZhiPuAiChatAutoConfiguration.class))
.withConfiguration(ZhiPuAiITUtil.zhiPuAiToolAutoConfig(ZhiPuAiChatAutoConfiguration.class))
.run(context -> {
assertThat(context.getBeansOfType(ZhiPuAiChatProperties.class)).isEmpty();
assertThat(context.getBeansOfType(ZhiPuAiChatModel.class)).isEmpty();
});

new ApplicationContextRunner()
.withPropertyValues("spring.ai.zhipuai.api-key=API_KEY", "spring.ai.zhipuai.base-url=TEST_BASE_URL")
.withConfiguration(AutoConfigurations.of(SpringAiRetryAutoConfiguration.class,
RestClientAutoConfiguration.class, ZhiPuAiChatAutoConfiguration.class))
.withConfiguration(ZhiPuAiITUtil.zhiPuAiToolAutoConfig(ZhiPuAiChatAutoConfiguration.class))
.run(context -> {
assertThat(context.getBeansOfType(ZhiPuAiChatProperties.class)).isNotEmpty();
assertThat(context.getBeansOfType(ZhiPuAiChatModel.class)).isNotEmpty();
Expand All @@ -389,8 +372,7 @@ void chatActivation() {
new ApplicationContextRunner()
.withPropertyValues("spring.ai.zhipuai.api-key=API_KEY", "spring.ai.zhipuai.base-url=TEST_BASE_URL",
"spring.ai.model.chat=zhipuai")
.withConfiguration(AutoConfigurations.of(SpringAiRetryAutoConfiguration.class,
RestClientAutoConfiguration.class, ZhiPuAiChatAutoConfiguration.class))
.withConfiguration(ZhiPuAiITUtil.zhiPuAiToolAutoConfig(ZhiPuAiChatAutoConfiguration.class))
.run(context -> {
assertThat(context.getBeansOfType(ZhiPuAiChatProperties.class)).isNotEmpty();
assertThat(context.getBeansOfType(ZhiPuAiChatModel.class)).isNotEmpty();
Expand All @@ -403,17 +385,15 @@ void imageActivation() {
new ApplicationContextRunner()
.withPropertyValues("spring.ai.zhipuai.api-key=API_KEY", "spring.ai.zhipuai.base-url=TEST_BASE_URL",
"spring.ai.model.image=none")
.withConfiguration(AutoConfigurations.of(SpringAiRetryAutoConfiguration.class,
RestClientAutoConfiguration.class, ZhiPuAiImageAutoConfiguration.class))
.withConfiguration(ZhiPuAiITUtil.zhiPuAiAutoConfig(ZhiPuAiImageAutoConfiguration.class))
.run(context -> {
assertThat(context.getBeansOfType(ZhiPuAiImageProperties.class)).isEmpty();
assertThat(context.getBeansOfType(ZhiPuAiImageModel.class)).isEmpty();
});

new ApplicationContextRunner()
.withPropertyValues("spring.ai.zhipuai.api-key=API_KEY", "spring.ai.zhipuai.base-url=TEST_BASE_URL")
.withConfiguration(AutoConfigurations.of(SpringAiRetryAutoConfiguration.class,
RestClientAutoConfiguration.class, ZhiPuAiImageAutoConfiguration.class))
.withConfiguration(ZhiPuAiITUtil.zhiPuAiAutoConfig(ZhiPuAiImageAutoConfiguration.class))
.run(context -> {
assertThat(context.getBeansOfType(ZhiPuAiImageProperties.class)).isNotEmpty();
assertThat(context.getBeansOfType(ZhiPuAiImageModel.class)).isNotEmpty();
Expand All @@ -422,8 +402,7 @@ void imageActivation() {
new ApplicationContextRunner()
.withPropertyValues("spring.ai.zhipuai.api-key=API_KEY", "spring.ai.zhipuai.base-url=TEST_BASE_URL",
"spring.ai.model.image=zhipuai")
.withConfiguration(AutoConfigurations.of(SpringAiRetryAutoConfiguration.class,
RestClientAutoConfiguration.class, ZhiPuAiImageAutoConfiguration.class))
.withConfiguration(ZhiPuAiITUtil.zhiPuAiAutoConfig(ZhiPuAiImageAutoConfiguration.class))
.run(context -> {
assertThat(context.getBeansOfType(ZhiPuAiImageProperties.class)).isNotEmpty();
assertThat(context.getBeansOfType(ZhiPuAiImageModel.class)).isNotEmpty();
Expand Down
Loading