Merge branch 'spring-projects:main' into equal_and_hashcode

Author: YunKuiLu

.github/workflows/continuous-integration.yml

@@ -5,6 +5,7 @@ on:
     branches:
       - main
       - '*.*.x'
+  workflow_dispatch:
 
 jobs:
   build:
@@ -61,7 +62,7 @@ jobs:
 
       - name: Generate assembly
         working-directory: spring-ai-docs
-        run: ./mvnw --batch-mode assembly:single
+        run: ../mvnw --batch-mode assembly:single
 
       - name: Capture project version
         run: echo PROJECT_VERSION=$(mvn help:evaluate -Dexpression=project.version --quiet -DforceStdout) >> $GITHUB_ENV
@@ -86,4 +87,3 @@ jobs:
           unzip spring-ai-$PROJECT_VERSION-docs.zip
           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
-  

README.md

@@ -23,6 +23,7 @@ You can find more details in the [Reference Documentation](https://docs.spring.i
   - [Audio Transcription](https://docs.spring.io/spring-ai/reference/api/audio/transcriptions.html)
   - [Text to Speech](https://docs.spring.io/spring-ai/reference/api/audio/speech.html)
   - [Moderation](https://docs.spring.io/spring-ai/reference/api/index.html#api/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](https://docs.spring.io/spring-ai/reference/api/chatmodel.html#_chat_options) is also available.
 * [Structured Outputs](https://docs.spring.io/spring-ai/reference/api/structured-output-converter.html) - Mapping of AI Model output to POJOs.
 * Support for all major [Vector Database providers](https://docs.spring.io/spring-ai/reference/api/vectordbs.html) such as *Apache Cassandra, Azure Vector Search, Chroma, Elasticsearch, Milvus, MongoDB Atlas, MariaDB, Neo4j, Oracle, PostgreSQL/PGVector, PineCone, Qdrant, Redis, and Weaviate*.

advisors/spring-ai-advisors-vector-store/src/test/java/org/springframework/ai/chat/client/advisor/vectorstore/QuestionAnswerAdvisorTests.java

@@ -243,4 +243,163 @@ public void qaAdvisorTakesUserParameterizedUserMessagesIntoAccountForSimilarityS
 		Assertions.assertThat(this.vectorSearchCaptor.getValue().getQuery()).isEqualTo(expectedQuery);
 	}
 
+	@Test
+	public void qaAdvisorWithMultipleFilterParameters() {
+		given(this.chatModel.call(this.promptCaptor.capture()))
+				.willReturn(new ChatResponse(List.of(new Generation(new AssistantMessage("Filtered response"))),
+						ChatResponseMetadata.builder().build()));
+
+		given(this.vectorStore.similaritySearch(this.vectorSearchCaptor.capture()))
+				.willReturn(List.of(new Document("doc1"), new Document("doc2")));
+
+		var qaAdvisor = QuestionAnswerAdvisor.builder(this.vectorStore)
+				.searchRequest(SearchRequest.builder().topK(10).build())
+				.build();
+
+		var chatClient = ChatClient.builder(this.chatModel)
+				.defaultAdvisors(qaAdvisor)
+				.build();
+
+		chatClient.prompt()
+				.user("Complex query")
+				.advisors(a -> a.param(QuestionAnswerAdvisor.FILTER_EXPRESSION, "type == 'Documentation' AND status == 'Published'"))
+				.call()
+				.chatResponse();
+
+		var capturedFilter = this.vectorSearchCaptor.getValue().getFilterExpression();
+		assertThat(capturedFilter).isNotNull();
+		// The filter should be properly constructed with AND operation
+		assertThat(capturedFilter.toString()).contains("type");
+		assertThat(capturedFilter.toString()).contains("Documentation");
+	}
+
+	@Test
+	public void qaAdvisorWithDifferentSimilarityThresholds() {
+		given(this.chatModel.call(this.promptCaptor.capture()))
+				.willReturn(new ChatResponse(List.of(new Generation(new AssistantMessage("High threshold response"))),
+						ChatResponseMetadata.builder().build()));
+
+		given(this.vectorStore.similaritySearch(this.vectorSearchCaptor.capture()))
+				.willReturn(List.of(new Document("relevant doc")));
+
+		var qaAdvisor = QuestionAnswerAdvisor.builder(this.vectorStore)
+				.searchRequest(SearchRequest.builder().similarityThreshold(0.95).topK(3).build())
+				.build();
+
+		var chatClient = ChatClient.builder(this.chatModel)
+				.defaultAdvisors(qaAdvisor)
+				.build();
+
+		chatClient.prompt()
+				.user("Specific question requiring high similarity")
+				.call()
+				.chatResponse();
+
+		assertThat(this.vectorSearchCaptor.getValue().getSimilarityThreshold()).isEqualTo(0.95);
+		assertThat(this.vectorSearchCaptor.getValue().getTopK()).isEqualTo(3);
+	}
+
+	@Test
+	public void qaAdvisorWithComplexParameterizedTemplate() {
+		given(this.chatModel.call(this.promptCaptor.capture()))
+				.willReturn(new ChatResponse(List.of(new Generation(new AssistantMessage("Complex template response"))),
+						ChatResponseMetadata.builder().build()));
+
+		given(this.vectorStore.similaritySearch(this.vectorSearchCaptor.capture()))
+				.willReturn(List.of(new Document("template doc")));
+
+		var qaAdvisor = QuestionAnswerAdvisor.builder(this.vectorStore)
+				.searchRequest(SearchRequest.builder().build())
+				.build();
+
+		var chatClient = ChatClient.builder(this.chatModel)
+				.defaultAdvisors(qaAdvisor)
+				.build();
+
+		var complexTemplate = "Please analyze {topic} considering {aspect1} and {aspect2} for user {userId}";
+		chatClient.prompt()
+				.user(u -> u.text(complexTemplate)
+						.param("topic", "machine learning")
+						.param("aspect1", "performance")
+						.param("aspect2", "scalability")
+						.param("userId", "user1"))
+				.call()
+				.chatResponse();
+
+		var expectedQuery = "Please analyze machine learning considering performance and scalability for user user1";
+		assertThat(this.vectorSearchCaptor.getValue().getQuery()).isEqualTo(expectedQuery);
+
+		Message userMessage = this.promptCaptor.getValue().getInstructions().get(0);
+		assertThat(userMessage.getText()).contains(expectedQuery);
+		assertThat(userMessage.getText()).doesNotContain("{topic}");
+		assertThat(userMessage.getText()).doesNotContain("{aspect1}");
+		assertThat(userMessage.getText()).doesNotContain("{aspect2}");
+		assertThat(userMessage.getText()).doesNotContain("{userId}");
+	}
+
+	@Test
+	public void qaAdvisorWithDocumentsContainingMetadata() {
+		given(this.chatModel.call(this.promptCaptor.capture()))
+				.willReturn(new ChatResponse(List.of(new Generation(new AssistantMessage("Metadata response"))),
+						ChatResponseMetadata.builder().build()));
+
+		var docWithMetadata1 = new Document("First document content", Map.of("source", "wiki", "author", "John"));
+		var docWithMetadata2 = new Document("Second document content", Map.of("source", "manual", "version", "2.1"));
+
+		given(this.vectorStore.similaritySearch(this.vectorSearchCaptor.capture()))
+				.willReturn(List.of(docWithMetadata1, docWithMetadata2));
+
+		var qaAdvisor = QuestionAnswerAdvisor.builder(this.vectorStore)
+				.searchRequest(SearchRequest.builder().topK(2).build())
+				.build();
+
+		var chatClient = ChatClient.builder(this.chatModel)
+				.defaultAdvisors(qaAdvisor)
+				.build();
+
+		chatClient.prompt()
+				.user("Question about documents with metadata")
+				.call()
+				.chatResponse();
+
+		Message userMessage = this.promptCaptor.getValue().getInstructions().get(0);
+		assertThat(userMessage.getText()).contains("First document content");
+		assertThat(userMessage.getText()).contains("Second document content");
+	}
+
+	@Test
+	public void qaAdvisorBuilderValidation() {
+		// Test that builder validates required parameters
+		Assertions.assertThatThrownBy(() -> QuestionAnswerAdvisor.builder(null))
+				.isInstanceOf(IllegalArgumentException.class);
+
+		// Test successful builder creation
+		var advisor = QuestionAnswerAdvisor.builder(this.vectorStore).build();
+		assertThat(advisor).isNotNull();
+	}
+
+	@Test
+	public void qaAdvisorWithZeroTopK() {
+		given(this.chatModel.call(this.promptCaptor.capture()))
+				.willReturn(new ChatResponse(List.of(new Generation(new AssistantMessage("Zero docs response"))),
+						ChatResponseMetadata.builder().build()));
+
+		given(this.vectorStore.similaritySearch(this.vectorSearchCaptor.capture()))
+				.willReturn(List.of());
+
+		var qaAdvisor = QuestionAnswerAdvisor.builder(this.vectorStore)
+				.searchRequest(SearchRequest.builder().topK(0).build())
+				.build();
+
+		var chatClient = ChatClient.builder(this.chatModel)
+				.defaultAdvisors(qaAdvisor)
+				.build();
+
+		chatClient.prompt()
+				.user("Question with zero topK")
+				.call()
+				.chatResponse();
+
+		assertThat(this.vectorSearchCaptor.getValue().getTopK()).isEqualTo(0);
+	}
 }

advisors/spring-ai-advisors-vector-store/src/test/java/org/springframework/ai/chat/client/advisor/vectorstore/VectorStoreChatMemoryAdvisorTests.java

@@ -206,4 +206,155 @@ void whenBuilderWithCustomSystemPromptTemplateThenSuccess() {
 		assertThat(advisor).isNotNull();
 	}
 
+	@Test
+	void whenBuilderWithEmptyStringConversationIdThenThrow() {
+		VectorStore vectorStore = Mockito.mock(VectorStore.class);
+
+		assertThatThrownBy(() -> VectorStoreChatMemoryAdvisor.builder(vectorStore).conversationId("").build())
+			.isInstanceOf(IllegalArgumentException.class)
+			.hasMessageContaining("defaultConversationId cannot be null or empty");
+	}
+
+	@Test
+	void whenBuilderWithWhitespaceOnlyConversationIdThenThrow() {
+		VectorStore vectorStore = Mockito.mock(VectorStore.class);
+
+		assertThatThrownBy(() -> VectorStoreChatMemoryAdvisor.builder(vectorStore).conversationId("\t\n\r ").build())
+			.isInstanceOf(IllegalArgumentException.class)
+			.hasMessageContaining("defaultConversationId cannot be null or empty");
+	}
+
+	@Test
+	void whenBuilderWithSpecialCharactersInConversationIdThenSuccess() {
+		VectorStore vectorStore = Mockito.mock(VectorStore.class);
+
+		VectorStoreChatMemoryAdvisor advisor = VectorStoreChatMemoryAdvisor.builder(vectorStore)
+			.conversationId("[email protected]")
+			.build();
+
+		assertThat(advisor).isNotNull();
+	}
+
+	@Test
+	void whenBuilderWithMaxIntegerTopKThenSuccess() {
+		VectorStore vectorStore = Mockito.mock(VectorStore.class);
+
+		VectorStoreChatMemoryAdvisor advisor = VectorStoreChatMemoryAdvisor.builder(vectorStore)
+			.defaultTopK(Integer.MAX_VALUE)
+			.build();
+
+		assertThat(advisor).isNotNull();
+	}
+
+	@Test
+	void whenBuilderWithNegativeTopKThenThrow() {
+		VectorStore vectorStore = Mockito.mock(VectorStore.class);
+
+		assertThatThrownBy(() -> VectorStoreChatMemoryAdvisor.builder(vectorStore).defaultTopK(-100).build())
+			.isInstanceOf(IllegalArgumentException.class)
+			.hasMessageContaining("topK must be greater than 0");
+	}
+
+	@Test
+	void whenBuilderChainedWithAllParametersThenSuccess() {
+		VectorStore vectorStore = Mockito.mock(VectorStore.class);
+		Scheduler scheduler = Mockito.mock(Scheduler.class);
+		PromptTemplate systemPromptTemplate = Mockito.mock(PromptTemplate.class);
+
+		VectorStoreChatMemoryAdvisor advisor = VectorStoreChatMemoryAdvisor.builder(vectorStore)
+			.conversationId("chained-test")
+			.defaultTopK(42)
+			.scheduler(scheduler)
+			.systemPromptTemplate(systemPromptTemplate)
+			.build();
+
+		assertThat(advisor).isNotNull();
+	}
+
+	@Test
+	void whenBuilderParametersSetInDifferentOrderThenSuccess() {
+		VectorStore vectorStore = Mockito.mock(VectorStore.class);
+		Scheduler scheduler = Mockito.mock(Scheduler.class);
+		PromptTemplate systemPromptTemplate = Mockito.mock(PromptTemplate.class);
+
+		VectorStoreChatMemoryAdvisor advisor = VectorStoreChatMemoryAdvisor.builder(vectorStore)
+			.systemPromptTemplate(systemPromptTemplate)
+			.defaultTopK(7)
+			.scheduler(scheduler)
+			.conversationId("order-test")
+			.build();
+
+		assertThat(advisor).isNotNull();
+	}
+
+	@Test
+	void whenBuilderWithOverriddenParametersThenUseLastValue() {
+		VectorStore vectorStore = Mockito.mock(VectorStore.class);
+
+		VectorStoreChatMemoryAdvisor advisor = VectorStoreChatMemoryAdvisor.builder(vectorStore)
+			.conversationId("first-id")
+			.conversationId("second-id") // This should override the first
+			.defaultTopK(5)
+			.defaultTopK(10) // This should override the first
+			.build();
+
+		assertThat(advisor).isNotNull();
+	}
+
+	@Test
+	void whenBuilderReusedThenCreatesSeparateInstances() {
+		VectorStore vectorStore = Mockito.mock(VectorStore.class);
+
+		// Simulate builder reuse (if the builder itself is stateful)
+		var builder = VectorStoreChatMemoryAdvisor.builder(vectorStore).conversationId("shared-config");
+
+		VectorStoreChatMemoryAdvisor advisor1 = builder.build();
+		VectorStoreChatMemoryAdvisor advisor2 = builder.build();
+
+		assertThat(advisor1).isNotNull();
+		assertThat(advisor2).isNotNull();
+		assertThat(advisor1).isNotSameAs(advisor2);
+	}
+
+	@Test
+	void whenBuilderWithLongConversationIdThenSuccess() {
+		VectorStore vectorStore = Mockito.mock(VectorStore.class);
+		String longId = "a".repeat(1000); // 1000 character conversation ID
+
+		VectorStoreChatMemoryAdvisor advisor = VectorStoreChatMemoryAdvisor.builder(vectorStore)
+			.conversationId(longId)
+			.build();
+
+		assertThat(advisor).isNotNull();
+	}
+
+	@Test
+	void whenBuilderCalledWithNullAfterValidValueThenThrow() {
+		VectorStore vectorStore = Mockito.mock(VectorStore.class);
+
+		assertThatThrownBy(() -> VectorStoreChatMemoryAdvisor.builder(vectorStore)
+			.conversationId("valid-id")
+			.conversationId(null) // Set to null after valid value
+			.build()).isInstanceOf(IllegalArgumentException.class)
+			.hasMessageContaining("defaultConversationId cannot be null or empty");
+	}
+
+	@Test
+	void whenBuilderWithTopKBoundaryValuesThenSuccess() {
+		VectorStore vectorStore = Mockito.mock(VectorStore.class);
+
+		// Test with value 1 (minimum valid)
+		VectorStoreChatMemoryAdvisor advisor1 = VectorStoreChatMemoryAdvisor.builder(vectorStore)
+			.defaultTopK(1)
+			.build();
+
+		// Test with a reasonable upper bound
+		VectorStoreChatMemoryAdvisor advisor2 = VectorStoreChatMemoryAdvisor.builder(vectorStore)
+			.defaultTopK(10000)
+			.build();
+
+		assertThat(advisor1).isNotNull();
+		assertThat(advisor2).isNotNull();
+	}
+
 }