快速开始

本节为如何开始使用 Spring AI 提供了入门指引。

请根据自身需求，依次参考以下各小节的步骤。

注意：Spring AI 支持 Spring Boot 3.4.x。当 Spring Boot 3.5.x 发布后，我们也会提供支持。

Spring Initializr

请访问 start.spring.io，选择你希望在新应用中使用的 AI 模型和向量存储。

构件仓库

里程碑版本 - 使用 Maven Central

自 1.0.0-M6 起，发布版本已可在 Maven Central 获取。 无需对你的构建文件做任何更改。

快照版本 - 添加快照仓库

如需使用快照版（以及 1.0.0-M6 之前的里程碑版），需在构建文件中添加如下快照仓库。

将以下仓库定义添加到你的 Maven 或 Gradle 构建文件：

  • Maven

  • Gradle

<repositories>
  <repository>
    <id>spring-snapshots</id>
    <name>Spring Snapshots</name>
    <url>https://repo.spring.io/snapshot</url>
    <releases>
      <enabled>false</enabled>
    </releases>
  </repository>
  <repository>
    <name>Central Portal Snapshots</name>
    <id>central-portal-snapshots</id>
    <url>https://central.sonatype.com/repository/maven-snapshots/</url>
    <releases>
      <enabled>false</enabled>
    </releases>
    <snapshots>
      <enabled>true</enabled>
    </snapshots>
  </repository>
</repositories>
repositories {
  mavenCentral()
  maven { url 'https://repo.spring.io/milestone' }
  maven { url 'https://repo.spring.io/snapshot' }
  maven {
    name = 'Central Portal Snapshots'
    url = 'https://central.sonatype.com/repository/maven-snapshots/'
  }
}

注意： 使用 Maven 配置 Spring AI 快照仓库时，请注意你的 Maven 镜像配置。如果你在 settings.xml 中配置了如下镜像：

<mirror>
    <id>my-mirror</id>
    <mirrorOf>*</mirrorOf>
    <url>https://my-company-repository.com/maven</url>
</mirror>

通配符 * 会将所有仓库请求重定向到你的镜像，导致无法访问 Spring 快照仓库。为解决此问题，请将 mirrorOf 配置修改为排除 Spring 仓库：

<mirror>
    <id>my-mirror</id>
    <mirrorOf>*,!spring-snapshots,!central-portal-snapshots</mirrorOf>
    <url>https://my-company-repository.com/maven</url>
</mirror>

此配置允许 Maven 直接访问 Spring 快照仓库，同时其他依赖仍通过你的镜像获取。

依赖管理

Spring AI 物料清单（BOM）声明了当前版本 Spring AI 所用全部依赖的推荐版本。 该 BOM 仅用于依赖管理，不包含插件声明，也不直接引用 Spring 或 Spring Boot。 你可以使用 Spring Boot 父 POM，或通过 Spring Boot 的 BOM（spring-boot-dependencies）来管理 Spring Boot 版本。

将 BOM 添加到你的项目中：

  • Maven

  • Gradle

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.ai</groupId>
            <artifactId>spring-ai-bom</artifactId>
            <version>1.0.0-SNAPSHOT</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>
dependencies {
  implementation platform("org.springframework.ai:spring-ai-bom:1.0.0-SNAPSHOT")
  // 替换为你需要使用的具体模块的 starter 依赖
  implementation 'org.springframework.ai:spring-ai-openai'
}

Gradle 用户也可通过 Gradle（5.0+）原生支持的 Maven BOM 依赖约束方式使用 Spring AI BOM。只需在 Gradle 构建脚本的 dependencies 部分添加 'platform' 依赖处理方法即可。

为特定组件添加依赖

文档后续各节会说明你需要为项目构建系统添加哪些依赖。

Spring AI 示例

更多 Spring AI 相关资源与示例，请参考 此页面。