ZhiPuAI图像生成

Spring AI 支持来自智谱AI的图像生成模型CogView。spring-doc.cadn.net.cn

前提条件

你需要通过ZhiPuAI创建一个API,以访问ZhiPu AI语言模型。spring-doc.cadn.net.cn

ZhiPu AI 注册页面创建账户,并在API密钥页面生成Tokens。spring-doc.cadn.net.cn

Spring AI项目定义了一个名为spring.ai.zhipuai.api-key的配置属性,您应将其设置为从API密钥页面获取的API Key值。spring-doc.cadn.net.cn

您可以在application.properties文件中设置此配置属性:spring-doc.cadn.net.cn

spring.ai.zhipuai.api-key=<your-zhipuai-api-key>

为了在处理API密钥等敏感信息时增强安全性,您可以使用Spring表达式语言(SpEL)引用自定义环境变量:spring-doc.cadn.net.cn

# In application.yml
spring:
  ai:
    zhipuai:
      api-key: ${ZHIPUAI_API_KEY}
# In your environment or .env file
export ZHIPUAI_API_KEY=<your-zhipuai-api-key>

您也可以在应用程序代码中以编程方式设置此配置:spring-doc.cadn.net.cn

// Retrieve API key from a secure source or environment variable
String apiKey = System.getenv("ZHIPUAI_API_KEY");

添加仓库和BOM

Spring AI 工件发布在 Maven Central 和 Spring Snapshot 仓库中。 请参阅 工件仓库 部分,以将这些仓库添加到您的构建系统。spring-doc.cadn.net.cn

为了帮助管理依赖,Spring AI 提供了一个 BOM(物料清单),以确保在整个项目中使用一致的 Spring AI 版本。请参阅 依赖管理 部分,将 Spring AI BOM 添加到您的构建系统。spring-doc.cadn.net.cn

自动配置

There has been a significant change in the Spring AI auto-configuration, starter modules' artifact names. Please refer to the 升级说明以获取更多信息。spring-doc.cadn.net.cn

Spring AI提供针对ZhiPuAI聊天客户端的自动生成配置。 要使它工作,将以下依赖项添加到项目Maven pom.xml文件中:spring-doc.cadn.net.cn

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-starter-model-zhipuai</artifactId>
</dependency>

或者添加到您的Gradle 构建脚本文件中。spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-model-zhipuai'
}
参考以下依赖管理部分,添加Spring AI BOM到你的构建文件中。

图像生成属性

图片自动配置的启用和禁用现在通过带有前缀spring.mvc.static-path-pattern的顶级属性进行配置。spring-doc.cadn.net.cn

要启用,请设置 spring.ai.model.image=stabilityai (默认情况下已启用)spring-doc.cadn.net.cn

要禁用,请设置 spring.ai.model.image=none(或任何不匹配stabilityai的值)。spring-doc.cadn.net.cn

这种修改是为了允许配置多个模型。spring-doc.cadn.net.cn

前缀 spring.ai.zhipuai.image 是属性前缀,允许您为 ZhiPuAI 配置 ImageModel 实现。spring-doc.cadn.net.cn

属性spring-doc.cadn.net.cn

描述spring-doc.cadn.net.cn

默认spring-doc.cadn.net.cn

spring.ai.zhipuai.image.enabled(已移除,不再有效)spring-doc.cadn.net.cn

启用ZhiPuAI图像模型。spring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

spring.ai.model.imagespring-doc.cadn.net.cn

启用ZhiPuAI图像模型。spring-doc.cadn.net.cn

智图AIspring-doc.cadn.net.cn

spring.ai.zhipuai.image.base-urlspring-doc.cadn.net.cn

可选地,覆盖 `spring.ai.zhipuai.base-url` 以提供聊天特定的URL。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.zhipuai.image.api-keyspring-doc.cadn.net.cn

可选地,覆盖 `spring.ai.zhipuai.api-key` 以提供聊天特定的 api 密钥。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.zhipuai.image.options.modelspring-doc.cadn.net.cn

用于图像生成的模型。spring-doc.cadn.net.cn

cogview-3spring-doc.cadn.net.cn

spring.ai.zhipuai.image.options.userspring-doc.cadn.net.cn

一个代表你的终端用户的唯一标识符,有助于ZhiPuAI进行监控和检测滥用行为。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

连接属性

The prefix spring.ai.zhipuai is used as the property prefix that lets you connect to ZhiPuAI.spring-doc.cadn.net.cn

属性spring-doc.cadn.net.cn

描述spring-doc.cadn.net.cn

默认spring-doc.cadn.net.cn

spring.ai.zhipuai.base-urlspring-doc.cadn.net.cn

要连接的URLspring-doc.cadn.net.cn

open.bigmodel.cn/api/paasspring-doc.cadn.net.cn

spring.ai.zhipuai.api-keyspring-doc.cadn.net.cn

API 密钥spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

配置属性

重试属性

前缀 spring.ai.retry 用于作为属性前缀,允许您配置ZhiPuAI图像客户端的重试机制。spring-doc.cadn.net.cn

属性 描述 默认

spring.ai.retry.max-attemptsspring-doc.cadn.net.cn

最大重试次数。spring-doc.cadn.net.cn

10spring-doc.cadn.net.cn

spring.ai.retry.backoff.initial-intervalspring-doc.cadn.net.cn

指数退避策略的初始睡眠时长。spring-doc.cadn.net.cn

2 秒spring-doc.cadn.net.cn

spring.ai.retry.backoff.multiplierspring-doc.cadn.net.cn

退避间隔乘数。spring-doc.cadn.net.cn

5spring-doc.cadn.net.cn

spring.ai.retry.backoff.max-intervalspring-doc.cadn.net.cn

最大退避时长。spring-doc.cadn.net.cn

3 分钟。spring-doc.cadn.net.cn

spring.ai.retry.on-client-errorsspring-doc.cadn.net.cn

如果为false,则抛出NonTransientAiException,且不重试客户端错误代码4xxspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

spring.ai.retry.exclude-on-http-codesspring-doc.cadn.net.cn

不应触发重试的HTTP状态代码列表(例如,用于抛出非暂时性AI异常)。spring-doc.cadn.net.cn

emptyspring-doc.cadn.net.cn

spring.ai.retry.on-http-codesspring-doc.cadn.net.cn

应触发重试的HTTP状态码列表(例如,用于抛出TransientAiException)。spring-doc.cadn.net.cn

emptyspring-doc.cadn.net.cn

运行时选项

ZhiPuAiImageOptions.java 提供了模型配置,如使用的模型、质量、大小等。spring-doc.cadn.net.cn

在启动时,默认选项可以通过 ZhiPuAiImageModel(ZhiPuAiImageApi zhiPuAiImageApi) 构造器和 withDefaultOptions(ZhiPuAiImageOptions defaultOptions) 方法进行配置。或者,使用之前描述的 spring.ai.zhipuai.image.options.* 属性。spring-doc.cadn.net.cn

在运行时,您可以通过向ImagePrompt调用添加新的、特定于请求的选项来覆盖默认选项。 例如,要覆盖与ZhiPuAI相关的特定选项,如质量及要创建的图片数量,请使用以下代码示例:spring-doc.cadn.net.cn

ImageResponse response = zhiPuAiImageModel.call(
        new ImagePrompt("A light cream colored mini golden doodle",
        ZhiPuAiImageOptions.builder()
                .quality("hd")
                .N(4)
                .height(1024)
                .width(1024).build())

);
除了特定于模型的ZhiPuAiImageOptions之外,您还可以使用可移植的ImageOptions实例,通过ImageOptionsBuilder#builder()创建。