此版本仍在开发中,尚未被视为稳定版本。最新的快照版本请使用 Spring AI 1.0.0-SNAPSHOT! |
ZhiPuAI 图像生成
Spring AI 支持 CogView,这是 ZhiPuAI 的图像生成模型。
先决条件
您需要使用 ZhiPuAI 创建 API 才能访问 ZhiPu AI 语言模型。
在 智普 AI 注册页面创建账号,并在 API Keys 页面生成 Token。
Spring AI 项目定义了一个名为 config property 的配置属性,您应该将其设置为从 API Keys 页面获取的值。
导出环境变量是设置该配置属性的一种方法:spring.ai.zhipuai.api-key
API Key
export SPRING_AI_ZHIPU_AI_API_KEY=<INSERT KEY HERE>
添加存储库和 BOM
Spring AI 工件发布在 Spring Milestone 和 Snapshot 存储库中。 请参阅 Repositories 部分,将这些存储库添加到您的构建系统中。
为了帮助进行依赖项管理,Spring AI 提供了一个 BOM(物料清单),以确保在整个项目中使用一致的 Spring AI 版本。请参阅依赖项管理部分,将 Spring AI BOM 添加到您的构建系统中。
自动配置
Spring AI 为 ZhiPuAI Chat 客户端提供了 Spring Boot 自动配置。
要启用它,请将以下依赖项添加到项目的 Maven 文件中:pom.xml
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-zhipuai-spring-boot-starter</artifactId>
</dependency>
或您的 Gradle 构建文件。build.gradle
dependencies {
implementation 'org.springframework.ai:spring-ai-zhipuai-spring-boot-starter'
}
请参阅 Dependency Management 部分,将 Spring AI BOM 添加到您的构建文件中。 |
图像生成属性
prefix 是允许您为 ZhiPuAI 配置实现的属性 prefix。spring.ai.zhipuai.image
ImageModel
财产 |
描述 |
违约 |
spring.ai.zhipuai.image.enabled |
启用 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 |
用于图像生成的模型。 |
认知 3 |
spring.ai.zhipuai.image.options.user |
代表您的最终用户的唯一标识符,可以帮助ZhiPuAI 监控和检测滥用行为。 |
- |
连接属性
该前缀用作允许您连接到 ZhiPuAI 的属性前缀。spring.ai.zhipuai
财产 |
描述 |
违约 |
spring.ai.zhipuai.base-url |
要连接到的 URL |
|
spring.ai.zhipuai.api-key |
API 密钥 |
- |
重试属性
该前缀用作属性前缀,用于配置 ZhiPuAI Image 客户端的重试机制。spring.ai.retry
财产 | 描述 | 违约 |
---|---|---|
spring.ai.retry.max 次尝试 |
最大重试尝试次数。 |
10 |
spring.ai.retry.backoff.initial-interval |
指数回退策略的初始休眠持续时间。 |
2 秒 |
spring.ai.retry.backoff.multiplier |
Backoff interval 乘数。 |
5 |
spring.ai.retry.backoff.max 间隔 |
最大回退持续时间。 |
3 分钟 |
spring.ai.retry.on-client-errors |
如果为 false,则引发 NonTransientAiException,并且不要尝试重试客户端错误代码 |
假 |
spring.ai.retry.exclude-on-http-codes |
不应触发重试的 HTTP 状态代码列表(例如,引发 NonTransientAiException)。 |
空 |
spring.ai.retry.on-http-codes |
应触发重试的 HTTP 状态代码列表(例如,引发 TransientAiException)。 |
空 |
运行时选项
ZhiPuAiImageOptions.java 提供模型配置,例如要使用的模型、质量、大小等。
启动时,可以使用 constructor 和 method 配置默认选项。或者,使用前面描述的属性。ZhiPuAiImageModel(ZhiPuAiImageApi zhiPuAiImageApi)
withDefaultOptions(ZhiPuAiImageOptions defaultOptions)
spring.ai.zhipuai.image.options.*
在运行时,您可以通过向调用添加新的、特定于请求的选项来覆盖默认选项。
例如,要覆盖 ZhiPuAI 特定的选项,例如质量和要创建的图像数量,请使用以下代码示例:ImagePrompt
ImageResponse response = zhiPuAiImageModel.call(
new ImagePrompt("A light cream colored mini golden doodle",
ZhiPuAiImageOptions.builder()
.withQuality("hd")
.withN(4)
.withHeight(1024)
.withWidth(1024).build())
);
除了特定于模型的 ZhiPuAiImageOptions 之外,您还可以使用通过 ImageOptionsBuilder#builder() 创建的可移植 ImageOptions 实例。 |