Allow response definition when using assistant

Author: phillip-kruger

docs/src/main/asciidoc/assistant.adoc

@@ -145,16 +145,24 @@ You can add an assistant function to a workspace item using the same approach as
                     .systemMessage(JOKE_SYSTEM_MESSAGE) // <2>
                     .userMessage(JOKE_USER_MESSAGE) // <3>
                     .variables(params)
+                    .responseType(ExpectedResponse.class) // <4>   
                     .assist();
 
         })
         .display(Display.split)
         .displayType(DisplayType.markdown)
         .filter(Patterns.JAVA_SRC));
+
+
+        //...
+
+        final record ExpectedResponse(String result, String markdown) {
+        }
 ----
 <1> Use `assistantFunction` to receive the `Assistant` instance and xref:dev-ui.adoc#input[input] parameters.  
 <2> Provide an optional *system message* to guide the assistant's behavior.  
 <3> Provide a *user message* as the primary prompt.
+<4> Provide a class defining your expected response structure.
 
 === Assistant pages
 
@@ -203,11 +211,16 @@ You can now use this assistant in any JsonRPC method, example:
         if (assistant.isPresent()) {
             return assistant.get().assistBuilder()
                     .userMessage("Tell me a funny joke")
+                    .responseType(JokeResponse.class) // <1>
                     .assist();
         }
         return CompletableFuture.failedStage(new RuntimeException("Assistant is not available"));
     }
+
+    //...
+    final record JokeResponse(String joke) {}
 ----
+<1> Provide a class defining your expected response structure.
 
 ==== JsonRPC against the Deployment classpath
 
