此版本仍在开发中,尚不被认为是稳定的。对于最新的快照版本,请使用 Spring AI 1.0.1! |
Azure OpenAI 图像生成
Spring AI 支持 DALL-E,这是 Azure OpenAI 中的图像生成模型。
前提条件
获取 Azure OpenAIendpoint
和api-key
从 Azure 门户上的 Azure OpenAI 服务部分。
Spring AI 定义了两个配置属性:
-
spring.ai.azure.openai.api-key
:将此值设置为API Key
从 Azure 获得。 -
spring.ai.azure.openai.endpoint
:将此设置为在 Azure 中预配模型时获取的终结点 URL。
您可以在application.properties
文件:
spring.ai.azure.openai.api-key=<your-azure-openai-api-key>
spring.ai.azure.openai.endpoint=<your-azure-openai-endpoint>
为了在处理 API 密钥等敏感信息时增强安全性,您可以使用 Spring 表达式语言 (SpEL) 来引用自定义环境变量:
# In application.yml
spring:
ai:
azure:
openai:
api-key: ${AZURE_OPENAI_API_KEY}
endpoint: ${AZURE_OPENAI_ENDPOINT}
# In your environment or .env file
export AZURE_OPENAI_API_KEY=<your-azure-openai-api-key>
export AZURE_OPENAI_ENDPOINT=<your-azure-openai-endpoint>
您还可以在应用程序代码中以编程方式设置这些配置:
// Retrieve API key and endpoint from secure sources or environment variables
String apiKey = System.getenv("AZURE_OPENAI_API_KEY");
String endpoint = System.getenv("AZURE_OPENAI_ENDPOINT");
部署名称
若要使用运行 Azure AI 应用程序,请通过 [Azure AI 门户](oai.azure.com/portal) 创建 Azure AI 部署。
在 Azure 中,每个客户端都必须指定Deployment Name
连接到 Azure OpenAI 服务。
必须了解Deployment Name
与您选择部署的模型不同
例如,可以将名为“MyImgAiDeployment”的部署配置为使用Dalle3
model 或Dalle2
型。
目前,为了简单起见,可以使用以下设置创建部署:
部署名称:MyImgAiDeployment
型号名称:Dalle3
此 Azure 配置将与 Spring Boot Azure AI Starter 及其自动配置功能的默认配置保持一致。
如果使用不同的部署名称,请相应地更新配置属性:
spring.ai.azure.openai.image.options.deployment-name=<my deployment name>
Azure OpenAI 和 OpenAI 的不同部署结构导致 Azure OpenAI 客户端库中名为deploymentOrModelName
.
这是因为在 OpenAI 中没有Deployment Name
,只有一个Model Name
.
添加存储库和 BOM
Spring AI 工件发布在 Maven Central 和 Spring Snapshot 存储库中。 请参阅 Artifact Repositories 部分,将这些存储库添加到您的构建系统中。
为了帮助进行依赖管理,Spring AI 提供了 BOM(物料清单),以确保在整个项目中使用一致的 Spring AI 版本。请参阅依赖项管理部分,将 Spring AI BOM 添加到您的构建系统中。
自动配置
Spring AI 自动配置、入门模块的工件名称发生了重大变化。 有关更多信息,请参阅升级说明。 |
Spring AI 为 Azure OpenAI 聊天客户端提供 Spring Boot 自动配置。
要启用它,请将以下依赖项添加到项目的 Mavenpom.xml
文件:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-model-azure-openai</artifactId>
</dependency>
或 Gradlebuild.gradle
构建文件。
dependencies {
implementation 'org.springframework.ai:spring-ai-starter-model-azure-openai'
}
请参阅依赖项管理部分,将 Spring AI BOM 添加到构建文件中。 |
图像生成属性
现在,通过前缀为 要启用,spring.ai.model.image=azure-openai(默认启用) 若要禁用,请 spring.ai.model.image=none(或任何与 azure-openai 不匹配的值) 进行此更改是为了允许配置多个模型。 |
前缀spring.ai.openai.image
是属性前缀,用于配置ImageModel
OpenAI 的实施。
属性 |
描述 |
默认值 |
spring.ai.azure.openai.image.enabled(已删除且不再有效) |
启用 OpenAI 图像模型。 |
true |
spring.ai.model.image |
启用 OpenAI 图像模型。 |
azure-openai |
spring.ai.azure.openai.image.options.n |
要生成的图像数量。必须介于 1 到 10 之间。对于 dall-e-3,仅支持 n=1。 |
- |
spring.ai.azure.openai.image.options.model |
用于图像生成的模型。 |
AzureOpenAiImageOptions.DEFAULT_IMAGE_MODEL |
spring.ai.azure.openai.image.options.quality |
将生成的图像的质量。高清创建的图像具有更精细的细节和更大的图像一致性。此参数仅支持 dall-e-3。 |
- |
spring.ai.azure.openai.image.options.response_format |
返回生成图像的格式。必须是 URL 或 b64_json 之一。 |
- |
|
生成的图像的大小。对于 dall-e-2,必须是 256x256、512x512 或 1024x1024 之一。对于 dall-e-3 型号,必须是 1024x1024、1792x1024 或 1024x1792 之一。 |
- |
|
生成图像的宽度。对于 dall-e-2,必须是 256、512 或 1024 之一。 |
- |
|
生成图像的高度。对于 dall-e-2,必须是 256、512 或 1024 之一。 |
- |
|
生成图像的样式。必须是生动或自然的。生动使模型倾向于生成超真实和戏剧性的图像。自然使模型生成更自然、更不那么超真实的图像。此参数仅支持 dall-e-3。 |
- |
|
表示最终用户的唯一标识符,可帮助 Azure OpenAI 监视和检测滥用行为。 |
- |
运行时选项
OpenAiImageOptions.java提供型号配置,例如要使用的型号、质量、尺寸等。
启动时,可以使用AzureOpenAiImageModel(OpenAiImageApi openAiImageApi)
构造函数和withDefaultOptions(OpenAiImageOptions defaultOptions)
方法。 或者,使用spring.ai.azure.openai.image.options.*
前面描述的属性。
在运行时,您可以通过向ImagePrompt
叫。 例如,要覆盖 OpenAI 特定选项,例如质量和要创建的图像数量,请使用以下代码示例:
ImageResponse response = azureOpenaiImageModel.call(
new ImagePrompt("A light cream colored mini golden doodle",
OpenAiImageOptions.builder()
.quality("hd")
.N(4)
.height(1024)
.width(1024).build())
);
除了特定于模型的 AzureOpenAiImageOptions 之外,还可以使用使用 ImageOptionsBuilder#builder() 创建的可移植 ImageOptions 实例。 |