前提条件
Azure OpenAI 客户端提供三种连接选项:使用 Azure API 密钥、使用 OpenAI API 密钥或使用 Microsoft Entra ID。Azure API 密钥和终结点
要使用 API 密钥访问模型,请从 Azure 门户上的 Azure OpenAI 服务部分获取你的 Azure OpenAIendpoint 和 api-key。
Spring AI 定义了两个配置属性:
spring.ai.azure.openai.api-key:将其设置为从 Azure 获取的API 密钥的值。spring.ai.azure.openai.endpoint:将其设置为在 Azure 中配置模型时获取的终结点 URL。
application.properties 或 application.yml 文件中设置这些配置属性:
- application.properties
- application.yml
- .env
OpenAI 密钥
要向 OpenAI 服务(而非 Azure)进行身份验证,请提供 OpenAI API 密钥。这会自动将终结点设置为 https://api.openai.com/v1。 使用此方法时,请将spring.ai.azure.openai.chat.options.deployment-name 属性设置为要使用的 OpenAI 模型的名称。
在你的应用程序配置中:
- application.properties
- application.yml
- .env
Microsoft Entra ID
要使用 Microsoft Entra ID(以前称为 Azure Active Directory)进行无密钥身份验证,请_仅_设置spring.ai.azure.openai.endpoint 配置属性,而_不_设置上面提到的 api-key 属性。
仅找到终结点属性后,你的应用程序将评估几个不同的凭据检索选项,并使用令牌凭据创建 OpenAIClient 实例。
不再需要创建
TokenCredential bean;它会自动为你配置。部署名称
要使用 Azure AI 应用程序,你需要通过 Azure AI 门户创建一个 Azure AI 部署。 在 Azure 中,每个客户端都必须指定一个Deployment Name 才能连接到 Azure OpenAI 服务。
需要注意的是,Deployment Name 与你选择部署的模型不同。
例如,名为”MyAiDeployment”的部署可以配置为使用 GPT 3.5 Turbo 模型或 GPT 4.0 模型。
要开始使用,请按照以下步骤使用默认设置创建部署:
部署名称:gpt-4o
模型名称:gpt-4o
此 Azure 配置与 Spring Boot Azure AI Starter 及其自动配置功能的默认配置一致。
如果你使用不同的部署名称,请确保相应地更新配置属性:
deploymentOrModelName 的属性。
这是因为在 OpenAI 中没有 Deployment Name,只有 Model Name。
属性
spring.ai.azure.openai.chat.options.model 已重命名为 spring.ai.azure.openai.chat.options.deployment-name。如果你决定通过设置
spring.ai.azure.openai.openai-api-key=<你的 OpenAI 密钥> 属性来连接到 OpenAI 而不是 Azure OpenAI,
那么 spring.ai.azure.openai.chat.options.deployment-name 将被视为 OpenAI 模型名称。访问 OpenAI 模型
你可以将客户端配置为直接使用OpenAI,而不是 Azure OpenAI 部署的模型。
为此,你需要设置 spring.ai.azure.openai.openai-api-key=<你的 OpenAI 密钥> 而不是 spring.ai.azure.openai.api-key=<你的 Azure OpenAi 密钥>。
添加仓库和 BOM
Spring AI 的构件发布在 Maven Central 和 Spring Snapshot 仓库中。 请参阅构件仓库部分,将这些仓库添加到你的构建系统中。 为了帮助进行依赖管理,Spring AI 提供了一个 BOM (bill of materials),以确保在整个项目中使用一致版本的 Spring AI。请参阅依赖管理部分,将 Spring AI BOM 添加到你的构建系统中。自动配置
Spring AI 自动配置、启动器模块的构件名称发生了重大变化。
有关更多信息,请参阅升级说明。
pom.xml 或 Gradle build.gradle 构建文件中:
- Maven
- Gradle
聊天属性
前缀spring.ai.azure.openai 是用于配置与 Azure OpenAI 连接的属性前缀。
聊天自动配置的启用和禁用现在通过前缀为
spring.ai.model.chat 的顶级属性进行配置。要启用,spring.ai.model.chat=azure-openai (默认启用)要禁用,spring.ai.model.chat=none (或任何与 azure-openai 不匹配的值)此更改是为了允许配置多个模型。spring.ai.azure.openai.chat 是配置 Azure OpenAI 的 ChatModel 实现的属性前缀。
运行时选项
AzureOpenAiChatOptions.java 提供模型配置,例如要使用的模型、温度、频率惩罚等。 在启动时,可以使用AzureOpenAiChatModel(api, options) 构造函数或 spring.ai.azure.openai.chat.options.* 属性配置默认选项。
在运行时,你可以通过向 Prompt 调用添加新的、特定于请求的选项来覆盖默认选项。
例如,要为特定请求覆盖默认模型和温度:
函数调用
你可以使用 AzureOpenAiChatModel 注册自定义 Java 函数,并让模型智能地选择输出一个 JSON 对象,其中包含调用一个或多个已注册函数的参数。 这是将 LLM 功能与外部工具和 API 连接起来的强大技术。 阅读有关工具调用的更多信息。多模态
多模态是指模型同时理解和处理来自各种来源的信息的能力,包括文本、图像、音频和其他数据格式。 目前,Azure OpenAIgpt-4o 模型提供多模态支持。
Azure OpenAI 可以将 base64 编码的图像或图像 URL 列表与消息合并。
Spring AI 的 Message 接口通过引入 Media 类型来促进多模态 AI 模型。
此类型包含有关消息中媒体附件的数据和详细信息,利用 Spring 的 org.springframework.util.MimeType 和 java.lang.Object 来获取原始媒体数据。
以下是从 OpenAiChatModelIT.java 中摘录的代码示例,说明了使用 GPT_4_O 模型将用户文本与图像融合。
multimodal.test.png 图像作为输入:

多模态测试图像
示例控制器
创建一个新的 Spring Boot 项目,并将spring-ai-starter-model-azure-openai 添加到你的 pom (或 gradle) 依赖项中。
在 src/main/resources 目录下添加一个 application.properties 文件,以启用和配置 OpenAi 聊天模型:
AzureOpenAiChatModel 实现,你可以将其注入到你的类中。
以下是一个简单的 @Controller 类的示例,该类使用聊天模型进行文本生成:
手动配置
AzureOpenAiChatModel 实现了ChatModel 和 StreamingChatModel,并使用 Azure OpenAI Java 客户端。
要启用它,请将 spring-ai-azure-openai 依赖项添加到项目的 Maven pom.xml 文件中:
build.gradle 构建文件中:
AzureOpenAiChatModel 实例并将其用于生成文本响应:
gpt-4o 实际上是 Azure AI 门户中显示的部署名称。文档有误?请协助编辑
发现文档问题?点击此处直接在 GitHub 上编辑并提交 PR,帮助我们改进文档!