@@ -235,11 +248,16 @@ Then use the `BuildTimeActionBuildItem` and register assistant actions via `.add
                 return assistant.assistBuilder()
                         .userMessage(USER_MESSAGE)
                         .variables(p)
+                        .responseType(JokeResponse.class) // <2>
                         .assist();
             }).build());
         buildTimeActionProducer.produce(bta);
+
+        //...
+        final record JokeResponse(String joke) {}
 ----
 <1> Use `assistantFunction` instead of `function` to access the assistant context.
+<2> Provide a class defining your expected response structure.
 
 === Assistant State in the UI
 
@@ -312,13 +330,18 @@ AssistantConsoleBuildItem createCliAssistantEntry() {
             .function((a) -> {
                 return a.assistBuilder()
                         .userMessage("Tell a funny joke")
+                        .responseType(JokeResponse.class) // <3>
                         .assist();
             })
             .build();
 }
+//...
+final record JokeResponse(String joke) {}
+
 ----
 <1> This is the description that appears in the Assistant section of the log menu.  
 <2> This is the keyboard shortcut that triggers the assistant function.
+<3> Provide a class defining your expected response structure.
 
 When added, this will result in a new entry under the `Assistant` heading in the log shortcut menu:
 

extensions/agroal/deployment/src/main/java/io/quarkus/agroal/deployment/devui/AgroalDevUIProcessor.java

@@ -47,6 +47,7 @@ void createBuildTimeActions(BuildProducer<BuildTimeActionBuildItem> buildTimeAct
                     return assistant.assistBuilder()
                             .userMessage(ADD_DATA_MESSAGE)
                             .variables(p)
+                            .responseType(MoreDataResponse.class)
                             .assist();
                 }).build();
 
@@ -63,7 +64,10 @@ JsonRPCProvidersBuildItem createJsonRPCService() {
             Given the provided sql script:
             {{currentInsertScript}}
             Can you add 10 more inserts into the script and return the result
-            (including the provided entries, so update the script)
-            Return the result in a field called `script`.
+            (including the provided entries, so update the script) in the script field.
             """;
+
+    final record MoreDataResponse(String script) {
+    }
+
 }

extensions/agroal/runtime-dev/src/main/java/io/quarkus/agroal/runtime/dev/ui/DatabaseInspector.java

@@ -365,6 +365,7 @@ public CompletionStage<Map<String, String>> generateTableData(String datasource,
             if (matchingTable.isPresent()) {
                 return assistant.get().assistBuilder()
                         .userMessage(generateInsertPrompt(matchingTable.get(), rowCount))
+                        .responseType(InsertStatementResponse.class)
                         .assist();
             }
         }
@@ -377,6 +378,7 @@ public CompletionStage<Map<String, String>> englishToSQL(String datasource, Stri
 
             return assistant.get().assistBuilder()
                     .userMessage(englishToSqlPrompt(tables, schema, name, english))
+                    .responseType(EnglishToSQLResponse.class)
                     .assist();
 
         }
@@ -509,7 +511,7 @@ private boolean isBinary(int dataType) {
 
     private String englishToSqlPrompt(List<Table> tables, String schema, String name, String english) {
         StringBuilder sb = new StringBuilder();
-        sb.append("Generate valid SQL given the following english statement: ")
+        sb.append("Generate valid SQL given the following english statement: \n")
                 .append(english)
                 .append("\n\nAnd this is the known tables in the database:\n");
 
@@ -606,4 +608,10 @@ private static record Datasource(String name, String jdbcUrl, boolean isDefault)
     private static record DataSet(List<String> cols, List<Map<String, String>> data, String error, String message,
             int totalNumberOfElements) {
     }
+
+    final record EnglishToSQLResponse(String sql, String error) {
+    }
+
+    final record InsertStatementResponse(String script) {
+    }
 }

extensions/assistant/runtime-dev/src/main/java/io/quarkus/assistant/runtime/dev/Assistant.java

@@ -45,7 +45,7 @@ <T> CompletionStage<T> exception(Optional<String> systemMessage, String userMess
      */
     <T> CompletionStage<T> assist(Optional<String> systemMessageTemplate,
             String userMessageTemplate,
-            Map<String, String> variables, List<Path> paths);
+            Map<String, String> variables, List<Path> paths, Class<?> responseType);
 
     default ExceptionBuilder exceptionBuilder() {
         return new ExceptionBuilder(this);
@@ -62,6 +62,7 @@ class AssistBuilder {
         private String userMessage;
         private final Map<String, String> variables = new LinkedHashMap<>();
         private final List<Path> paths = new ArrayList<>();
+        private Class<?> responseType = null;
 
         AssistBuilder(Assistant assistant) {
             this.assistant = assistant;
@@ -105,12 +106,19 @@ public AssistBuilder addPath(Path path) {
             return this;
         }
 
+        public AssistBuilder responseType(Class<?> responseType) {
+            if (responseType != null) {
+                this.responseType = responseType;
+            }
+            return this;
+        }
+
         @SuppressWarnings("unchecked")
         public <T> CompletionStage<T> assist() {
-            if (userMessage == null || userMessage.isBlank()) {
+            if (null == userMessage || userMessage.isBlank()) {
                 throw new IllegalStateException("User message is required");
             }
-            return (CompletionStage<T>) assistant.assist(systemMessage, userMessage, variables, paths);
+            return (CompletionStage<T>) assistant.assist(systemMessage, userMessage, variables, paths, responseType);
         }
     }
 

extensions/devui/resources/src/main/resources/dev-ui/qwc/qwc-workspace.js

@@ -512,6 +512,15 @@ export class QwcWorkspace extends observeState(QwcHotReloadElement) {
             }
             this._showActionProgress = false;
             document.body.style.cursor = 'default';
+        }).catch((err) => {
+            console.error(err);
+            this._showActionProgress = false;
+            document.body.style.cursor = 'default';
+            if(err.error.message){
+                notifier.showErrorMessage(err.message + ". Please check your logs.");
+            }else {
+                notifier.showErrorMessage("An error occured. Please check your logs.");
+            }
         });
     }
 

extensions/scheduler/deployment/src/main/java/io/quarkus/scheduler/deployment/devui/SchedulerDevUIProcessor.java

@@ -54,6 +54,7 @@ void createBuildTimeActions(BuildProducer<BuildTimeActionBuildItem> buildTimeAct
                     return assistant.assistBuilder()
                             .userMessage(INTERPRET_CRON)
                             .variables(p)
+                            .responseType(InterpretResponse.class)
                             .assist();
                 }).build();
 
@@ -65,6 +66,7 @@ void createBuildTimeActions(BuildProducer<BuildTimeActionBuildItem> buildTimeAct
                     return assistant.assistBuilder()
                             .userMessage(CREATE_CRON)
                             .variables(p)
+                            .responseType(CronResponse.class)
                             .assist();
                 }).build();
 
@@ -77,15 +79,20 @@ JsonRPCProvidersBuildItem rpcProvider() {
     }
 
     private static final String INTERPRET_CRON = """
-            Can you please interpret this cron and describe it in plain English. Reply in markdown format in a field called markdown.
+            Can you please interpret this cron and describe it in plain English. Reply in markdown format in the markdown field.
 
             Here is the cron: {{cron}}
             """;
 
     private static final String CREATE_CRON = """
             Can you create a valid cron expression for the following description: {{description}}
 
-            Reply with the valid cron in a field called cron. Add an example on how to use this with the quarkus-scheduler extenion in a field called example. For the example please use markdown.
+            Reply with the valid cron in the cron field. Add an example in markdown format on how to use this with the quarkus-scheduler extension in the markdown field.
             """;
 
+    final record InterpretResponse(String markdown) {
+    }
+
+    final record CronResponse(String cron, String markdown) {
+    }
 }

extensions/scheduler/deployment/src/main/resources/dev-ui/qwc-scheduler-cron-builder.js

@@ -119,11 +119,8 @@ export class QwcSchedulerCronBuilder extends LitElement {
             this._createCronLoading = false;
             document.body.style.cursor = 'default';
             this._cron = jsonResponse.result.cron;
-            this._example = jsonResponse.result.example;
+            this._example = jsonResponse.result.markdown;
         });
     }
-    
-    
-    
 }
 customElements.define('qwc-scheduler-cron-builder', QwcSchedulerCronBuilder);

extensions/smallrye-graphql/runtime-dev/src/main/java/io/quarkus/smallrye/graphql/runtime/dev/GraphQLJsonRpcService.java

@@ -41,25 +41,35 @@ public CompletionStage<Map<String, String>> generateClient(String language, Stri
                     .addVariable("schemaDocument", schemaDocument)
                     .addVariable("language", language)
                     .addVariable("extraContext", extraContext)
+                    .responseType(GraphQLClientResponse.class)
                     .assist();
         }
         return CompletableFuture.failedStage(new RuntimeException("Assistant is not available"));
     }
 
     private static final String USER_MESSAGE = """
             Given the GraphQL Schema document :
+
+            ```json
             {{schemaDocument}}
