OpenAiChatModel support internalToolExecutionMaxAttempts

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

Author: lambochen

models/spring-ai-minimax/src/main/java/org/springframework/ai/minimax/MiniMaxChatOptions.java

@@ -180,7 +180,7 @@ public static MiniMaxChatOptions fromOptions(MiniMaxChatOptions fromOptions) {
 			.toolCallbacks(fromOptions.getToolCallbacks())
 			.toolNames(fromOptions.getToolNames())
 			.internalToolExecutionEnabled(fromOptions.getInternalToolExecutionEnabled())
-				.internalToolExecutionMaxAttempts(fromOptions.getInternalToolExecutionMaxAttempts())
+			.internalToolExecutionMaxAttempts(fromOptions.getInternalToolExecutionMaxAttempts())
 			.toolContext(fromOptions.getToolContext())
 			.build();
 	}
@@ -395,8 +395,8 @@ public int hashCode() {
 		result = prime * result + ((this.toolNames == null) ? 0 : this.toolNames.hashCode());
 		result = prime * result
 				+ ((this.internalToolExecutionEnabled == null) ? 0 : this.internalToolExecutionEnabled.hashCode());
-		result = prime * result
-				+ ((this.internalToolExecutionMaxAttempts == null) ? 0 : this.internalToolExecutionMaxAttempts.hashCode());
+		result = prime * result + ((this.internalToolExecutionMaxAttempts == null) ? 0
+				: this.internalToolExecutionMaxAttempts.hashCode());
 		result = prime * result + ((this.toolContext == null) ? 0 : this.toolContext.hashCode());
 		return result;
 	}

models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiChatModel.java

@@ -105,9 +105,11 @@
  * @author Alexandros Pappas
  * @author Soby Chacko
  * @author Jonghoon Park
+ * @author lambochen
  * @see ChatModel
  * @see StreamingChatModel
  * @see OpenAiApi
