Merge branch 'spring-projects:main' into main

Author: bruno-oliveira

.github/workflows/source-code-format-check.yml renamed to .github/workflows/pr-check.yml

@@ -1,4 +1,4 @@
-name: Source Code Format
+name: PR Check
 
 on:
   pull_request:
@@ -20,6 +20,6 @@ jobs:
           distribution: 'temurin'
           cache: 'maven'
 
-      - name: Source code formatting check
+      - name: Run tests
         run: |
-          ./mvnw spring-javaformat:validate
+          ./mvnw test

README.md

@@ -46,6 +46,7 @@ Please refer to the [Getting Started Guide](https://docs.spring.io/spring-ai/ref
 * [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
+* [Spring AI Examples](https://github.com/spring-projects/spring-ai-examples) contains example projects that explain specific features in more detail.
 
 ## Breaking changes
 
@@ -133,7 +134,4 @@ 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
-```
-
-
-
+```

document-readers/markdown-reader/src/test/java/org/springframework/ai/reader/markdown/MarkdownDocumentReaderTest.java

@@ -39,7 +39,7 @@ void testOnlyHeadersWithParagraphs() {
 		List<Document> documents = reader.get();
 
 		assertThat(documents).hasSize(4)
-			.extracting(Document::getMetadata, Document::getContent)
+			.extracting(Document::getMetadata, Document::getText)
 			.containsOnly(tuple(Map.of("category", "header_1", "title", "Header 1a"),
 					"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur diam eros, laoreet sit amet cursus vitae, varius sed nisi. Cras sit amet quam quis velit commodo porta consectetur id nisi. Phasellus tincidunt pulvinar augue."),
 					tuple(Map.of("category", "header_1", "title", "Header 1b"),
@@ -57,7 +57,7 @@ void testWithFormatting() {
 		List<Document> documents = reader.get();
 
 		assertThat(documents).hasSize(2)
-			.extracting(Document::getMetadata, Document::getContent)
+			.extracting(Document::getMetadata, Document::getText)
 			.containsOnly(tuple(Map.of("category", "header_1", "title", "This is a fancy header name"),
 					"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec tincidunt velit non bibendum gravida. Cras accumsan tincidunt ornare. Donec hendrerit consequat tellus blandit accumsan. Aenean aliquam metus at arcu elementum dignissim."),
 					tuple(Map.of("category", "header_3", "title", "Header 3"),
@@ -75,7 +75,7 @@ void testDocumentDividedViaHorizontalRules() {
 		List<Document> documents = reader.get();
 
 		assertThat(documents).hasSize(7)
-			.extracting(Document::getMetadata, Document::getContent)
+			.extracting(Document::getMetadata, Document::getText)
 			.containsOnly(tuple(Map.of(),
 					"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec tincidunt velit non bibendum gravida."),
 					tuple(Map.of(),
@@ -105,7 +105,7 @@ void testDocumentNotDividedViaHorizontalRulesWhenIsDisabled() {
 
 		Document documentsFirst = documents.get(0);
 		assertThat(documentsFirst.getMetadata()).isEmpty();
-		assertThat(documentsFirst.getContent()).startsWith("Lorem ipsum dolor sit amet, consectetur adipiscing elit")
+		assertThat(documentsFirst.getText()).startsWith("Lorem ipsum dolor sit amet, consectetur adipiscing elit")
 			.endsWith("Phasellus eget tellus sed nibh ornare interdum eu eu mi.");
 	}
 
@@ -119,7 +119,7 @@ void testSimpleMarkdownDocumentWithHardAndSoftLineBreaks() {
 
 		Document documentsFirst = documents.get(0);
 		assertThat(documentsFirst.getMetadata()).isEmpty();
-		assertThat(documentsFirst.getContent()).isEqualTo(
+		assertThat(documentsFirst.getText()).isEqualTo(
 				"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec tincidunt velit non bibendum gravida. Cras accumsan tincidunt ornare. Donec hendrerit consequat tellus blandit accumsan. Aenean aliquam metus at arcu elementum dignissim.Nullam nisi dui, egestas nec sem nec, interdum lobortis enim. Pellentesque odio orci, faucibus eu luctus nec, venenatis et magna. Vestibulum nec eros non felis fermentum posuere eget ac risus.Aenean eu leo eu nibh tristique posuere quis quis massa. Nullam lacinia luctus sem ut vehicula.");
 	}
 
@@ -135,22 +135,22 @@ void testCode() {
 
 		assertThat(documents).satisfiesExactly(document -> {
 			assertThat(document.getMetadata()).isEqualTo(Map.of());
-			assertThat(document.getContent()).isEqualTo("This is a Java sample application:");
+			assertThat(document.getText()).isEqualTo("This is a Java sample application:");
 		}, document -> {
 			assertThat(document.getMetadata()).isEqualTo(Map.of("lang", "java", "category", "code_block"));
-			assertThat(document.getContent()).startsWith("package com.example.demo;")
+			assertThat(document.getText()).startsWith("package com.example.demo;")
 				.contains("SpringApplication.run(DemoApplication.class, args);");
 		}, document -> {
 			assertThat(document.getMetadata()).isEqualTo(Map.of("category", "code_inline"));
-			assertThat(document.getContent()).isEqualTo(
+			assertThat(document.getText()).isEqualTo(
 					"Markdown also provides the possibility to use inline code formatting throughout the entire sentence.");
 		}, document -> {
 			assertThat(document.getMetadata()).isEqualTo(Map.of());
-			assertThat(document.getContent())
+			assertThat(document.getText())
 				.isEqualTo("Another possibility is to set block code without specific highlighting:");
 		}, document -> {
 			assertThat(document.getMetadata()).isEqualTo(Map.of("lang", "", "category", "code_block"));
-			assertThat(document.getContent()).isEqualTo("./mvnw spring-javaformat:apply\n");
+			assertThat(document.getText()).isEqualTo("./mvnw spring-javaformat:apply\n");
 		});
 	}
 
@@ -167,15 +167,15 @@ void testCodeWhenCodeBlockShouldNotBeSeparatedDocument() {
 
 		assertThat(documents).satisfiesExactly(document -> {
 			assertThat(document.getMetadata()).isEqualTo(Map.of("lang", "java", "category", "code_block"));
-			assertThat(document.getContent()).startsWith("This is a Java sample application: package com.example.demo")
+			assertThat(document.getText()).startsWith("This is a Java sample application: package com.example.demo")
 				.contains("SpringApplication.run(DemoApplication.class, args);");
 		}, document -> {
 			assertThat(document.getMetadata()).isEqualTo(Map.of("category", "code_inline"));
-			assertThat(document.getContent()).isEqualTo(
+			assertThat(document.getText()).isEqualTo(
 					"Markdown also provides the possibility to use inline code formatting throughout the entire sentence.");
 		}, document -> {
 			assertThat(document.getMetadata()).isEqualTo(Map.of("lang", "", "category", "code_block"));
-			assertThat(document.getContent()).isEqualTo(
+			assertThat(document.getText()).isEqualTo(
 					"Another possibility is to set block code without specific highlighting: ./mvnw spring-javaformat:apply\n");
 		});
 	}
@@ -187,7 +187,7 @@ void testBlockquote() {
 		List<Document> documents = reader.get();
 
 		assertThat(documents).hasSize(2)
-			.extracting(Document::getMetadata, Document::getContent)
+			.extracting(Document::getMetadata, Document::getText)
 			.containsOnly(tuple(Map.of(),
 					"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur diam eros, laoreet sit amet cursus vitae, varius sed nisi. Cras sit amet quam quis velit commodo porta consectetur id nisi. Phasellus tincidunt pulvinar augue."),
 					tuple(Map.of("category", "blockquote"),
@@ -208,7 +208,7 @@ void testBlockquoteWhenBlockquoteShouldNotBeSeparatedDocument() {
 
 		Document documentsFirst = documents.get(0);
 		assertThat(documentsFirst.getMetadata()).isEqualTo(Map.of("category", "blockquote"));
-		assertThat(documentsFirst.getContent()).isEqualTo(
+		assertThat(documentsFirst.getText()).isEqualTo(
 				"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur diam eros, laoreet sit amet cursus vitae, varius sed nisi. Cras sit amet quam quis velit commodo porta consectetur id nisi. Phasellus tincidunt pulvinar augue. Proin vel laoreet leo, sed luctus augue. Sed et ligula commodo, commodo lacus at, consequat turpis. Maecenas eget sapien odio. Maecenas urna lectus, pellentesque in accumsan aliquam, congue eu libero. Ut rhoncus nec justo a porttitor. Pellentesque auctor pharetra eros, viverra sodales lorem aliquet id. Curabitur semper nisi vel sem interdum suscipit.");
 	}
 
@@ -219,7 +219,7 @@ void testLists() {
 		List<Document> documents = reader.get();
 
 		assertThat(documents).hasSize(2)
-			.extracting(Document::getMetadata, Document::getContent)
+			.extracting(Document::getMetadata, Document::getText)
 			.containsOnly(tuple(Map.of("category", "header_2", "title", "Ordered list"),
 					"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur diam eros, laoreet sit amet cursus vitae, varius sed nisi. Cras sit amet quam quis velit commodo porta consectetur id nisi. Phasellus tincidunt pulvinar augue. Proin vel laoreet leo, sed luctus augue. Sed et ligula commodo, commodo lacus at, consequat turpis. Maecenas eget sapien odio. Pellentesque auctor pharetra eros, viverra sodales lorem aliquet id. Curabitur semper nisi vel sem interdum suscipit. Maecenas urna lectus, pellentesque in accumsan aliquam, congue eu libero. Ut rhoncus nec justo a porttitor."),
 					tuple(Map.of("category", "header_2", "title", "Unordered list"),
@@ -241,7 +241,7 @@ void testWithAdditionalMetadata() {
 
 		Document documentsFirst = documents.get(0);
 		assertThat(documentsFirst.getMetadata()).isEqualTo(Map.of("service", "some-service-name", "env", "prod"));
-		assertThat(documentsFirst.getContent()).startsWith("Lorem ipsum dolor sit amet, consectetur adipiscing elit.");
+		assertThat(documentsFirst.getText()).startsWith("Lorem ipsum dolor sit amet, consectetur adipiscing elit.");
 	}
 
 }

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

@@ -145,7 +145,7 @@ public List<Document> get() {
 				while (itr.hasNext()) {
 					var next = itr.next();
 					Document document = toDocument(current, next);
-					if (document != null && StringUtils.hasText(document.getContent())) {
+					if (document != null && StringUtils.hasText(document.getText())) {
 						documents.add(toDocument(current, next));
 					}
 					current = next;

document-readers/pdf-reader/src/test/java/org/springframework/ai/reader/pdf/PagePdfDocumentReaderTests.java

@@ -44,6 +44,7 @@ void classpathRead() {
 						.withNumberOfTopTextLinesToDelete(0)
 						.withNumberOfBottomTextLinesToDelete(3)
 						.withNumberOfTopPagesToSkipBeforeDelete(0)
+						.overrideLineSeparator("\n")
 						.build())
 					.withPagesPerDocument(1)
 					.build());
@@ -52,7 +53,7 @@ void classpathRead() {
 
 		assertThat(docs).hasSize(4);
 
-		String allText = docs.stream().map(Document::getContent).collect(Collectors.joining(System.lineSeparator()));
+		String allText = docs.stream().map(Document::getText).collect(Collectors.joining(System.lineSeparator()));
 
 		assertThat(allText).doesNotContain(
 				List.of("Page  1 of 4", "Page  2 of 4", "Page  3 of 4", "Page  4 of 4", "PDF  Bookmark   Sample"));

document-readers/tika-reader/src/test/java/org/springframework/ai/reader/tika/TikaDocumentReaderTests.java

@@ -43,7 +43,7 @@ public void testDocx(String resourceUri, String resourceName, String contentSnip
 
 		assertThat(doc.getMetadata()).containsKeys(TikaDocumentReader.METADATA_SOURCE);
 		assertThat(doc.getMetadata().get(TikaDocumentReader.METADATA_SOURCE)).isEqualTo(resourceName);
-		assertThat(doc.getContent()).contains(contentSnipped);
+		assertThat(doc.getText()).contains(contentSnipped);
 	}
 
 }

models/spring-ai-anthropic/src/main/java/org/springframework/ai/anthropic/AnthropicChatModel.java

@@ -47,6 +47,9 @@
 import org.springframework.ai.chat.messages.UserMessage;
 import org.springframework.ai.chat.metadata.ChatGenerationMetadata;
 import org.springframework.ai.chat.metadata.ChatResponseMetadata;
+import org.springframework.ai.chat.metadata.EmptyUsage;
+import org.springframework.ai.chat.metadata.Usage;
+import org.springframework.ai.chat.metadata.UsageUtils;
 import org.springframework.ai.chat.model.AbstractToolCallSupport;
 import org.springframework.ai.chat.model.ChatModel;
 import org.springframework.ai.chat.model.ChatResponse;
@@ -78,6 +81,7 @@
  * @author Mariusz Bernacki
  * @author Thomas Vitale
  * @author Claudio Silva Junior
+ * @author Alexandros Pappas
  * @since 1.0.0
  */
 public class AnthropicChatModel extends AbstractToolCallSupport implements ChatModel {
@@ -124,9 +128,9 @@ public class AnthropicChatModel extends AbstractToolCallSupport implements ChatM
 	public AnthropicChatModel(AnthropicApi anthropicApi) {
 		this(anthropicApi,
 				AnthropicChatOptions.builder()
-					.withModel(DEFAULT_MODEL_NAME)
-					.withMaxTokens(DEFAULT_MAX_TOKENS)
-					.withTemperature(DEFAULT_TEMPERATURE)
+					.model(DEFAULT_MODEL_NAME)
+					.maxTokens(DEFAULT_MAX_TOKENS)
+					.temperature(DEFAULT_TEMPERATURE)
 					.build());
 	}
 
@@ -210,6 +214,10 @@ public AnthropicChatModel(AnthropicApi anthropicApi, AnthropicChatOptions defaul
 
 	@Override
 	public ChatResponse call(Prompt prompt) {
+		return this.internalCall(prompt, null);
+	}
+
+	public ChatResponse internalCall(Prompt prompt, ChatResponse previousChatResponse) {
 		ChatCompletionRequest request = createRequest(prompt, false);
 
 		ChatModelObservationContext observationContext = ChatModelObservationContext.builder()
@@ -226,8 +234,14 @@ public ChatResponse call(Prompt prompt) {
 				ResponseEntity<ChatCompletionResponse> completionEntity = this.retryTemplate
 					.execute(ctx -> this.anthropicApi.chatCompletionEntity(request));
 
-				ChatResponse chatResponse = toChatResponse(completionEntity.getBody());
+				AnthropicApi.ChatCompletionResponse completionResponse = completionEntity.getBody();
+				AnthropicApi.Usage usage = completionResponse.usage();
 
+				Usage currentChatResponseUsage = usage != null ? AnthropicUsage.from(completionResponse.usage())
+						: new EmptyUsage();
+				Usage accumulatedUsage = UsageUtils.getCumulativeUsage(currentChatResponseUsage, previousChatResponse);
+
+				ChatResponse chatResponse = toChatResponse(completionEntity.getBody(), accumulatedUsage);
 				observationContext.setResponse(chatResponse);
 
 				return chatResponse;
@@ -236,14 +250,18 @@ public ChatResponse call(Prompt prompt) {
 		if (!isProxyToolCalls(prompt, this.defaultOptions) && response != null
 				&& this.isToolCall(response, Set.of("tool_use"))) {
 			var toolCallConversation = handleToolCalls(prompt, response);
-			return this.call(new Prompt(toolCallConversation, prompt.getOptions()));
+			return this.internalCall(new Prompt(toolCallConversation, prompt.getOptions()), response);
 		}
 
 		return response;
 	}
 
 	@Override
 	public Flux<ChatResponse> stream(Prompt prompt) {
+		return this.internalStream(prompt, null);
+	}
+
+	public Flux<ChatResponse> internalStream(Prompt prompt, ChatResponse previousChatResponse) {
 		return Flux.deferContextual(contextView -> {
 			ChatCompletionRequest request = createRequest(prompt, true);
 
@@ -263,11 +281,14 @@ public Flux<ChatResponse> stream(Prompt prompt) {
 
 			// @formatter:off
 			Flux<ChatResponse> chatResponseFlux = response.switchMap(chatCompletionResponse -> {
-				ChatResponse chatResponse = toChatResponse(chatCompletionResponse);
+				AnthropicApi.Usage usage = chatCompletionResponse.usage();
+				Usage currentChatResponseUsage = usage != null ? AnthropicUsage.from(chatCompletionResponse.usage()) : new EmptyUsage();
+				Usage accumulatedUsage = UsageUtils.getCumulativeUsage(currentChatResponseUsage, previousChatResponse);
+				ChatResponse chatResponse = toChatResponse(chatCompletionResponse, accumulatedUsage);
 
 				if (!isProxyToolCalls(prompt, this.defaultOptions) && this.isToolCall(chatResponse, Set.of("tool_use"))) {
 					var toolCallConversation = handleToolCalls(prompt, chatResponse);
-					return this.stream(new Prompt(toolCallConversation, prompt.getOptions()));
+					return this.internalStream(new Prompt(toolCallConversation, prompt.getOptions()), chatResponse);
 				}
 
 				return Mono.just(chatResponse);
@@ -281,7 +302,7 @@ public Flux<ChatResponse> stream(Prompt prompt) {
 		});
 	}
 
-	private ChatResponse toChatResponse(ChatCompletionResponse chatCompletion) {
+	private ChatResponse toChatResponse(ChatCompletionResponse chatCompletion, Usage usage) {
 
 		if (chatCompletion == null) {
 			logger.warn("Null chat completion returned");
@@ -327,19 +348,22 @@ private ChatResponse toChatResponse(ChatCompletionResponse chatCompletion) {
 			allGenerations.add(toolCallGeneration);
 		}
 
-		return new ChatResponse(allGenerations, this.from(chatCompletion));
+		return new ChatResponse(allGenerations, this.from(chatCompletion, usage));
 	}
 
 	private ChatResponseMetadata from(AnthropicApi.ChatCompletionResponse result) {
+		return from(result, AnthropicUsage.from(result.usage()));
+	}
+
+	private ChatResponseMetadata from(AnthropicApi.ChatCompletionResponse result, Usage usage) {
 		Assert.notNull(result, "Anthropic ChatCompletionResult must not be null");
-		AnthropicUsage usage = AnthropicUsage.from(result.usage());
 		return ChatResponseMetadata.builder()
-			.withId(result.id())
-			.withModel(result.model())
-			.withUsage(usage)
-			.withKeyValue("stop-reason", result.stopReason())
-			.withKeyValue("stop-sequence", result.stopSequence())
-			.withKeyValue("type", result.type())
+			.id(result.id())
+			.model(result.model())
+			.usage(usage)
+			.keyValue("stop-reason", result.stopReason())
+			.keyValue("stop-sequence", result.stopSequence())
+			.keyValue("type", result.type())
 			.build();
 	}