智谱 AI 图像生成

Spring AI 支持智谱 AI 的 CogView 图像生成模型。

前提条件

您需要创建一个 API 来访问智谱 AI 语言模型。

智谱 AI 注册页面 创建账户,并在 API 密钥页面 生成令牌。

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

您可以在 application.properties 文件中设置此配置属性:

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

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

# 在 application.yml 中
spring:
  ai:
    zhipuai:
      api-key: ${ZHIPUAI_API_KEY}
# 在您的环境或 .env 文件中
export ZHIPUAI_API_KEY=<your-zhipuai-api-key>

您也可以在应用程序代码中以编程方式设置此配置:

// 从安全源或环境变量中获取 API 密钥
String apiKey = System.getenv("ZHIPUAI_API_KEY");

添加仓库和 BOM

Spring AI 构件发布在 Maven Central 和 Spring Snapshot 仓库中。 请参考 构件仓库 部分,将这些仓库添加到您的构建系统中。

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

自动配置

Spring AI 自动配置、starter 模块的构件名称发生了重大变化。 请参考 升级说明 了解更多信息。

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-key

-

spring.ai.zhipuai.image.options.model

用于图像生成的模型。

cogview-3

spring.ai.zhipuai.image.options.user

代表您的最终用户的唯一标识符,可以帮助智谱 AI 监控和检测滥用。

-

连接属性

前缀 spring.ai.zhipuai 是允许您连接到智谱 AI 的属性前缀。

属性

描述

默认值

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,则抛出 NonTransientAiException,并且不对 4xx 客户端错误代码进行重试

false

spring.ai.retry.exclude-on-http-codes

不应触发重试的 HTTP 状态代码列表(例如,抛出 NonTransientAiException)。

spring.ai.retry.on-http-codes

应触发重试的 HTTP 状态代码列表(例如,抛出 TransientAiException)。

运行时选项

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() 创建。