+ * @see ToolCallingChatOptions
  */
 public class OpenAiChatModel implements ChatModel {
 
@@ -178,10 +180,10 @@ public ChatResponse call(Prompt prompt) {
 		// Before moving any further, build the final request Prompt,
 		// merging runtime and default options.
 		Prompt requestPrompt = buildRequestPrompt(prompt);
-		return this.internalCall(requestPrompt, null);
+		return this.internalCall(requestPrompt, null, 0);
 	}
 
-	public ChatResponse internalCall(Prompt prompt, ChatResponse previousChatResponse) {
+	public ChatResponse internalCall(Prompt prompt, ChatResponse previousChatResponse, int attempts) {
 
 		ChatCompletionRequest request = createRequest(prompt, false);
 
@@ -240,7 +242,8 @@ public ChatResponse internalCall(Prompt prompt, ChatResponse previousChatRespons
 
 			});
 
-		if (this.toolExecutionEligibilityPredicate.isToolExecutionRequired(prompt.getOptions(), response)) {
+		attempts++;
+		if (this.toolExecutionEligibilityPredicate.isToolExecutionRequired(prompt.getOptions(), response, attempts)) {
 			var toolExecutionResult = this.toolCallingManager.executeToolCalls(prompt, response);
 			if (toolExecutionResult.returnDirect()) {
 				// Return tool execution result directly to the client.
@@ -252,7 +255,7 @@ public ChatResponse internalCall(Prompt prompt, ChatResponse previousChatRespons
 			else {
 				// Send the tool execution result back to the model.
 				return this.internalCall(new Prompt(toolExecutionResult.conversationHistory(), prompt.getOptions()),
-						response);
+						response, attempts);
 			}
 		}
 
@@ -520,6 +523,9 @@ Prompt buildRequestPrompt(Prompt prompt) {
 			requestOptions.setInternalToolExecutionEnabled(
 					ModelOptionsUtils.mergeOption(runtimeOptions.getInternalToolExecutionEnabled(),
 							this.defaultOptions.getInternalToolExecutionEnabled()));
+			requestOptions.setInternalToolExecutionMaxAttempts(
+					ModelOptionsUtils.mergeOption(runtimeOptions.getInternalToolExecutionMaxAttempts(),
+							this.defaultOptions.getInternalToolExecutionMaxAttempts()));
 			requestOptions.setToolNames(ToolCallingChatOptions.mergeToolNames(runtimeOptions.getToolNames(),
 					this.defaultOptions.getToolNames()));
 			requestOptions.setToolCallbacks(ToolCallingChatOptions.mergeToolCallbacks(runtimeOptions.getToolCallbacks(),
@@ -530,6 +536,8 @@ Prompt buildRequestPrompt(Prompt prompt) {
 		else {
 			requestOptions.setHttpHeaders(this.defaultOptions.getHttpHeaders());
 			requestOptions.setInternalToolExecutionEnabled(this.defaultOptions.getInternalToolExecutionEnabled());
+			requestOptions
+				.setInternalToolExecutionMaxAttempts(this.defaultOptions.getInternalToolExecutionMaxAttempts());
 			requestOptions.setToolNames(this.defaultOptions.getToolNames());
 			requestOptions.setToolCallbacks(this.defaultOptions.getToolCallbacks());
 			requestOptions.setToolContext(this.defaultOptions.getToolContext());

models/spring-ai-zhipuai/src/main/java/org/springframework/ai/zhipuai/ZhiPuAiChatOptions.java

@@ -492,10 +492,10 @@ public ToolCallingChatOptions merge(ChatOptions options) {
 			builder.internalToolExecutionEnabled(toolCallingChatOptions.getInternalToolExecutionEnabled() != null
 					? (toolCallingChatOptions).getInternalToolExecutionEnabled()
 					: this.getInternalToolExecutionEnabled());
-			builder.internalToolExecutionMaxAttempts(
-					toolCallingChatOptions.getInternalToolExecutionMaxAttempts() != null
-							? toolCallingChatOptions.getInternalToolExecutionMaxAttempts()
-							: this.getInternalToolExecutionMaxAttempts());
+			builder
+				.internalToolExecutionMaxAttempts(toolCallingChatOptions.getInternalToolExecutionMaxAttempts() != null
+						? toolCallingChatOptions.getInternalToolExecutionMaxAttempts()
+						: this.getInternalToolExecutionMaxAttempts());
 
 			Set<String> toolNames = new HashSet<>();
 			if (this.toolNames != null) {

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

@@ -293,7 +293,8 @@ public ToolCallingChatOptions.Builder internalToolExecutionEnabled(
 		}
 
 		@Override
-		public ToolCallingChatOptions.Builder internalToolExecutionMaxAttempts(Integer internalToolExecutionMaxAttempts) {
+		public ToolCallingChatOptions.Builder internalToolExecutionMaxAttempts(
+				Integer internalToolExecutionMaxAttempts) {
 			this.options.setInternalToolExecutionMaxAttempts(internalToolExecutionMaxAttempts);
 			return this;
 		}

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

@@ -48,6 +48,7 @@ public interface ToolCallingChatOptions extends ChatOptions {
 	 * No limit for tool execution attempts.
 	 */
 	int TOOL_EXECUTION_NO_LIMIT = Integer.MAX_VALUE;
+
 	int DEFAULT_TOOL_EXECUTION_MAX_ATTEMPTS = TOOL_EXECUTION_NO_LIMIT;
 
 	/**

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

@@ -45,7 +45,8 @@ default boolean isToolExecutionRequired(ChatOptions promptOptions, ChatResponse
 	}
 
 	/**
-	 * Determines if tool execution should be performed based on the prompt options and chat response and attempts.
+	 * Determines if tool execution should be performed based on the prompt options and
+	 * chat response and attempts.
 	 * @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
@@ -104,7 +105,8 @@ default boolean isInternalToolExecutionEnabled(ChatOptions chatOptions, int atte
 		if (chatOptions instanceof ToolCallingChatOptions toolCallingChatOptions) {
 			return toolCallingChatOptions.getInternalToolExecutionMaxAttempts() == null
 					|| attempts <= toolCallingChatOptions.getInternalToolExecutionMaxAttempts();
-		} else {
+		}
+		else {
 			internalToolExecutionEnabled = true;
 		}
 		return internalToolExecutionEnabled;

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

@@ -43,4 +43,20 @@ default boolean isToolExecutionRequired(ChatOptions promptOptions, ChatResponse
 		return test(promptOptions, chatResponse);
 	}
 
+	default boolean isToolExecutionRequired(ChatOptions promptOptions, ChatResponse chatResponse, int attempts) {
+		boolean isToolExecutionRequired = isToolExecutionRequired(promptOptions, chatResponse);
+		if (!isToolExecutionRequired) {
+			return true;
+		}
+
+		if (promptOptions instanceof ToolCallingChatOptions toolCallingChatOptions) {
+			return toolCallingChatOptions.getInternalToolExecutionMaxAttempts() == null
+					|| attempts <= toolCallingChatOptions.getInternalToolExecutionMaxAttempts();
+		}
+		else {
+			isToolExecutionRequired = true;
+		}
+		return isToolExecutionRequired;
+	}
+
 }