UT for IsToolExecutionRequiredWithAttempts

Signed-off-by: lambochen <[email protected]>

Author: lambochen

spring-ai-model/src/main/java/org/springframework/ai/model/tool/ToolExecutionEligibilityPredicate.java

@@ -43,6 +43,15 @@ default boolean isToolExecutionRequired(ChatOptions promptOptions, ChatResponse
 		return test(promptOptions, chatResponse);
 	}
 
+	/**
+	 * Determines if tool execution should be performed based on the prompt options and chat response and the number of attempts.
+	 * @param promptOptions The options from the prompt
+	 * @param chatResponse The response from the chat model
+	 * @param attempts The number of attempts
+	 * @return true if tool execution should be performed, false otherwise
+	 * @see ToolCallingChatOptions#getInternalToolExecutionMaxAttempts()
+	 * @see #isToolExecutionRequired(ChatOptions, ChatResponse)
+	 */
 	default boolean isToolExecutionRequired(ChatOptions promptOptions, ChatResponse chatResponse, int attempts) {
 		boolean isToolExecutionRequired = isToolExecutionRequired(promptOptions, chatResponse);
 		if (!isToolExecutionRequired) {

spring-ai-model/src/test/java/org/springframework/ai/model/tool/ToolExecutionEligibilityPredicateTests.java

@@ -45,6 +45,20 @@ void whenIsToolExecutionRequiredWithNullPromptOptions() {
 			.hasMessageContaining("promptOptions cannot be null");
 	}
 
+	@Test
+	void whenIsToolExecutionRequiredWithAttempts() {
+		ToolExecutionEligibilityPredicate predicate = new TestToolExecutionEligibilityPredicate();
+		ToolCallingChatOptions promptOptions = ToolCallingChatOptions.builder().build();
+		ChatResponse chatResponse = new ChatResponse(List.of(new Generation(new AssistantMessage("test"))));
+		promptOptions.setInternalToolExecutionMaxAttempts(2);
+
+		assertThat(predicate.isToolExecutionRequired(promptOptions, chatResponse, 1)).isTrue();
+		assertThat(predicate.isToolExecutionRequired(promptOptions, chatResponse, 2)).isTrue();
+
+		// attempts value is oversize
+		assertThat(predicate.isToolExecutionRequired(promptOptions, chatResponse, 3)).isFalse();
+	}
+
 	@Test
 	void whenIsToolExecutionRequiredWithNullChatResponse() {
 		ToolExecutionEligibilityPredicate predicate = new TestToolExecutionEligibilityPredicate();