merge main into add-huggingface-text-to-image

Author: lobo

.github/workflows/continuous-integration.yml

@@ -25,6 +25,10 @@ jobs:
           distribution: 'temurin'
           cache: 'maven'
 
+      - name: Configure Testcontainers
+        run: |
+          echo "testcontainers.reuse.enable=true" > $HOME/.testcontainers.properties
+
       # - name: Cache Docker images.
       #   uses: ScribeMD/[email protected]
       #   with:
@@ -36,7 +40,10 @@ jobs:
           SPRING_AI_OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
           ARTIFACTORY_USERNAME: ${{ secrets.ARTIFACTORY_USERNAME }}
           ARTIFACTORY_PASSWORD: ${{ secrets.ARTIFACTORY_PASSWORD }}
-        run: mvn -s settings.xml -Pintegration-tests -Pjavadoc -Dfailsafe.rerunFailingTestsCount=3 --batch-mode --update-snapshots deploy
+          OLLAMA_AUTOCONF_TESTS_ENABLED: "true"
+        run: |
+          mvn -s settings.xml -Pintegration-tests -Pjavadoc -Dfailsafe.rerunFailingTestsCount=3 \
+          --batch-mode --update-snapshots deploy
 
       - name: Generate Java docs
         run: mvn javadoc:aggregate
@@ -66,5 +73,40 @@ jobs:
         working-directory: spring-ai-docs/target
         run: |
           unzip spring-ai-$PROJECT_VERSION-docs.zip
-          ssh -i $HOME/.ssh/key $DOCS_USERNAME@$DOCS_HOST "cd $DOCS_PATH && mkdir -p $PROJECT_VERSION/api"
-          scp -i $HOME/.ssh/key -r api $DOCS_USERNAME@$DOCS_HOST:$DOCS_PATH/$PROJECT_VERSION/api
+          ssh -i $HOME/.ssh/key $DOCS_USERNAME@$DOCS_HOST "cd $DOCS_PATH && mkdir -p $PROJECT_VERSION"
+          scp -i $HOME/.ssh/key -r api $DOCS_USERNAME@$DOCS_HOST:$DOCS_PATH/$PROJECT_VERSION
+  
+
+  # The docker-compose and testcontainers modules will be compiled and run in a parallel job
+  container-tests:
+    name: docker-compose and testcontainers modules
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@v4
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+          cache: 'maven'
+
+      - name: Configure Testcontainers
+        run: |
+          echo "testcontainers.reuse.enable=true" > $HOME/.testcontainers.properties
+
+      - name: Build Dependencies
+        run: |
+          mvn -s settings.xml clean install \
+          -DskipTests \
+          -pl spring-ai-spring-boot-docker-compose,spring-ai-spring-boot-testcontainers \
+          -am --batch-mode
+
+      - name: Run docker-compost and testcontainers Integration Tests
+        run: |
+          mvn -s settings.xml -Pintegration-tests verify \
+          -Dskip.docker-compose=false \
+          -Dskip.testcontainers=false \
+          -pl spring-ai-spring-boot-docker-compose,spring-ai-spring-boot-testcontainers \
+          --batch-mode

.github/workflows/documentation-upload.yml

@@ -26,6 +26,9 @@ jobs:
           cache: 'maven'
 
       - name: Generate Java docs
+        run: mvn clean install -DskipTests -Pjavadoc
+
+      - name: Aggregate Java docs
         run: mvn javadoc:aggregate
 
       - name: Generate assembly
@@ -50,6 +53,6 @@ jobs:
         working-directory: spring-ai-docs/target
         run: |
           unzip spring-ai-$RELEASE_VERSION-docs.zip
-          ssh -i $HOME/.ssh/key $DOCS_USERNAME@$DOCS_HOST "cd $DOCS_PATH && mkdir -p $RELEASE_VERSION/api"
+          ssh -i $HOME/.ssh/key $DOCS_USERNAME@$DOCS_HOST "cd $DOCS_PATH && mkdir -p $RELEASE_VERSION"
           scp -i $HOME/.ssh/key -r api $DOCS_USERNAME@$DOCS_HOST:$DOCS_PATH/$RELEASE_VERSION
 

