Fix to make the property internalToolExecutionEnabled readable when options are merged

ilayaperumalg · ilayaperumalg · commit 07aaca377397 · 2025-04-10T10:52:59.000+01:00
- In DefaultToolCallingChatOptions, the property internalToolExecutionEnabled was set via deprecated proxyTools property which is now removed.
    - Add getter method with the prefix "get" to make the BeanWrapperImpl recognize the reader method for internalToolExecutionEnabled
    - Fix ModelOptionsUtils to recognize the correct interface method for boolean property names
diff --git a/models/spring-ai-anthropic/src/main/java/org/springframework/ai/anthropic/AnthropicChatOptions.java b/models/spring-ai-anthropic/src/main/java/org/springframework/ai/anthropic/AnthropicChatOptions.java
@@ -220,6 +220,12 @@ public Boolean isInternalToolExecutionEnabled() {
 		return internalToolExecutionEnabled;
 	}
 
+	// This getter is used by the BeanWrapper when merging options.
+	@Nullable
+	public Boolean getInternalToolExecutionEnabled() {
+		return isInternalToolExecutionEnabled();
+	}
+
 	@Override
 	@JsonIgnore
 	public void setInternalToolExecutionEnabled(@Nullable Boolean internalToolExecutionEnabled) {
diff --git a/models/spring-ai-azure-openai/src/main/java/org/springframework/ai/azure/openai/AzureOpenAiChatOptions.java b/models/spring-ai-azure-openai/src/main/java/org/springframework/ai/azure/openai/AzureOpenAiChatOptions.java
@@ -234,6 +234,12 @@ public Boolean isInternalToolExecutionEnabled() {
 		return internalToolExecutionEnabled;
 	}
 
+	// This getter is used by the BeanWrapper when merging options.
+	@Nullable
+	public Boolean getInternalToolExecutionEnabled() {
+		return isInternalToolExecutionEnabled();
+	}
+
 	@Override
 	@JsonIgnore
 	public void setInternalToolExecutionEnabled(@Nullable Boolean internalToolExecutionEnabled) {
diff --git a/models/spring-ai-mistral-ai/src/main/java/org/springframework/ai/mistralai/MistralAiChatOptions.java b/models/spring-ai-mistral-ai/src/main/java/org/springframework/ai/mistralai/MistralAiChatOptions.java
@@ -290,6 +290,12 @@ public Boolean isInternalToolExecutionEnabled() {
 		return internalToolExecutionEnabled;
 	}
 
+	// This getter is used by the BeanWrapper when merging options.
+	@Nullable
+	public Boolean getInternalToolExecutionEnabled() {
+		return isInternalToolExecutionEnabled();
+	}
+
 	@Override
 	@JsonIgnore
 	public void setInternalToolExecutionEnabled(@Nullable Boolean internalToolExecutionEnabled) {
diff --git a/models/spring-ai-ollama/src/main/java/org/springframework/ai/ollama/api/OllamaOptions.java b/models/spring-ai-ollama/src/main/java/org/springframework/ai/ollama/api/OllamaOptions.java
@@ -721,6 +721,12 @@ public Boolean isInternalToolExecutionEnabled() {
     	return internalToolExecutionEnabled;
     }
 
+	// This getter is used by the BeanWrapper when merging options.
+	@Nullable
+	public Boolean getInternalToolExecutionEnabled() {
+		return isInternalToolExecutionEnabled();
+	}
+
 	@Override
 	@JsonIgnore
 	public void setInternalToolExecutionEnabled(@Nullable Boolean internalToolExecutionEnabled) {
diff --git a/models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiChatModel.java b/models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiChatModel.java
@@ -212,16 +212,16 @@ public ChatResponse internalCall(Prompt prompt, ChatResponse previousChatRespons
 				}
 
 			// @formatter:off
-				List<Generation> generations = choices.stream().map(choice -> {
-					Map<String, Object> metadata = Map.of(
-							"id", chatCompletion.id() != null ? chatCompletion.id() : "",
-							"role", choice.message().role() != null ? choice.message().role().name() : "",
-							"index", choice.index(),
-							"finishReason", choice.finishReason() != null ? choice.finishReason().name() : "",
-							"refusal", StringUtils.hasText(choice.message().refusal()) ? choice.message().refusal() : "");
-					return buildGeneration(choice, metadata, request);
-				}).toList();
-				// @formatter:on
+					List<Generation> generations = choices.stream().map(choice -> {
+						Map<String, Object> metadata = Map.of(
+								"id", chatCompletion.id() != null ? chatCompletion.id() : "",
+								"role", choice.message().role() != null ? choice.message().role().name() : "",
+								"index", choice.index(),
+								"finishReason", choice.finishReason() != null ? choice.finishReason().name() : "",
+								"refusal", StringUtils.hasText(choice.message().refusal()) ? choice.message().refusal() : "");
+						return buildGeneration(choice, metadata, request);
+					}).toList();
+					// @formatter:on
 
 				RateLimit rateLimit = OpenAiResponseHeaderExtractor.extractAiResponseHeaders(completionEntity);
 
@@ -308,19 +308,19 @@ public Flux<ChatResponse> internalStream(Prompt prompt, ChatResponse previousCha
 						String id = chatCompletion2.id();
 
 						List<Generation> generations = chatCompletion2.choices().stream().map(choice -> { // @formatter:off
-							if (choice.message().role() != null) {
-								roleMap.putIfAbsent(id, choice.message().role().name());
-							}
-							Map<String, Object> metadata = Map.of(
-									"id", chatCompletion2.id(),
-									"role", roleMap.getOrDefault(id, ""),
-									"index", choice.index(),
-									"finishReason", choice.finishReason() != null ? choice.finishReason().name() : "",
-									"refusal", StringUtils.hasText(choice.message().refusal()) ? choice.message().refusal() : "");
-
-							return buildGeneration(choice, metadata, request);
-						}).toList();
-						// @formatter:on
+								if (choice.message().role() != null) {
+									roleMap.putIfAbsent(id, choice.message().role().name());
+								}
+								Map<String, Object> metadata = Map.of(
+										"id", chatCompletion2.id(),
+										"role", roleMap.getOrDefault(id, ""),
+										"index", choice.index(),
+										"finishReason", choice.finishReason() != null ? choice.finishReason().name() : "",
+										"refusal", StringUtils.hasText(choice.message().refusal()) ? choice.message().refusal() : "");
+
+								return buildGeneration(choice, metadata, request);
+							}).toList();
+							// @formatter:on
 						OpenAiApi.Usage usage = chatCompletion2.usage();
 						Usage currentChatResponseUsage = usage != null ? getDefaultUsage(usage) : new EmptyUsage();
 						Usage accumulatedUsage = UsageUtils.getCumulativeUsage(currentChatResponseUsage,
@@ -361,30 +361,30 @@ public Flux<ChatResponse> internalStream(Prompt prompt, ChatResponse previousCha
 
 			// @formatter:off
 			Flux<ChatResponse> flux = chatResponse.flatMap(response -> {
-				if (toolExecutionEligibilityPredicate.isToolExecutionRequired(prompt.getOptions(), response)) {
-					return Flux.defer(() -> {
-						// FIXME: bounded elastic needs to be used since tool calling
-						//  is currently only synchronous
-						var toolExecutionResult = this.toolCallingManager.executeToolCalls(prompt, response);
-						if (toolExecutionResult.returnDirect()) {
-							// Return tool execution result directly to the client.
-							return Flux.just(ChatResponse.builder().from(response)
-									.generations(ToolExecutionResult.buildGenerations(toolExecutionResult))
-									.build());
-						} else {
-							// Send the tool execution result back to the model.
-							return this.internalStream(new Prompt(toolExecutionResult.conversationHistory(), prompt.getOptions()),
-									response);
+						if (toolExecutionEligibilityPredicate.isToolExecutionRequired(prompt.getOptions(), response)) {
+							return Flux.defer(() -> {
+								// FIXME: bounded elastic needs to be used since tool calling
+								//  is currently only synchronous
+								var toolExecutionResult = this.toolCallingManager.executeToolCalls(prompt, response);
+								if (toolExecutionResult.returnDirect()) {
+									// Return tool execution result directly to the client.
+									return Flux.just(ChatResponse.builder().from(response)
+											.generations(ToolExecutionResult.buildGenerations(toolExecutionResult))
+											.build());
+								} else {
+									// Send the tool execution result back to the model.
+									return this.internalStream(new Prompt(toolExecutionResult.conversationHistory(), prompt.getOptions()),
+											response);
+								}
+							}).subscribeOn(Schedulers.boundedElastic());
 						}
-					}).subscribeOn(Schedulers.boundedElastic());
-				}
-				else {
-					return Flux.just(response);
-				}
-			})
-			.doOnError(observation::error)
-			.doFinally(s -> observation.stop())
-			.contextWrite(ctx -> ctx.put(ObservationThreadLocalAccessor.KEY, observation));
+						else {
+							return Flux.just(response);
+						}
+					})
+					.doOnError(observation::error)
+					.doFinally(s -> observation.stop())
+					.contextWrite(ctx -> ctx.put(ObservationThreadLocalAccessor.KEY, observation));
 			// @formatter:on
 
 			return new MessageAggregator().aggregate(flux, observationContext::setResponse);
diff --git a/models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiChatOptions.java b/models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiChatOptions.java
@@ -492,6 +492,12 @@ public Boolean isInternalToolExecutionEnabled() {
 		return internalToolExecutionEnabled;
 	}
 
+	// This getter is used by the BeanWrapper when merging options.
+	@Nullable
+	public Boolean getInternalToolExecutionEnabled() {
+		return isInternalToolExecutionEnabled();
+	}
+
 	@Override
 	@JsonIgnore
 	public void setInternalToolExecutionEnabled(@Nullable Boolean internalToolExecutionEnabled) {
diff --git a/models/spring-ai-vertex-ai-gemini/src/main/java/org/springframework/ai/vertexai/gemini/VertexAiGeminiChatOptions.java b/models/spring-ai-vertex-ai-gemini/src/main/java/org/springframework/ai/vertexai/gemini/VertexAiGeminiChatOptions.java
@@ -263,6 +263,12 @@ public Boolean isInternalToolExecutionEnabled() {
 		return internalToolExecutionEnabled;
 	}
 
+	// This getter is used by the BeanWrapper when merging options.
+	@Nullable
+	public Boolean getInternalToolExecutionEnabled() {
+		return isInternalToolExecutionEnabled();
+	}
+
 	@Override
 	public void setInternalToolExecutionEnabled(@Nullable Boolean internalToolExecutionEnabled) {
 		this.internalToolExecutionEnabled = internalToolExecutionEnabled;
diff --git a/spring-ai-model/src/main/java/org/springframework/ai/model/ModelOptionsUtils.java b/spring-ai-model/src/main/java/org/springframework/ai/model/ModelOptionsUtils.java
@@ -18,6 +18,7 @@
 
 import java.beans.PropertyDescriptor;
 import java.lang.reflect.Field;
+import java.lang.reflect.ParameterizedType;
 import java.lang.reflect.Type;
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -61,6 +62,7 @@
  *
  * @author Christian Tzolov
  * @author Thomas Vitale
+ * @author Ilayaperumal Gopinathan
  * @since 0.8.0
  */
 public abstract class ModelOptionsUtils {
@@ -325,7 +327,7 @@ public static <I, S extends I, T extends S> T mergeBeans(S source, T target, Cla
 		for (PropertyDescriptor descriptor : sourceBeanWrap.getPropertyDescriptors()) {
 
 			if (!BEAN_MERGE_FIELD_EXCISIONS.contains(descriptor.getName())
-					&& interfaceNames.contains(toGetName(descriptor.getName()))) {
+					&& interfaceNames.contains(toGetName(descriptor))) {
 
 				String propertyName = descriptor.getName();
 				Object value = sourceBeanWrap.getPropertyValue(propertyName);
@@ -344,6 +346,17 @@ public static <I, S extends I, T extends S> T mergeBeans(S source, T target, Cla
 		return target;
 	}
 
+	private static String toGetName(PropertyDescriptor descriptor) {
+		String name = descriptor.getName();
+		Class propertyType = descriptor.getPropertyType();
+		if (propertyType == Boolean.class) {
+			return "is" + Character.toUpperCase(name.charAt(0)) + name.substring(1);
+		}
+		else {
+			return "get" + Character.toUpperCase(name.charAt(0)) + name.substring(1);
+		}
+	}
+
 	private static String toGetName(String name) {
 		return "get" + name.substring(0, 1).toUpperCase() + name.substring(1);
 	}
diff --git a/spring-ai-model/src/main/java/org/springframework/ai/model/tool/DefaultToolCallingChatOptions.java b/spring-ai-model/src/main/java/org/springframework/ai/model/tool/DefaultToolCallingChatOptions.java
@@ -113,6 +113,12 @@ public Boolean isInternalToolExecutionEnabled() {
 		return this.internalToolExecutionEnabled;
 	}
 
+	// This getter is used by the BeanWrapper when merging options.
+	@Nullable
+	public Boolean getInternalToolExecutionEnabled() {
+		return isInternalToolExecutionEnabled();
+	}
+
 	@Override
 	public void setInternalToolExecutionEnabled(@Nullable Boolean internalToolExecutionEnabled) {
 		this.internalToolExecutionEnabled = internalToolExecutionEnabled;
diff --git a/spring-ai-model/src/main/java/org/springframework/ai/model/tool/ToolCallingChatOptions.java b/spring-ai-model/src/main/java/org/springframework/ai/model/tool/ToolCallingChatOptions.java
@@ -38,6 +38,7 @@
  * including tool calling.
  *
  * @author Thomas Vitale
+ * @author Ilayaperumal Gopinathan
  * @since 1.0.0
  */
 public interface ToolCallingChatOptions extends ChatOptions {
@@ -77,9 +78,17 @@ public interface ToolCallingChatOptions extends ChatOptions {
 	 */
 	void setInternalToolExecutionEnabled(@Nullable Boolean internalToolExecutionEnabled);
 
+	/**
+	 * Get the configured tool context.
+	 * @return the tool context map.
+	 */
 	Map<String, Object> getToolContext();
 
-	void setToolContext(Map<String, Object> tooContext);
+	/**
+	 * Set the tool context values as map.
+	 * @param toolContext
+	 */
+	void setToolContext(Map<String, Object> toolContext);
 
 	/**
 	 * A builder to create a new {@link ToolCallingChatOptions} instance.
@@ -172,10 +181,6 @@ static boolean isInternalToolExecutionEnabled(ChatOptions chatOptions) {
 				&& toolCallingChatOptions.isInternalToolExecutionEnabled() != null) {
 			internalToolExecutionEnabled = Boolean.TRUE.equals(toolCallingChatOptions.isInternalToolExecutionEnabled());
 		}
-		else if (chatOptions instanceof FunctionCallingOptions functionCallingOptions
-				&& functionCallingOptions.getProxyToolCalls() != null) {
-			internalToolExecutionEnabled = Boolean.TRUE.equals(!functionCallingOptions.getProxyToolCalls());
-		}
 		else {
 			internalToolExecutionEnabled = DEFAULT_TOOL_EXECUTION_ENABLED;
 		}
diff --git a/spring-ai-model/src/test/java/org/springframework/ai/model/tool/DefaultToolExecutionEligibilityPredicateTests.java b/spring-ai-model/src/test/java/org/springframework/ai/model/tool/DefaultToolExecutionEligibilityPredicateTests.java
@@ -94,38 +94,6 @@ void whenToolExecutionDisabledAndNoToolCalls() {
 		assertThat(result).isFalse();
 	}
 
-	@Test
-	void whenFunctionCallingOptionsAndToolExecutionEnabled() {
-		// Create a FunctionCallingOptions with proxy tool calls disabled (which means
-		// internal tool execution is enabled)
-		FunctionCallingOptions options = FunctionCallingOptions.builder().proxyToolCalls(false).build();
-
-		// Create a ChatResponse with tool calls
-		AssistantMessage.ToolCall toolCall = new AssistantMessage.ToolCall("id1", "function", "testTool", "{}");
-		AssistantMessage assistantMessage = new AssistantMessage("test", Map.of(), List.of(toolCall));
-		ChatResponse chatResponse = new ChatResponse(List.of(new Generation(assistantMessage)));
-
-		// Test the predicate
-		boolean result = predicate.test(options, chatResponse);
-		assertThat(result).isTrue();
-	}
-
-	@Test
-	void whenFunctionCallingOptionsAndToolExecutionDisabled() {
-		// Create a FunctionCallingOptions with proxy tool calls enabled (which means
-		// internal tool execution is disabled)
-		FunctionCallingOptions options = FunctionCallingOptions.builder().proxyToolCalls(true).build();
-
-		// Create a ChatResponse with tool calls
-		AssistantMessage.ToolCall toolCall = new AssistantMessage.ToolCall("id1", "function", "testTool", "{}");
-		AssistantMessage assistantMessage = new AssistantMessage("test", Map.of(), List.of(toolCall));
-		ChatResponse chatResponse = new ChatResponse(List.of(new Generation(assistantMessage)));
-
-		// Test the predicate
-		boolean result = predicate.test(options, chatResponse);
-		assertThat(result).isFalse();
-	}
-
 	@Test
 	void whenRegularChatOptionsAndHasToolCalls() {
 		// Create regular ChatOptions (not ToolCallingChatOptions or
diff --git a/spring-ai-model/src/test/java/org/springframework/ai/model/tool/ToolCallingChatOptionsTests.java b/spring-ai-model/src/test/java/org/springframework/ai/model/tool/ToolCallingChatOptionsTests.java
@@ -56,26 +56,6 @@ void whenToolCallingChatOptionsAndExecutionEnabledDefault() {
 		assertThat(ToolCallingChatOptions.isInternalToolExecutionEnabled(options)).isTrue();
 	}
 
-	@Test
-	void whenFunctionCallingOptionsAndExecutionEnabledTrue() {
-		FunctionCallingOptions options = FunctionCallingOptions.builder().build();
-		options.setProxyToolCalls(false);
-		assertThat(ToolCallingChatOptions.isInternalToolExecutionEnabled(options)).isTrue();
-	}
-
-	@Test
-	void whenFunctionCallingOptionsAndExecutionEnabledFalse() {
-		FunctionCallingOptions options = FunctionCallingOptions.builder().build();
-		options.setProxyToolCalls(true);
-		assertThat(ToolCallingChatOptions.isInternalToolExecutionEnabled(options)).isFalse();
-	}
-
-	@Test
-	void whenFunctionCallingOptionsAndExecutionEnabledDefault() {
-		FunctionCallingOptions options = FunctionCallingOptions.builder().build();
-		assertThat(ToolCallingChatOptions.isInternalToolExecutionEnabled(options)).isTrue();
-	}
-
 	@Test
 	void whenMergeRuntimeAndDefaultToolNames() {
 		Set<String> runtimeToolNames = Set.of("toolA");
