智谱AI 图像生成
Spring AI 支持智谱AI的CogView图像生成模型。
先决条件
您需要创建一个API来访问智谱AI的语言模型。
前往智谱AI注册页面创建账户,并在API Keys页面生成token。
Spring AI 项目定义了一个名为 spring.ai.zhipuai.api-key 的配置属性,你应将其设置为从 API Keys 页面获取的 API Key 的值。
您可以在 application.properties 文件中设置此配置属性:
spring.ai.zhipuai.api-key=<your-zhipuai-api-key>
为增强处理敏感信息(如API密钥)时的安全性,您可以使用Spring表达式语言(SpEL)来引用自定义环境变量:
# 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>
你也可以在应用程序代码中通过编程方式设置此配置:
// Retrieve API key from a secure source or environment variable
String apiKey = System.getenv("ZHIPUAI_API_KEY");
添加仓库与物料清单
Spring AI 工件发布在 Maven Central 和 Spring Snapshot 仓库中。请参考工件仓库章节,将这些仓库添加到您的构建系统中。
为便于管理依赖项,Spring AI 提供了一个物料清单(BOM),以确保在整个项目中使用统一版本的 Spring AI。请参阅依赖项管理部分,将 Spring AI BOM 添加到您的构建系统中。
Auto-configuration
Spring AI 的自动配置和 starter 模块的 artifact 名称发生了重大变化。更多信息请参考升级说明。
Spring AI为智谱AI聊天客户端提供了Spring Boot自动配置功能。要启用此功能,请将以下依赖项添加到项目的Maven pom.xml文件中:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-model-zhipuai</artifactId>
</dependency>
添加到您的 Gradle build.gradle 构建文件中。
dependencies {
implementation 'org.springframework.ai:spring-ai-starter-model-zhipuai'
}
:::提示
请参考 依赖管理 章节,将 Spring AI BOM 添加到您的构建文件中。
:::
图像生成属性
:::注意
图像自动配置的启用与禁用现在通过前缀为 spring.ai.model.image 的顶级属性进行配置。
要启用,设置 spring.ai.model.image=stabilityai(默认已启用)
要禁用,设置 spring.ai.model.image=none(或任何与 stabilityai 不匹配的值)
此项更改旨在支持配置多个模型。
:::
前缀 spring.ai.zhipuai.image 是用于配置智谱AI ImageModel 实现的属性前缀。
| 属性 | 描述 | 默认值 |
|---|---|---|
| spring.ai.zhipuai.image.enabled (已移除且不再生效) | 启用智谱AI图像模型。 | true |
| spring.ai.model.image | 启用智谱AI图像模型。 | zhipuai |
| spring.ai.zhipuai.image.base-url | 可选参数,用于覆盖 spring.ai.zhipuai.base-url,以提供特定于图像功能的 URL | - |
| spring.ai.zhipuai.image.api-key | 可选参数,用于覆盖 spring.ai.zhipuai.api-key,以提供特定于图像功能的 API 密钥 | - |
| spring.ai.zhipuai.image.options.model | 用于图像生成的模型。 | cogview-3 |
| spring.ai.zhipuai.image.options.user | 代表您终端用户的唯一标识符,可帮助智谱AI监控和检测滥用行为。 | - |
连接属性
前缀 spring.ai.zhipuai 用作属性前缀,允许您连接到 ZhiPuAI。
| 属性 | 描述 | 默认值 |
|---|---|---|
| spring.ai.zhipuai.base-url | 连接到的 URL | open.bigmodel.cn/api/paas |
| spring.ai.zhipuai.api-key | API 密钥 | - |
配置属性
重试属性
spring.ai.retry 前缀用作属性前缀,允许您为智谱AI图像客户端配置重试机制。
| 属性 | 描述 | 默认值 |
|---|---|---|
| spring.ai.retry.max-attempts | 最大重试次数。 | 10 |
| spring.ai.retry.backoff.initial-interval | 指数退避策略的初始休眠时长。 | 2 秒 |
| spring.ai.retry.backoff.multiplier | 退避间隔乘数。 | 5 |
| spring.ai.retry.backoff.max-interval | 最大退避时长。 | 3 分钟 |
| spring.ai.retry.on-client-errors | 若为 false,则针对 4xx 客户端错误码,抛出 NonTransientAiException 且不进行重试。 | false |
| spring.ai.retry.exclude-on-http-codes | 不应触发重试(例如,用于抛出 NonTransientAiException)的 HTTP 状态码列表。 | empty |
| spring.ai.retry.on-http-codes | 应触发重试(例如,用于抛出 TransientAiException)的 HTTP 状态码列表。 | empty |
运行时选项
ZhiPuAiImageOptions.java 提供了模型配置选项,例如要使用的模型、图像质量、尺寸等。
在启动时,可以通过 ZhiPuAiImageModel(ZhiPuAiImageApi zhiPuAiImageApi) 构造函数和 withDefaultOptions(ZhiPuAiImageOptions defaultOptions) 方法来配置默认选项。或者,也可以使用前面描述的 spring.ai.zhipuai.image.options.* 属性。
在运行时,你可以通过向 ImagePrompt 调用添加新的、针对特定请求的选项来覆盖默认设置。例如,要覆盖智谱AI特有的选项,比如生成图像的质量和数量,可以使用以下代码示例:
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() 创建。