rename iterations to toolExecutionIterations

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

Author: lambochen

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

@@ -131,7 +131,7 @@ static boolean isInternalToolExecutionEnabled(ChatOptions chatOptions) {
 		return internalToolExecutionEnabled;
 	}
 
-	static boolean isInternalToolExecutionEnabled(ChatOptions chatOptions, int iterations) {
+	static boolean isInternalToolExecutionEnabled(ChatOptions chatOptions, int toolExecutionIterations) {
 		boolean isInternalToolExecutionEnabled = isInternalToolExecutionEnabled(chatOptions);
 		if (!isInternalToolExecutionEnabled) {
 			return false;
@@ -140,7 +140,7 @@ static boolean isInternalToolExecutionEnabled(ChatOptions chatOptions, int itera
 		if (chatOptions instanceof ToolCallingChatOptions toolCallingChatOptions
 				&& toolCallingChatOptions.getInternalToolExecutionMaxIterations() != null) {
 			int maxIterations = toolCallingChatOptions.getInternalToolExecutionMaxIterations();
-			return iterations <= maxIterations;
+			return toolExecutionIterations <= maxIterations;
 		}
 
 		return DEFAULT_TOOL_EXECUTION_ENABLED;

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

@@ -46,16 +46,19 @@ default boolean isToolExecutionRequired(ChatOptions promptOptions, ChatResponse
 
 	/**
 	 * Determines if tool execution should be performed based on the prompt options and
-	 * chat response and attempts.
+	 * chat response and toolExecutionIterations.
 	 * @param promptOptions The options from the prompt
 	 * @param chatResponse The response from the chat model
-	 * @param attempts The number of attempts to execute the tool
+	 * @param toolExecutionIterations The number of toolExecutionIterations to execute the
+	 * tool
 	 * @return true if tool execution should be performed, false otherwise
 	 */
-	default boolean isToolExecutionRequired(ChatOptions promptOptions, ChatResponse chatResponse, int attempts) {
+	default boolean isToolExecutionRequired(ChatOptions promptOptions, ChatResponse chatResponse,
+			int toolExecutionIterations) {
 		Assert.notNull(promptOptions, "promptOptions cannot be null");
 		Assert.notNull(chatResponse, "chatResponse cannot be null");
-		return this.isInternalToolExecutionEnabled(promptOptions, attempts) && this.isToolCallResponse(chatResponse);
+		return this.isInternalToolExecutionEnabled(promptOptions, toolExecutionIterations)
+				&& this.isToolCallResponse(chatResponse);
 	}
 
 	/**
@@ -92,19 +95,20 @@ default boolean isInternalToolExecutionEnabled(ChatOptions chatOptions) {
 	/**
 	 * Determines if tool execution should be performed by the Spring AI or by the client.
 	 * @param chatOptions The options from the chat
-	 * @param attempts The number of attempts to execute the tool
+	 * @param toolExecutionIterations The number of toolExecutionIterations to execute the
+	 * tool
 	 * @return true if tool execution should be performed by Spring AI, false if it should
 	 * be performed by the client
 	 */
-	default boolean isInternalToolExecutionEnabled(ChatOptions chatOptions, int attempts) {
+	default boolean isInternalToolExecutionEnabled(ChatOptions chatOptions, int toolExecutionIterations) {
 		boolean internalToolExecutionEnabled = isInternalToolExecutionEnabled(chatOptions);
 		if (!internalToolExecutionEnabled) {
 			return internalToolExecutionEnabled;
 		}
 
 		if (chatOptions instanceof ToolCallingChatOptions toolCallingChatOptions) {
 			return toolCallingChatOptions.getInternalToolExecutionMaxIterations() == null
-					|| attempts <= toolCallingChatOptions.getInternalToolExecutionMaxIterations();
+					|| toolExecutionIterations <= toolCallingChatOptions.getInternalToolExecutionMaxIterations();
 		}
 		return internalToolExecutionEnabled;
 	}

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

@@ -45,23 +45,24 @@ default boolean isToolExecutionRequired(ChatOptions promptOptions, ChatResponse
 
 	/**
 	 * Determines if tool execution should be performed based on the prompt options and
-	 * chat response and the number of attempts.
+	 * chat response and the number of toolExecutionIterations.
 	 * @param promptOptions The options from the prompt
 	 * @param chatResponse The response from the chat model
-	 * @param attempts The number of attempts
+	 * @param toolExecutionIterations The number of toolExecutionIterations
 	 * @return true if tool execution should be performed, false otherwise
 	 * @see ToolCallingChatOptions#getInternalToolExecutionMaxIterations()
 	 * @see #isToolExecutionRequired(ChatOptions, ChatResponse)
 	 */
-	default boolean isToolExecutionRequired(ChatOptions promptOptions, ChatResponse chatResponse, int attempts) {
+	default boolean isToolExecutionRequired(ChatOptions promptOptions, ChatResponse chatResponse,
+			int toolExecutionIterations) {
 		boolean isToolExecutionRequired = isToolExecutionRequired(promptOptions, chatResponse);
 		if (!isToolExecutionRequired) {
 			return isToolExecutionRequired;
 		}
 
 		if (promptOptions instanceof ToolCallingChatOptions toolCallingChatOptions) {
 			return toolCallingChatOptions.getInternalToolExecutionMaxIterations() == null
-					|| attempts <= toolCallingChatOptions.getInternalToolExecutionMaxIterations();
+					|| toolExecutionIterations <= toolCallingChatOptions.getInternalToolExecutionMaxIterations();
 		}
 		return isToolExecutionRequired;
 	}