Spring AI

Spring Boot Version Compatibility

Spring AI 2.x.x (main branch) - Spring Boot 4.x

Spring AI 1.1.x (1.1.x branch) - Spring Boot 3.5.x

The Spring AI project provides a Spring-friendly API and abstractions for developing AI applications.

Its goal is to apply to the AI domain Spring ecosystem design principles such as portability and modular design and promote using POJOs as the building blocks of an application to the AI domain.

At its core, Spring AI addresses the fundamental challenge of AI integration: Connecting your enterprise Data and APIs with the AI Models.

The project draws inspiration from notable Python projects, such as LangChain and LlamaIndex, but Spring AI is not a direct port of those projects. The project was founded with the belief that the next wave of Generative AI applications will not be only for Python developers but will be ubiquitous across many programming languages.

You can check out the blog post Why Spring AI for additional motivations.

This is a high level feature overview. You can find more details in the Reference Documentation

• Support for all major AI Model providers such as Anthropic, OpenAI, Microsoft, Amazon, Google, and Ollama. Supported model types include:
• Chat Completion
• Embedding
• Text to Image
• Audio Transcription
• Text to Speech
• Moderation
• Latest Models: GPT-5, and other cutting-edge models for advanced AI applications.
• Portable API support across AI providers for both synchronous and streaming options. Access to model-specific features is also available.
• Structured Outputs - Mapping of AI Model output to POJOs.
• Support for all major Vector Database providers such as Apache Cassandra, Azure Vector Search, Chroma, Elasticsearch, Milvus, MongoDB Atlas, MariaDB, Neo4j, Oracle, PostgreSQL/PGVector, Pinecone, Qdrant, Redis, and Weaviate.
• Portable API across Vector Store providers, including a novel SQL-like metadata filter API.
• Tools/Function Calling - permits the model to request the execution of client-side tools and functions, thereby accessing necessary real-time information as required.
• Observability - Provides insights into AI-related operations.
• Document injection ETL framework for Data Engineering.
• AI Model Evaluation - Utilities to help evaluate generated content and protect against hallucinated response.
• ChatClient API - Fluent API for communicating with AI Chat Models, idiomatically similar to the WebClient and RestClient APIs.
• Advisors API - Encapsulates recurring Generative AI patterns, transforms data sent to and from Language Models (LLMs), and provides portability across various models and use cases.
• Support for Chat Conversation Memory and Retrieval Augmented Generation (RAG).
• Spring Boot Auto Configuration and Starters for all AI Models and Vector Stores - use the start.spring.io to select the Model or Vector-store of choice.

Getting Started

Please refer to the Getting Started Guide for instruction on adding your dependencies.

Project Resources

• Documentation

• Issues

• Awesome Spring AI - A curated list of awesome resources, tools, tutorials, and projects for building generative AI applications using Spring AI

• Spring AI Examples contains example projects that explain specific features in more detail.
• Spring AI Community - A community-driven organization for building Spring-based integrations with AI models, agents, vector databases, and more.

Breaking changes

• Refer to the upgrade notes to see how to upgrade to 1.0.0.M1 or higher.

Cloning the repo

This repository contains large model files. To clone it you have to either:

• Ignore the large files (won't affect the spring-ai behaviour) : GIT_LFS_SKIP_SMUDGE=1 git clone git@github.com:spring-projects/spring-ai.git.
• Or install the Git Large File Storage before cloning the repo.

Building

The project targets and builds artifacts compatible with Java 17+, and requires a JDK with support for the -XDaddTypeAnnotationsToSymbol javac argument, like Liberica 17.0.19+, for nullability checks.

The recommended JDK is specified in the .sdkmanrc file, which can be installed and configured with the SDKMAN! tool: - sdk env install to install the related JDK locally - sdk env to use the related JDK

NOTE: Building Spring AI requires components that depend on your specific CPU architecture (PyTorch for example). MacOS can seamlessly run x86 Java applications on ARM processors using Rosetta, but this will fail when building this project because it tries to download architecture-specific native dependencies. (Note: this is only an issue for building the project, not for consuming the libraries). If you are unsure if you have the correct JDK distribution for your CPU, run the command java -XshowSettings:properties -version 2>&1 | grep os.arch from a fresh terminal to validate that it matches your machine.

To build with running unit tests

./mvnw clean package

To build including integration tests.

./mvnw clean verify -Pintegration-tests

Note that you should set API key environment variables for OpenAI or other model providers before running. If the API key isn't set for a specific model provider, the integration test is skipped.

To run a specific integration test allowing for up to two attempts to succeed. This is useful when a hosted service is not reliable or times out.

./mvnw -pl vector-stores/spring-ai-pgvector-store -am -Pintegration-tests -Dfailsafe.failIfNoSpecifiedTests=false -Dfailsafe.rerunFailingTestsCount=2 -Dit.test=PgVectorStoreIT verify

Integration Tests

There are many integration tests, so it often isn't realistic to run them all at once.

A quick pass through the most important pathways that runs integration tests for

• OpenAI models
• OpenAI autoconfiguration
• PGVector
• Chroma

can be done with the profile -Pci-fast-integration-tests and is used in the main CI build of this project.

A full integration test is done twice a day in the Spring AI Integration Test Repository

One way to run integration tests on part of the code is to first do a quick compile and install of the project

./mvnw clean install -DskipTests -Dmaven.javadoc.skip=true

Then run the integration test for a specific module using the -pl option

./mvnw verify -Pintegration-tests -pl spring-ai-spring-boot-testcontainers

Documentation

To build the docs

./mvnw -pl spring-ai-docs antora

The docs are then in the directory spring-ai-docs/target/antora/site/index.html

Formatting the Source Code

The code is formatted using the java-format plugin as part of the build. Correct formatting is enforced by CI.

Updating License Headers

To update the year on license headers using the license-maven-plugin

./mvnw license:update-file-header -Plicense

Javadocs

To check javadocs using the javadoc:javadoc

./mvnw javadoc:javadoc

Source Code Style

Spring AI source code checkstyle tries to follow the checkstyle guidelines used by the core Spring Framework project with some exceptions. The wiki pages Code Style and IntelliJ IDEA Editor Settings define the source file coding standards we use along with some IDEA editor settings we customize.

Run checkstyle manually:

./mvnw process-sources -P checkstyle-check

Contributing

Your contributions are always welcome! Please read the contribution guidelines first.