|
此版本仍在开发中,尚未被视为稳定版。如需最新的快照版本,请使用 Spring AI 1.1.3! |
Azure OpenAI 图像生成
Spring AI 支持来自 Azure OpenAI 的 gpt-image-1-mini 图像生成模型。
前置条件
从 Azure 门户 的 Azure OpenAI 服务部分获取您的 Azure OpenAI endpoint 和api-key。
Spring AI 定义了两个配置属性:
-
spring.ai.azure.openai.api-key: 将其设置为从Azure获得的API Key的值。 -
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' 的部署可以配置为使用 'gpt-image-1-mini' 模型。
目前,为了保持简单,您可以使用以下设置创建部署:
部署名称:MyImgAiDeployment
模型名称:gpt-image-1-mini
此 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。
Auto-configuration
|
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=azure-openai(默认已启用) 要禁用,请设置 spring.ai.model.image=none(或任何不与 azure-openai 匹配的值) 此更改是为了允许配置多个模型。 |
前缀 spring.ai.azure.openai.image 是属性前缀,用于配置 Azure OpenAI 的 ImageModel 实现。
<property> </property> |
<description> </description> |
默认 |
spring.ai.azure.openai.image.enabled(已移除且不再生效) |
启用 Azure OpenAI 图像模型。 |
true |
spring.ai.model.image |
启用图像模型。对于 Azure OpenAI,请设置为 |
azure-openai |
spring.ai.azure.openai.image.options.n |
要生成的图像数量(例如,对于 gpt-image-1-mini 为 1)。 |
- |
spring.ai.azure.openai.image.options.model |
用于图像生成的模型(例如 |
gpt-image-1-mini |
spring.ai.azure.openai.image.options.deployment-name |
在 Azure AI Studio 中为您的图像模型定义的部署名称。 |
- |
spring.ai.azure.openai.image.options.response_format |
生成图像的返回格式。必须是 URL 或 b64_json 之一。 |
- |
spring.ai.azure.openai.image.options.size |
生成图像的尺寸(例如 1024x1024)。请查阅 Azure 文档以了解您的模型支持的尺寸。 |
- |
spring.ai.azure.openai.image.options.size_width |
生成图像的宽度。 |
- |
spring.ai.azure.openai.image.options.size_height |
生成图像的高度。 |
- |
spring.ai.azure.openai.image.options.user |
代表最终用户的唯一标识符,可帮助 Azure OpenAI 监控和检测滥用行为。 |
- |
连接属性
前缀 spring.ai.azure.openai 用作属性前缀,让您能够连接到 Azure OpenAI。
<property> </property> |
<description> </description> |
默认 |
spring.ai.azure.openai.endpoint |
要连接的 URL(例如 <your-resource>.openai.azure.com/) |
- |
spring.ai.azure.openai.apiKey |
API密钥 |
- |
运行时选项
AzureOpenAiImageOptions 提供模型配置,例如部署名称、模型和图像大小。
在启动时,可以使用 AzureOpenAiImageModel(OpenAIClient openAIClient, AzureOpenAiImageOptions options) 构造函数配置默认选项。或者,使用前面描述的 spring.ai.azure.openai.image.options.* 属性。
在运行时,您可以通过向 ImagePrompt 调用添加特定于请求的选项来覆盖默认选项。
例如,要使用具有自定义大小的 gpt-image-1-mini 模型:
ImageResponse response = azureOpenAiImageModel.call(
new ImagePrompt("A light cream colored mini golden doodle",
AzureOpenAiImageOptions.builder()
.model("gpt-image-1-mini")
.deploymentName("gpt-image-1-mini")
.height(1024)
.width(1024)
.build())
);
| 除了模型特定的 AzureOpenAiImageOptions 之外,您还可以使用通过 ImageOptionsBuilder#builder() 创建的可移植 ImageOptions 实例。 |