前提条件
你需要在 Anthropic 门户上创建一个 API 密钥。 在 Anthropic API 仪表板创建一个帐户,并在获取 API 密钥页面生成 API 密钥。 Spring AI 项目定义了一个名为spring.ai.anthropic.api-key 的配置属性,你应该将其设置为从 anthropic.com 获取的 API 密钥 的值。
你可以在 application.properties 文件中设置此配置属性:
- application.yml
- .env
添加仓库和 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.retry 用作属性前缀,允许你配置 Anthropic 聊天模型的重试机制。
目前,重试策略不适用于流式 API。
连接属性
前缀spring.ai.anthropic 用作属性前缀,允许你连接到 Anthropic。
配置属性
聊天自动配置的启用和禁用现在通过前缀为
spring.ai.model.chat 的顶级属性进行配置。要启用,spring.ai.model.chat=anthropic (默认启用)要禁用,spring.ai.model.chat=none (或任何与 anthropic 不匹配的值)此更改是为了允许配置多个模型。spring.ai.anthropic.chat 是属性前缀,允许你配置 Anthropic 的聊天模型实现。
运行时选项
AnthropicChatOptions.java 提供模型配置,例如要使用的模型、温度、最大令牌数等。 在启动时,可以使用AnthropicChatModel(api, options) 构造函数或 spring.ai.anthropic.chat.options.* 属性配置默认选项。
在运行时,你可以通过向 Prompt 调用添加新的、特定于请求的选项来覆盖默认选项。
例如,要为特定请求覆盖默认模型和温度:
工具/函数调用
你可以使用AnthropicChatModel 注册自定义 Java 工具,并让 Anthropic Claude 模型智能地选择输出一个 JSON 对象,其中包含调用一个或多个已注册函数的参数。
这是将 LLM 功能与外部工具和 API 连接起来的强大技术。
阅读有关工具调用的更多信息。
多模态
多模态是指模型同时理解和处理来自各种来源的信息的能力,包括文本、pdf、图像、数据格式。图像
目前,Anthropic Claude 3 支持base64 源类型的 图像,以及 image/jpeg、image/png、image/gif 和 image/webp 媒体类型。
有关更多信息,请查看视觉指南。
Anthropic Claude 3.5 Sonnet 还支持 application/pdf 文件的 pdf 源类型。
Spring AI 的 Message 接口通过引入 Media 类型来支持多模态 AI 模型。
此类型包含有关消息中媒体附件的数据和信息,使用 Spring 的 org.springframework.util.MimeType 和 java.lang.Object 来获取原始媒体数据。
以下是从 AnthropicChatModelIT.java 中提取的简单代码示例,演示了用户文本与图像的组合。
multimodal.test.png 图像作为输入:

多模态测试图像
application/pdf 媒体类型将 PDF 文件附加到消息:
示例控制器
创建一个新的 Spring Boot 项目,并将spring-ai-starter-model-anthropic 添加到你的 pom (或 gradle) 依赖项中。
在 src/main/resources 目录下添加一个 application.properties 文件,以启用和配置 Anthropic 聊天模型:
AnthropicChatModel 实现,你可以将其注入到你的类中。
以下是一个简单的 @Controller 类的示例,该类使用聊天模型进行文本生成。
手动配置
AnthropicChatModel 实现了ChatModel 和 StreamingChatModel,并使用低级 AnthropicApi 客户端连接到 Anthropic 服务。
将 spring-ai-anthropic 依赖项添加到项目的 Maven pom.xml 文件中:
build.gradle 构建文件中。
AnthropicChatModel 并将其用于文本生成:
AnthropicChatOptions 为聊天请求提供配置信息。
AnthropicChatOptions.Builder 是流畅的选项构建器。
低级 AnthropicApi 客户端
AnthropicApi 提供了轻量级的 Java 客户端,用于 Anthropic 消息 API。 以下类图说明了AnthropicApi 聊天接口和构建块:

AnthropicApi 聊天 API 图

AnthropicApi 事件模型
低级 API 示例
- AnthropicApiIT.java 测试提供了一些有关如何使用轻量级库的常规示例。
文档有误?请协助编辑
发现文档问题?点击此处直接在 GitHub 上编辑并提交 PR,帮助我们改进文档!