Merge pull request #2013 from quarkiverse/#2009

Introduce `allowContinuousForcedToolCalling` into @RegisterAiService

Author: geoand

core/deployment/src/main/java/io/quarkiverse/langchain4j/deployment/AiServicesProcessor.java

@@ -470,6 +470,11 @@ public void findDeclarativeServices(CombinedIndexBuildItem indexBuildItem,
             Integer maxSequentialToolInvocations = instance.value("maxSequentialToolInvocations") != null
                     ? instance.value("maxSequentialToolInvocations").asInt()
                     : 0;
+
+            boolean allowContinuousForcedToolCalling = instance.value("allowContinuousForcedToolCalling") != null
+                    ? instance.value("allowContinuousForcedToolCalling").asBoolean()
+                    : false;
+
             declarativeAiServiceProducer.produce(
                     new DeclarativeAiServiceBuildItem(
                             declarativeAiServiceClassInfo,
@@ -492,6 +497,7 @@ public void findDeclarativeServices(CombinedIndexBuildItem indexBuildItem,
                             classInputGuardrails(declarativeAiServiceClassInfo, index),
                             classOutputGuardrails(declarativeAiServiceClassInfo, index),
                             maxSequentialToolInvocations,
+                            allowContinuousForcedToolCalling,
                             // we need to make these @DefaultBean because there could be other CDI beans of the same type that need to take precedence
                             impliedRegisterAiServiceTarget.contains(declarativeAiServiceClassInfo.name())));
 
@@ -752,6 +758,7 @@ public void handleDeclarativeServices(AiServicesRecorder recorder,
             ClassInfo declarativeAiServiceClassInfo = bi.getServiceClassInfo();
             String serviceClassName = declarativeAiServiceClassInfo.name().toString();
             Integer maxSequentialToolInvocations = bi.getMaxSequentialToolInvocations();
+            boolean allowContinuousForcedToolCalling = bi.isAllowContinuousForcedToolCalling();
 
             String chatLanguageModelSupplierClassName = (bi.getChatLanguageModelSupplierClassDotName() != null
                     ? bi.getChatLanguageModelSupplierClassDotName().toString()
@@ -879,7 +886,8 @@ public void handleDeclarativeServices(AiServicesRecorder recorder,
                                     toolHallucinationStrategyClassName,
                                     classInputGuardrails(bi),
                                     classOutputGuardrails(bi),
-                                    maxSequentialToolInvocations)))
+                                    maxSequentialToolInvocations,
+                                    allowContinuousForcedToolCalling)))
                     .setRuntimeInit()
                     .addQualifier()
                     .annotation(LangChain4jDotNames.QUARKUS_AI_SERVICE_CONTEXT_QUALIFIER).addValue("value", serviceClassName)

core/deployment/src/main/java/io/quarkiverse/langchain4j/deployment/DeclarativeAiServiceBuildItem.java

