Introduce ChatBot example

Signed-off-by: Ricardo Zanini <[email protected]>

Author: ricardozanini

experimental/agentic/src/main/java/io/serverlessworkflow/impl/expressions/agentic/AgenticModelFactory.java

@@ -28,6 +28,19 @@
 
 class AgenticModelFactory implements WorkflowModelFactory {
 
+  private static final String DEFAULT_AGENTIC_SCOPE_STATE_KEY = "input";
+  private final AgenticScopeRegistryAssessor scopeRegistryAssessor =
+      new AgenticScopeRegistryAssessor();
+
+  private AgenticModel asAgenticModel(Object value) {
+    // TODO: fetch memoryId from the object based on known premises
+    final AgenticScope agenticScope = this.scopeRegistryAssessor.getAgenticScope();
+    if (value != null) {
+      agenticScope.writeState(DEFAULT_AGENTIC_SCOPE_STATE_KEY, value);
+    }
+    return new AgenticModel(agenticScope);
+  }
+
   /**
    * Applies any change to the model after running as task. We will always set it to a @AgenticScope
    * object since @AgentExecutor is always adding the output to the agenticScope. We just have to
@@ -60,51 +73,53 @@ public WorkflowModelCollection createCollection() {
 
   @Override
   public WorkflowModel from(boolean value) {
-    return new JavaModel(value);
+    return asAgenticModel(value);
   }
 
   @Override
   public WorkflowModel from(Number value) {
-    return new JavaModel(value);
+    return asAgenticModel(value);
   }
 
   @Override
   public WorkflowModel from(String value) {
-    return new JavaModel(value);
+    return asAgenticModel(value);
   }
 
   @Override
   public WorkflowModel from(CloudEvent ce) {
+    // TODO: serialize the CE into the AgenticScope
     return new JavaModel(ce);
   }
 
   @Override
   public WorkflowModel from(CloudEventData ce) {
+    // TODO: serialize the CE data into the AgenticScope
     return new JavaModel(ce);
   }
 
   @Override
   public WorkflowModel from(OffsetDateTime value) {
-    return new JavaModel(value);
+    return asAgenticModel(value);
   }
 
   @Override
   public WorkflowModel from(Map<String, Object> map) {
-    final AgenticScope agenticScope = new AgenticScopeRegistryAssessor().getAgenticScope();
+    final AgenticScope agenticScope = this.scopeRegistryAssessor.getAgenticScope();
     agenticScope.writeStates(map);
     return new AgenticModel(agenticScope);
   }
 
   @Override
   public WorkflowModel fromNull() {
-    return new JavaModel(null);
+    return asAgenticModel(null);
   }
 
   @Override
   public WorkflowModel fromOther(Object value) {
     if (value instanceof AgenticScope) {
       return new AgenticModel((AgenticScope) value);
     }
-    return new JavaModel(value);
+    return asAgenticModel(value);
   }
 }

fluent/agentic/src/main/java/io/serverlessworkflow/fluent/agentic/AgentDoTaskBuilder.java

@@ -20,6 +20,7 @@
 import io.serverlessworkflow.fluent.func.FuncEmitTaskBuilder;
 import io.serverlessworkflow.fluent.func.FuncForTaskBuilder;
 import io.serverlessworkflow.fluent.func.FuncForkTaskBuilder;
+import io.serverlessworkflow.fluent.func.FuncListenTaskBuilder;
 import io.serverlessworkflow.fluent.func.FuncSetTaskBuilder;
 import io.serverlessworkflow.fluent.func.FuncSwitchTaskBuilder;
 import io.serverlessworkflow.fluent.func.spi.ConditionalTaskBuilder;
@@ -81,6 +82,12 @@ public AgentDoTaskBuilder emit(String name, Consumer<FuncEmitTaskBuilder> itemsC
     return self();
   }
 
+  @Override
+  public AgentDoTaskBuilder listen(String name, Consumer<FuncListenTaskBuilder> itemsConfigurer) {
+    this.listBuilder().listen(name, itemsConfigurer);
+    return self();
+  }
+
   @Override
   public AgentDoTaskBuilder forEach(String name, Consumer<FuncForTaskBuilder> itemsConfigurer) {
     this.listBuilder().forEach(name, itemsConfigurer);

fluent/agentic/src/main/java/io/serverlessworkflow/fluent/agentic/AgentTaskItemListBuilder.java

@@ -24,6 +24,7 @@
 import io.serverlessworkflow.fluent.func.FuncEmitTaskBuilder;
 import io.serverlessworkflow.fluent.func.FuncForTaskBuilder;
 import io.serverlessworkflow.fluent.func.FuncForkTaskBuilder;
+import io.serverlessworkflow.fluent.func.FuncListenTaskBuilder;
 import io.serverlessworkflow.fluent.func.FuncSetTaskBuilder;
 import io.serverlessworkflow.fluent.func.FuncSwitchTaskBuilder;
 import io.serverlessworkflow.fluent.func.FuncTaskItemListBuilder;
@@ -113,6 +114,13 @@ public AgentTaskItemListBuilder emit(String name, Consumer<FuncEmitTaskBuilder>
     return self();
   }
 
+  @Override
+  public AgentTaskItemListBuilder listen(
+      String name, Consumer<FuncListenTaskBuilder> itemsConfigurer) {
+    this.delegate.listen(name, itemsConfigurer);
+    return self();
+  }
+
   @Override
   public AgentTaskItemListBuilder forEach(
       String name, Consumer<FuncForTaskBuilder> itemsConfigurer) {

fluent/agentic/src/test/java/io/serverlessworkflow/fluent/agentic/Agents.java

@@ -17,12 +17,22 @@
 
 import dev.langchain4j.agentic.Agent;
 import dev.langchain4j.agentic.internal.AgentSpecification;
+import dev.langchain4j.service.MemoryId;
+import dev.langchain4j.service.SystemMessage;
 import dev.langchain4j.service.UserMessage;
 import dev.langchain4j.service.V;
 import java.util.List;
 
 public interface Agents {
 
+  @SystemMessage(
+      """
+          You are a happy chat bot.
+          """)
+  interface ChatBot {
+    String chat(@MemoryId String memoryId, @V("message") String message);
+  }
+
   interface MovieExpert {
 
     @UserMessage(

fluent/agentic/src/test/java/io/serverlessworkflow/fluent/agentic/ChatBotIT.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright 2020-Present The Serverless Workflow Specification Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.serverlessworkflow.fluent.agentic;
+
+import static org.mockito.Mockito.spy;
+
+import dev.langchain4j.agentic.AgenticServices;
+import dev.langchain4j.agentic.scope.AgenticScope;
+import org.junit.jupiter.api.Test;
+
+public class ChatBotIT {
+
+  @Test
+  void chat_bot() {
+    Agents.ChatBot chatBot =
+        spy(
+            AgenticServices.agentBuilder(Agents.ChatBot.class)
+                .chatModel(Models.BASE_MODEL)
+                .outputName("message")
+                .build());
+    // 1. listen to an event containing `message` key in the body
+    // 2. if contains, call the agent, if not end the workflow
+    // 3. After replying to the chat, return
+    AgentWorkflowBuilder.workflow("chat-bot")
+        .tasks(
+            t ->
+                t.listen(
+                        "listenToMessages",
+                        l ->
+                            l.outputAs(null)
+                                .one(c -> c.with(event -> event.type("org.acme.chatbot"))))
+                    .when(scope -> !"".equals(scope.readState("message")), AgenticScope.class)
+                    .agent(chatBot)
+                    .then("listenToMessages"));
+  }
+}

fluent/func/src/main/java/io/serverlessworkflow/fluent/func/FuncDoTaskBuilder.java

@@ -41,6 +41,12 @@ public FuncDoTaskBuilder emit(String name, Consumer<FuncEmitTaskBuilder> itemsCo
     return this;
   }
 
+  @Override
+  public FuncDoTaskBuilder listen(String name, Consumer<FuncListenTaskBuilder> itemsConfigurer) {
+    this.listBuilder().listen(name, itemsConfigurer);
+    return this;
+  }
+
   @Override
   public FuncDoTaskBuilder forEach(String name, Consumer<FuncForTaskBuilder> itemsConfigurer) {
     this.listBuilder().forEach(name, itemsConfigurer);

fluent/func/src/main/java/io/serverlessworkflow/fluent/func/FuncEmitTaskBuilder.java

@@ -16,10 +16,12 @@
 package io.serverlessworkflow.fluent.func;
 
 import io.serverlessworkflow.fluent.func.spi.ConditionalTaskBuilder;
+import io.serverlessworkflow.fluent.func.spi.FuncTransformations;
 import io.serverlessworkflow.fluent.spec.EmitTaskBuilder;
 
 public class FuncEmitTaskBuilder extends EmitTaskBuilder
-    implements ConditionalTaskBuilder<FuncSetTaskBuilder> {
+    implements ConditionalTaskBuilder<FuncEmitTaskBuilder>,
+        FuncTransformations<FuncEmitTaskBuilder> {
   FuncEmitTaskBuilder() {
     super();
   }

fluent/func/src/main/java/io/serverlessworkflow/fluent/func/FuncListenTaskBuilder.java

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2020-Present The Serverless Workflow Specification Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.serverlessworkflow.fluent.func;
+
+import io.serverlessworkflow.fluent.func.spi.ConditionalTaskBuilder;
+import io.serverlessworkflow.fluent.func.spi.FuncTransformations;
+import io.serverlessworkflow.fluent.spec.ListenTaskBuilder;
+
+public class FuncListenTaskBuilder extends ListenTaskBuilder
+    implements ConditionalTaskBuilder<FuncListenTaskBuilder>,
+        FuncTransformations<FuncListenTaskBuilder> {
+
+  FuncListenTaskBuilder() {
+    super();
+  }
+}

fluent/func/src/main/java/io/serverlessworkflow/fluent/func/FuncTaskItemListBuilder.java

@@ -79,6 +79,16 @@ public FuncTaskItemListBuilder emit(String name, Consumer<FuncEmitTaskBuilder> i
         new TaskItem(name, new Task().withEmitTask(emitTaskJavaBuilder.build())));
   }
 
+  @Override
+  public FuncTaskItemListBuilder listen(
+      String name, Consumer<FuncListenTaskBuilder> itemsConfigurer) {
+    this.requireNameAndConfig(name, itemsConfigurer);
+    final FuncListenTaskBuilder listenTaskJavaBuilder = new FuncListenTaskBuilder();
+    itemsConfigurer.accept(listenTaskJavaBuilder);
+    return this.addTaskItem(
+        new TaskItem(name, new Task().withListenTask(listenTaskJavaBuilder.build())));
+  }
+
   @Override
   public FuncTaskItemListBuilder forEach(
       String name, Consumer<FuncForTaskBuilder> itemsConfigurer) {

fluent/func/src/main/java/io/serverlessworkflow/fluent/func/spi/FuncDoFluent.java

@@ -19,11 +19,13 @@
 import io.serverlessworkflow.fluent.func.FuncEmitTaskBuilder;
 import io.serverlessworkflow.fluent.func.FuncForTaskBuilder;
 import io.serverlessworkflow.fluent.func.FuncForkTaskBuilder;
+import io.serverlessworkflow.fluent.func.FuncListenTaskBuilder;
 import io.serverlessworkflow.fluent.func.FuncSetTaskBuilder;
 import io.serverlessworkflow.fluent.func.FuncSwitchTaskBuilder;
 import io.serverlessworkflow.fluent.spec.spi.EmitFluent;
 import io.serverlessworkflow.fluent.spec.spi.ForEachFluent;
 import io.serverlessworkflow.fluent.spec.spi.ForkFluent;
+import io.serverlessworkflow.fluent.spec.spi.ListenFluent;
 import io.serverlessworkflow.fluent.spec.spi.SetFluent;
 import io.serverlessworkflow.fluent.spec.spi.SwitchFluent;
 import java.util.UUID;
@@ -36,7 +38,8 @@ public interface FuncDoFluent<SELF extends FuncDoFluent<SELF>>
         EmitFluent<FuncEmitTaskBuilder, SELF>,
         ForEachFluent<FuncForTaskBuilder, SELF>,
         SwitchFluent<FuncSwitchTaskBuilder, SELF>,
-        ForkFluent<FuncForkTaskBuilder, SELF> {
+        ForkFluent<FuncForkTaskBuilder, SELF>,
+        ListenFluent<FuncListenTaskBuilder, SELF> {
 
   SELF callFn(String name, Consumer<FuncCallTaskBuilder> cfg);