Azure OpenAI 图像生成
Spring AI 支持 DALL-E,这是来自 Azure OpenAI 的图像生成模型。
先决条件
从 Azure 门户 的 Azure OpenAI 服务部分获取你的 Azure OpenAI endpoint 和 api-key。
Spring AI 定义了两个配置属性:
-
spring.ai.azure.openai.api-key: 将其设置为从 Azure 获取的API 密钥值。 -
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 Expression Language (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 门户 创建 Azure AI 部署。
在 Azure 中,每个客户端必须指定一个 Deployment Name 以连接到 Azure OpenAI 服务。
必须明确的是,Deployment Name 与你选择部署的模型是不同的
例如,一个名为'MyImgAiDeployment'的部署可以配置为使用 Dalle3 模型或 Dalle2 模型。
目前,为了保持简单,你可以使用以下设置创建部署:
部署名称:MyImgAiDeployment 模型名称:Dalle3
此 Azure 配置将与 Spring Boot Azure AI Starter 及其自动配置功能的默认配置保持一致。
如果使用了不同的 Deployment 名称,请相应更新配置属性:
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 仓库中。请参考 构件仓库 章节,将这些仓库添加到您的构建系统中。
为协助依赖项管理,Spring AI 提供了物料清单(BOM),以确保在整个项目中始终使用一致的 Spring AI 版本。请参考依赖项管理部分,将 Spring AI BOM 添加到您的构建系统中。
自动配置
Spring AI 的自动配置以及 starter 模块的 artifact 名称发生了重大变化。更多信息请参考 升级说明。
Spring AI 为 Azure OpenAI 聊天客户端提供了 Spring Boot 自动配置。要启用此功能,请将以下依赖项添加到项目的 Maven pom.xml 文件中:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-model-azure-openai</artifactId>
</dependency>
或将其添加到你的 Gradle build.gradle 构建文件中。
dependencies {
implementation 'org.springframework.ai:spring-ai-starter-model-azure-openai'
}
:::提示
请参考 依赖管理 章节,将 Spring AI BOM 添加到你的构建文件中。
:::
图像生成属性
现在通过前缀为 spring.ai.model.image 的顶级属性来配置图像自动配置的启用与禁用。
要启用,设置 spring.ai.model.image=azure-openai (默认已启用)
要禁用,设置 spring.ai.model.image=none (或任何不匹配 azure-openai 的值)
此项变更是为了支持配置多个模型。
前缀 spring.ai.openai.image 是用于配置 OpenAI ImageModel 实现的属性前缀。
| 属性 | 描述 | 默认值 |
|---|---|---|
| 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 | 将生成的图像质量。HD 创建具有更精细细节和整个图像一致性更高的图像。此参数仅支持 dall-e-3。 | - |
| spring.ai.azure.openai.image.options.response_format | 返回生成的图像的格式。必须是 URL 或 b64_json 之一。 | - |
spring.ai.openai.image.options.size | 生成图像的尺寸。对于 dall-e-2,必须是 256x256、512x512 或 1024x1024 之一。对于 dall-e-3 模型,必须是 1024x1024、1792x1024 或 1024x1792 之一。 | - |
spring.ai.openai.image.options.size_width | 生成图像的宽度。对于 dall-e-2,必须是 256、512 或 1024 之一。 | - |
spring.ai.openai.image.options.size_height | 生成图像的高度。对于 dall-e-2,必须是 256、512 或 1024 之一。 | - |
spring.ai.openai.image.options.style | 生成图像的风格。必须是 vivid 或 natural 之一。Vivid 会使模型倾向于生成超真实和戏剧性的图像。Natural 会使模型产生更自然、看起来不那么超真实的图像。此参数仅支持 dall-e-3。 | - |
spring.ai.openai.image.options.user | 一个代表您最终用户的唯一标识符,可以帮助 Azure OpenAI 监控和检测滥用行为。 | - |
连接属性
spring.ai.openai 用作属性前缀,使您能够连接到 Azure OpenAI。
| 属性 | 描述 | 默认值 |
|---|---|---|
| spring.ai.azure.openai.endpoint | 连接的 URL | my-dalle3.openai.azure.com/ |
| spring.ai.azure.openai.apiKey | API 密钥 | - |
运行时选项
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 外,您还可以使用可移植的 ImageOptions 实例,该实例可通过 ImageOptionsBuilder#builder() 创建。
:::