@@ -34,6 +34,7 @@ public final class DeclarativeAiServiceBuildItem extends MultiBuildItem {
     private final DeclarativeAiServiceInputGuardrails inputGuardrails;
     private final DeclarativeAiServiceOutputGuardrails outputGuardrails;
     private final Integer maxSequentialToolInvocations;
+    private final boolean allowContinuousForcedToolCalling;
     private final boolean makeDefaultBean;
 
     public DeclarativeAiServiceBuildItem(
@@ -56,7 +57,9 @@ public DeclarativeAiServiceBuildItem(
             DotName toolHallucinationStrategyClassDotName,
             DeclarativeAiServiceInputGuardrails inputGuardrails,
             DeclarativeAiServiceOutputGuardrails outputGuardrails,
-            Integer maxSequentialToolInvocations, boolean makeDefaultBean) {
+            Integer maxSequentialToolInvocations,
+            boolean allowContinuousForcedToolCalling,
+            boolean makeDefaultBean) {
         this.serviceClassInfo = serviceClassInfo;
         this.chatLanguageModelSupplierClassDotName = chatLanguageModelSupplierClassDotName;
         this.streamingChatLanguageModelSupplierClassDotName = streamingChatLanguageModelSupplierClassDotName;
@@ -77,6 +80,7 @@ public DeclarativeAiServiceBuildItem(
         this.inputGuardrails = inputGuardrails;
         this.outputGuardrails = outputGuardrails;
         this.maxSequentialToolInvocations = maxSequentialToolInvocations;
+        this.allowContinuousForcedToolCalling = allowContinuousForcedToolCalling;
         this.makeDefaultBean = makeDefaultBean;
     }
 
@@ -184,4 +188,8 @@ public List<String> asClassNames() {
     public Integer getMaxSequentialToolInvocations() {
         return maxSequentialToolInvocations;
     }
+
+    public boolean isAllowContinuousForcedToolCalling() {
+        return allowContinuousForcedToolCalling;
+    }
 }

core/runtime/src/main/java/io/quarkiverse/langchain4j/QuarkusAiServicesFactory.java

@@ -68,6 +68,11 @@ public AiServices<T> maxSequentialToolInvocations(Integer maxSequentialToolInvoc
             return this;
         }
 
+        public AiServices<T> allowContinuousForcedToolCalling(boolean allowContinuousForcedToolCalling) {
+            quarkusAiServiceContext().allowContinuousForcedToolCalling = allowContinuousForcedToolCalling;
+            return this;
+        }
+
         @SuppressWarnings("unchecked")
         @Override
         public T build() {

core/runtime/src/main/java/io/quarkiverse/langchain4j/RegisterAiService.java

@@ -16,6 +16,7 @@
 import dev.langchain4j.memory.chat.MessageWindowChatMemory;
 import dev.langchain4j.model.chat.ChatModel;
 import dev.langchain4j.model.chat.StreamingChatModel;
+import dev.langchain4j.model.chat.request.ToolChoice;
 import dev.langchain4j.model.image.ImageModel;
 import dev.langchain4j.model.moderation.ModerationModel;
 import dev.langchain4j.rag.RetrievalAugmentor;
@@ -31,7 +32,7 @@
  * Used to create LangChain4j's {@link AiServices} in a declarative manner that the application can then use simply by
  * using the class as a CDI bean.
  * Under the hood LangChain4j's {@link AiServices#builder(Class)} is called
- * while also providing the builder with the proper {@link ChatLanguageModel} bean (mandatory), {@code tools} bean (optional),
+ * while also providing the builder with the proper {@link ChatModel} bean (mandatory), {@code tools} bean (optional),
  * {@link ChatMemoryProvider} and {@link ContentRetriever} beans (which by default are configured if such beans exist).
  * <p>
  * NOTE: The resulting CDI bean is {@link jakarta.enterprise.context.RequestScoped} by default. If you need to change the scope,
@@ -48,7 +49,7 @@
 public @interface RegisterAiService {
 
     /**
-     * Configures the way to obtain the {@link StreamingChatLanguageModel} to use.
+     * Configures the way to obtain the {@link StreamingChatModel} to use.
      * If not configured, the default CDI bean implementing the model is looked up.
      * Such a bean provided automatically by extensions such as {@code quarkus-langchain4j-openai},
      * {@code quarkus-langchain4j-azure-openai} or
@@ -57,7 +58,7 @@
     Class<? extends Supplier<StreamingChatModel>> streamingChatLanguageModelSupplier() default BeanStreamingChatLanguageModelSupplier.class;
 
     /**
-     * Configures the way to obtain the {@link ChatLanguageModel} to use.
+     * Configures the way to obtain the {@link ChatModel} to use.
      * If not configured, the default CDI bean implementing the model is looked up.
      * Such a bean provided automatically by extensions such as {@code quarkus-langchain4j-openai},
      * {@code quarkus-langchain4j-azure-openai} or
@@ -67,7 +68,7 @@
 
     /**
      * When {@code chatLanguageModelSupplier} is set to {@code BeanChatLanguageModelSupplier.class} (which is the default)
-     * this allows the selection of the {@link ChatLanguageModel} CDI bean to use.
+     * this allows the selection of the {@link ChatModel} CDI bean to use.
      * <p>
      * If not set, the default model (i.e. the one configured without setting the model name) is used.
      * An example of the default model configuration is the following:
@@ -148,7 +149,20 @@
     Class<? extends Supplier<ToolProvider>> toolProviderSupplier() default BeanIfExistsToolProviderSupplier.class;
 
     /**
-     * Marker that is used to tell Quarkus to use the {@link ChatLanguageModel} that has been configured as a CDI bean by
+     * By default, after first tool call execution, in subsequent prompts the {@code toolChoice} of
+     * {@link dev.langchain4j.model.chat.request.ChatRequestParameters}
+     * is set to {@link ToolChoice#AUTO}.
+     * By enabling this option {@link ToolChoice#AUTO} will not be set and instead whatever value was used in the initial prompt
+     * will
+     * continue to be used.
+     * <p>
+     * BEWARE: This is dangerous as it can result in an infinite-loop when using the AiService in combination with the
+     * {@code toolChoice} option set to {@link ToolChoice#REQUIRED}.
+     */
+    boolean allowContinuousForcedToolCalling() default false;
+
+    /**
+     * Marker that is used to tell Quarkus to use the {@link ChatModel} that has been configured as a CDI bean by
      * any of the extensions providing such capability (such as {@code quarkus-langchain4j-openai} and
      * {@code quarkus-langchain4j-hugging-face}).
      */
@@ -161,7 +175,7 @@ public ChatModel get() {
     }
 
     /**
-     * Marker that is used to tell Quarkus to use the {@link StreamingChatLanguageModel} that has been configured as a CDI bean
+     * Marker that is used to tell Quarkus to use the {@link StreamingChatModel} that has been configured as a CDI bean
      * by * any of the extensions providing such capability (such as {@code quarkus-langchain4j-openai} and
      * {@code quarkus-langchain4j-hugging-face}).
      */

core/runtime/src/main/java/io/quarkiverse/langchain4j/runtime/AiServicesRecorder.java

@@ -312,6 +312,12 @@ public QuarkusAiServiceContext apply(SyntheticCreationalContext<QuarkusAiService
                         quarkusAiServices.maxSequentialToolInvocations(info.maxSequentialToolInvocations());
                     }
 
+                    if (info.maxSequentialToolInvocations() != null && info.maxSequentialToolInvocations() > 0) {
+                        quarkusAiServices.maxSequentialToolInvocations(info.maxSequentialToolInvocations());
+                    }
+
+                    quarkusAiServices.allowContinuousForcedToolCalling(info.allowContinuousForcedToolCalling());
+
                     return aiServiceContext;
                 } catch (ClassNotFoundException e) {
                     throw new IllegalStateException(e);

core/runtime/src/main/java/io/quarkiverse/langchain4j/runtime/aiservice/AiServiceMethodImplementationSupport.java

@@ -503,7 +503,8 @@ private static Object doImplement0(AiServiceMethodCreateInfo methodCreateInfo, I
 
             if (nonNull(context.chatModel.defaultRequestParameters())) {
                 var toolChoice = context.chatModel.defaultRequestParameters().toolChoice();
-                if (nonNull(toolChoice) && toolChoice.equals(ToolChoice.REQUIRED)) {
+                if (nonNull(toolChoice) && toolChoice.equals(ToolChoice.REQUIRED)
+                        && !context.allowContinuousForcedToolCalling) {
                     // This code is needed to avoid a infinite-loop when using the AiService
                     // in combination with the tool-choice option set to REQUIRED.
                     // If the tool-choice option is not set to AUTO after calling the tool,

core/runtime/src/main/java/io/quarkiverse/langchain4j/runtime/aiservice/DeclarativeAiServiceCreateInfo.java

@@ -27,5 +27,6 @@ public record DeclarativeAiServiceCreateInfo(
         String toolHallucinationStrategyClassName,
         InputGuardrailsLiteral inputGuardrails,
         OutputGuardrailsLiteral outputGuardrails,
-        Integer maxSequentialToolInvocations) {
+        Integer maxSequentialToolInvocations,
+        boolean allowContinuousForcedToolCalling) {
 }

core/runtime/src/main/java/io/quarkiverse/langchain4j/runtime/aiservice/QuarkusAiServiceContext.java

@@ -22,6 +22,7 @@ public class QuarkusAiServiceContext extends AiServiceContext {
     public ChatMemorySeeder chatMemorySeeder;
     public ImageModel imageModel;
     public Integer maxSequentialToolExecutions;
+    public boolean allowContinuousForcedToolCalling;
 
     // needed by Arc
     public QuarkusAiServiceContext() {