README.md

@@ -35,14 +35,21 @@ You can find more details in the [Reference Documentation](https://docs.spring.i
 * Support for [Chat Conversation Memory](https://docs.spring.io/spring-ai/reference/api/chatclient.html#_chat_memory) and [Retrieval Augmented Generation (RAG)](https://docs.spring.io/spring-ai/reference/api/chatclient.html#_retrieval_augmented_generation).
 * Spring Boot Auto Configuration and Starters for all AI Models and Vector Stores - use the [start.spring.io](https://start.spring.io/) to select the Model or Vector-store of choice. 
 
-## Breaking changes
-
-* Refer to the [upgrade notes](https://docs.spring.io/spring-ai/reference/upgrade-notes.html) to see how to upgrade to 1.0.0.M1 or higher.
-
 ## Getting Started
 
 Please refer to the [Getting Started Guide](https://docs.spring.io/spring-ai/reference/getting-started.html) for instruction on adding your dependencies.
 
+## Project Resources
+
+* [Documentation](https://docs.spring.io/spring-ai/reference/)
+* [Issues](https://github.com/spring-projects/spring-ai/issues)
+<!-- * [Discussions](https://github.com/spring-projects/spring-ai/discussions) - Go here if you have a question, suggestion, or feedback! -->
+* [Awesome Spring AI](https://github.com/danvega/awesome-spring-ai) - A curated list of awesome resources, tools, tutorials, and projects for building generative AI applications using Spring AI
+
+## Breaking changes
+
+* Refer to the [upgrade notes](https://docs.spring.io/spring-ai/reference/upgrade-notes.html) to see how to upgrade to 1.0.0.M1 or higher.
+
 ## Cloning the repo
 
 This repository contains [large model files](https://github.com/spring-projects/spring-ai/tree/main/models/spring-ai-transformers/src/main/resources/onnx/all-MiniLM-L6-v2).
@@ -94,63 +101,11 @@ To check javadocs using the [javadoc:javadoc](https://maven.apache.org/plugins/m
 ./mvnw javadoc:javadoc -Pjavadoc
 ```
 
-## Project Links
-
-* [Documentation](https://docs.spring.io/spring-ai/reference/)
-* [Issues](https://github.com/spring-projects/spring-ai/issues)
-<!-- * [Discussions](https://github.com/spring-projects/spring-ai/discussions) - Go here if you have a question, suggestion, or feedback! -->
-
-
-## Educational Resources
-
-
-### Spring AI blogs:
-- [Leverage the Power of 45k, free, Hugging Face Models with Spring AI and Ollama](https://spring.io/blog/2024/10/22/leverage-the-power-of-45k-free-hugging-face-models-with-spring-ai-and-ollama)
-- [Supercharging Your AI Applications with Spring AI Advisors](https://spring.io/blog/2024/10/02/supercharging-your-ai-applications-with-spring-ai-advisors)
-- [Spring AI with NVIDIA LLM API](https://spring.io/blog/2024/08/20/spring-ai-with-nvidia-llm-api)
-- [Spring AI Embraces OpenAI's Structured Outputs: Enhancing JSON Response Reliability](https://spring.io/blog/2024/08/09/spring-ai-embraces-openais-structured-outputs-enhancing-json-response)
-- [Spring AI with Groq - a blazingly fast AI inference engine](https://spring.io/blog/2024/07/31/spring-ai-with-groq-a-blazingly-fast-ai-inference-engine)
-- [Spring AI with Ollama Tool Support](https://spring.io/blog/2024/07/26/spring-ai-with-ollama-tool-support)
-- [Spring AI - Structured Output](https://spring.io/blog/2024/05/09/spring-ai-structured-output)
-- [Spring AI - Multimodality - Orbis Sensualium Pictus](https://spring.io/blog/2024/04/19/spring-ai-multimodality-orbis-sensualium-pictus)
-- [Function Calling in Java and Spring AI using the latest Mistral AI API](https://spring.io/blog/2024/03/06/function-calling-in-java-and-spring-ai-using-the-latest-mistral-ai-api)
-- [AI Meets Spring Petclinic: Implementing an AI Assistant with Spring AI (Part I)](https://spring.io/blog/2024/09/26/ai-meets-spring-petclinic-implementing-an-ai-assistant-with-spring-ai-part-i)
-- [AI Meets Spring Petclinic: Implementing an AI Assistant with Spring AI (Part II)](https://spring.io/blog/2024/09/27/ai-meets-spring-petclinic-implementing-an-ai-assistant-with-spring-ai-part)
-
-### Code Examples
-
-- [Flight Booking Assistant](https://github.com/tzolov/playground-flight-booking) - Spring AI powered expert system demo
-- [Spring AI Chat Bot CLI](https://github.com/tzolov/spring-ai-cli-chatbot) - chatbot with Retrieval-Augmented Generation (RAG) and conversational memory capabilities
-- [Spring AI Samples (community driven) Thomas Vitale](https://github.com/ThomasVitale/llm-apps-java-spring-ai) - Samples showing how to build Java applications powered by Generative AI and Large Language Models (LLMs)
-- [spring-ai-examples - (community driven) Craig Walls ](https://github.com/habuma/spring-ai-examples)
-
-### Workshops
-
-- [Spring AI Zero to Hero Workshop](https://github.com/asaikali/spring-ai-zero-to-hero) - Example applications showing how to use Spring AI to build Generative AI projects.
-- (outdated) [Workshop material for Azure OpenAI](https://github.com/Azure-Samples/spring-ai-azure-workshop) - contains step-by-step examples from 'hello world' to 'retrieval augmented generation'
-
-### Talks and Videos 
-
-Some selected videos.  Search YouTube! for more.
-
-- Spring AI: Seamlessly Integrating AI into Your Enterprise Java Applications (2024 - Devoxx.be)
-<br>[![Spring AI: Seamlessly Integrating AI into Your Enterprise Java Applications](https://img.youtube.com/vi/kfRyY0wsZHM/default.jpg)](https://youtu.be/kfRyY0wsZHM?si=qzIshk0GJqVTyrNm)
-
-- Spring AI Is All You Need (2024 - GOTO Amsterdam)
-<br>[![Watch Spring Tips video](https://img.youtube.com/vi/vuhMti8B5H0/default.jpg)](https://youtu.be/vuhMti8B5H0?si=qhRVLh4-EaUhm9oe)
-
-- Introducing Spring AI (2024 - Spring.IO)
-<br>[![Introducing Spring AI](https://img.youtube.com/vi/umKbaXsiCOY/default.jpg)](https://youtu.be/umKbaXsiCOY?si=FbqCtLIOgbihm6b6)
+To build with checkstyles enabled.
+Checkstyles are currently disabled, but you can enable them by doing the following:
+```shell
+./mvnw clean package -DskipTests -Ddisable.checks=false
+```
 
-- Spring AI at Spring.IO Keynotes (2024 - Spring.IO)
-<br>[![Watch](https://img.youtube.com/vi/XUz4LKZx83g/default.jpg)](https://youtu.be/XUz4LKZx83g?t=2940)
 
-- Spring Tips: Spring AI
-<br>[![Watch Spring Tips video](https://img.youtube.com/vi/aNKDoiOUo9M/default.jpg)](https://www.youtube.com/watch?v=aNKDoiOUo9M)
-* Overview of Spring AI @ Devoxx 2023
-<br>[![Watch the Devoxx 2023 video](https://img.youtube.com/vi/7OY9fKVxAFQ/default.jpg)](https://www.youtube.com/watch?v=7OY9fKVxAFQ)
-* Introducing Spring AI - Add Generative AI to your Spring Applications
-<br>[![Watch the video](https://img.youtube.com/vi/1g_wuincUdU/default.jpg)](https://www.youtube.com/watch?v=1g_wuincUdU)
 
-- Spring AI Introduction: Building AI Applications in Java with Spring
-<br>[![Watch the video](https://img.youtube.com/vi/yyvjT0v3lpY/default.jpg)](https://www.youtube.com/watch?v=yyvjT0v3lpY&ab_channel=DanVega)

document-readers/markdown-reader/pom.xml

@@ -41,7 +41,7 @@
 		<dependency>
 			<groupId>org.springframework.ai</groupId>
 			<artifactId>spring-ai-core</artifactId>
-			<version>${parent.version}</version>
+			<version>${project.parent.version}</version>
 		</dependency>
 
 		<dependency>

document-readers/markdown-reader/src/main/java/org/springframework/ai/reader/markdown/MarkdownDocumentReader.java

@@ -65,14 +65,27 @@ public class MarkdownDocumentReader implements DocumentReader {
 	 */
 	private final Parser parser;
 
+	/**
+	 * Create a new {@link MarkdownDocumentReader} instance.
+	 * @param markdownResource the resource to read
+	 */
 	public MarkdownDocumentReader(String markdownResource) {
 		this(new DefaultResourceLoader().getResource(markdownResource), MarkdownDocumentReaderConfig.defaultConfig());
 	}
 
+	/**
+	 * Create a new {@link MarkdownDocumentReader} instance.
+	 * @param markdownResource the resource to read
+	 * @param config the configuration to use
+	 */
 	public MarkdownDocumentReader(String markdownResource, MarkdownDocumentReaderConfig config) {
 		this(new DefaultResourceLoader().getResource(markdownResource), config);
 	}
 
+	/**
+	 * Create a new {@link MarkdownDocumentReader} instance.
+	 * @param markdownResource the resource to read
+	 */
 	public MarkdownDocumentReader(Resource markdownResource, MarkdownDocumentReaderConfig config) {
 		this.markdownResource = markdownResource;
 		this.config = config;
@@ -111,10 +124,13 @@ static class DocumentVisitor extends AbstractVisitor {
 
 		private Document.Builder currentDocumentBuilder;
 
-		public DocumentVisitor(MarkdownDocumentReaderConfig config) {
+		DocumentVisitor(MarkdownDocumentReaderConfig config) {
 			this.config = config;
 		}
 
+		/**
+		 * Visits the document node and initializes the current document builder.
+		 */
 		@Override
 		public void visit(org.commonmark.node.Document document) {
 			this.currentDocumentBuilder = Document.builder();

document-readers/markdown-reader/src/main/java/org/springframework/ai/reader/markdown/config/MarkdownDocumentReaderConfig.java

@@ -56,7 +56,7 @@ public static Builder builder() {
 		return new Builder();
 	}
 
-	public static class Builder {
+	public static final class Builder {
 
 		private boolean horizontalRuleCreateDocument = false;
 

document-readers/pdf-reader/pom.xml

@@ -36,11 +36,14 @@
 		<developerConnection>[email protected]:spring-projects/spring-ai.git</developerConnection>
 	</scm>
 
+	<properties>
+	</properties>
+
 	<dependencies>
 		<dependency>
 			<groupId>org.springframework.ai</groupId>
 			<artifactId>spring-ai-core</artifactId>
-			<version>${parent.version}</version>
+			<version>${project.parent.version}</version>
 		</dependency>
 
 		<dependency>

document-readers/pdf-reader/src/main/java/org/springframework/ai/reader/pdf/PagePdfDocumentReader.java

@@ -16,7 +16,7 @@
 
 package org.springframework.ai.reader.pdf;
 
-import java.awt.*;
+import java.awt.Rectangle;
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.List;
@@ -112,7 +112,7 @@ public List<Document> get() {
 			for (PDPage page : this.document.getDocumentCatalog().getPages()) {
 				lastPage = page;
 				if (counter % logFrequency == 0 && counter / logFrequency < 10) {
-					this.logger.info("Processing PDF page: {}", (counter + 1));
+					logger.info("Processing PDF page: {}", (counter + 1));
 				}
 				counter++;
 
@@ -154,7 +154,7 @@ public List<Document> get() {
 				readDocuments.add(toDocument(lastPage, pageTextGroupList.stream().collect(Collectors.joining()),
 						startPageNumber, pageNumber));
 			}
-			this.logger.info("Processing {} pages", totalPages);
+			logger.info("Processing {} pages", totalPages);
 			return readDocuments;
 
 		}

document-readers/pdf-reader/src/main/java/org/springframework/ai/reader/pdf/ParagraphPdfDocumentReader.java

@@ -16,7 +16,7 @@
 
 package org.springframework.ai.reader.pdf;
 
-import java.awt.*;
+import java.awt.Rectangle;
 import java.util.ArrayList;
 import java.util.Iterator;
 import java.util.List;
@@ -133,7 +133,7 @@ public List<Document> get() {
 		List<Document> documents = new ArrayList<>(paragraphs.size());
 
 		if (!CollectionUtils.isEmpty(paragraphs)) {
-			this.logger.info("Start processing paragraphs from PDF");
+			logger.info("Start processing paragraphs from PDF");
 			Iterator<Paragraph> itr = paragraphs.iterator();
 
 			var current = itr.next();
@@ -152,7 +152,7 @@ public List<Document> get() {
 				}
 			}
 		}
-		this.logger.info("End processing paragraphs from PDF");
+		logger.info("End processing paragraphs from PDF");
 		return documents;
 	}
 

document-readers/pdf-reader/src/main/java/org/springframework/ai/reader/pdf/aot/PdfReaderRuntimeHints.java

@@ -22,6 +22,7 @@
 import org.springframework.aot.hint.RuntimeHints;
 import org.springframework.aot.hint.RuntimeHintsRegistrar;
 import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
+import org.springframework.lang.NonNull;
 
 /**
  * The PdfReaderRuntimeHints class is responsible for registering runtime hints for PDFBox
@@ -34,7 +35,7 @@
 public class PdfReaderRuntimeHints implements RuntimeHintsRegistrar {
 
 	@Override
-	public void registerHints(RuntimeHints hints, ClassLoader classLoader) {
+	public void registerHints(@NonNull RuntimeHints hints, ClassLoader classLoader) {
 		try {
 
 			var resolver = new PathMatchingResourcePatternResolver();
@@ -45,9 +46,11 @@ public void registerHints(RuntimeHints hints, ClassLoader classLoader) {
 					"/org/apache/pdfbox/resources/icc/**", "/org/apache/pdfbox/resources/text/**",
 					"/org/apache/pdfbox/resources/ttf/**", "/org/apache/pdfbox/resources/version.properties");
 
-			for (var pattern : patterns)
-				for (var resourceMatch : resolver.getResources(pattern))
+			for (var pattern : patterns) {
+				for (var resourceMatch : resolver.getResources(pattern)) {
 					hints.resources().registerResource(resourceMatch);
+				}
+			}
 
 		}
 		catch (IOException e) {

document-readers/pdf-reader/src/main/java/org/springframework/ai/reader/pdf/config/ParagraphManager.java

@@ -184,6 +184,7 @@ else if (paragraph.level() == level) {
 	 * @param level The TOC deepness level for this paragraph. The root is at level 0.
 	 * @param startPageNumber The page number in the PDF where this paragraph begins.
 	 * @param endPageNumber The page number in the PDF where this paragraph ends.
+	 * @param position The vertical position of the paragraph on the page.
 	 * @param children Sub-paragraphs for this paragraph.
 	 */
 	public record Paragraph(Paragraph parent, String title, int level, int startPageNumber, int endPageNumber,

document-readers/pdf-reader/src/main/java/org/springframework/ai/reader/pdf/config/PdfDocumentReaderConfig.java

@@ -27,7 +27,7 @@
  *
  * @author Christian Tzolov
  */
-public class PdfDocumentReaderConfig {
+public final class PdfDocumentReaderConfig {
 
 	public static final int ALL_PAGES = 0;
 
@@ -65,7 +65,7 @@ public static PdfDocumentReaderConfig defaultConfig() {
 		return builder().build();
 	}
 
-	public static class Builder {
+	public static final class Builder {
 
 		private int pagesPerDocument = 1;