+            ```
+
             Please generate a {{language}} Object that act as a client to all the operations in the schema.
             This {{language}} code must be able to be called like this (pseudo code):
+
             ```
             var stub = new ResourceNameHereClient();
             var response = stub.doOperation(someparam);
             ```
+
             Your reponse should only contain one field called `code` that contains a value with only the {{language}} code, nothing else, no explanation, and do not put the code in backticks.
             The {{language}} code must run and be valid.
-            Example response: {code: 'package foo.bar; // more code here'}
+
+            Example response: `{code: 'package foo.bar; // more code here'}`
 
             {{extraContext}}
             """;
 
+    final record GraphQLClientResponse(String code) {
+    }
 }

extensions/smallrye-openapi/runtime-dev/src/main/java/io/quarkus/smallrye/openapi/runtime/dev/OpenApiJsonRpcService.java

@@ -36,16 +36,22 @@ public CompletionStage<Map<String, String>> generateClient(String language, Stri
                     .addVariable("schemaDocument", schemaDocument)
                     .addVariable("language", language)
                     .addVariable("extraContext", extraContext)
+                    .responseType(OpenApiClientResponse.class)
                     .assist();
         }
         return CompletableFuture.failedStage(new RuntimeException("Assistant is not available"));
     }
 
     private static final String USER_MESSAGE = """
             Given the OpenAPI Schema document :
+
+            ```json
             {{schemaDocument}}
+            ```
+
             Please generate a {{language}} Object that act as a client to all the operations in the schema.
             This {{language}} code must be able to be called like this (pseudo code):
+
             ```
             var stub = new ResourceNameHereClient();
             var response = stub.doOperation(someparam);
@@ -54,8 +60,12 @@ public CompletionStage<Map<String, String>> generateClient(String language, Stri
             Don't use ResourceNameHereClient as the name for the generated code (it's just an example). Derive a sensible name from the schema provided.
             Your reponse should only contain one field called `code` that contains a value with only the {{language}} code, nothing else, no explanation, and do not put the code in backticks.
             The {{language}} code must run and be valid.
-            Example response: {code: 'package foo.bar; // more code here'}
+
+            Example response: `{code: 'package foo.bar; // more code here'}`
 
             {{extraContext}}
             """;
+
+    final record OpenApiClientResponse(String code) {
+    }
 }