Merge pull request #50551 from phillip-kruger/assistant-hibernate

Hibernate assistant: use new response type

Author: phillip-kruger

extensions/hibernate-orm/runtime-dev/src/main/java/io/quarkus/hibernate/orm/dev/ui/HibernateOrmDevJsonRpcService.java

@@ -77,25 +77,38 @@ You are an expert in writing Hibernate Query Language (HQL) queries.
 
             {{metamodel}}
 
-            If a user asks a question that can be answered by querying this model, generate an HQL SELECT query.
-            The query must not include any input parameters.
-            Your response must only contain one field called `hql` containing the HQL query, nothing else, no explanation, and do not put the query in backticks.
-            Example response: {"hql": "select e from Entity e where e.property = :value"}
+
             """;
 
-    private static final String INTERACTIVE_PROMPT = """
+    private static final String ENGLISH_TO_HQL_USER_PROMPT = """
+                    If a user asks a question that can be answered by querying this model, generate an HQL SELECT query.
+                    The query must not include any input parameters.
+                    The field called `hql` should contain the HQL query, nothing else, no explanation, and do not put the query in backticks.
+                    Example hql field value: "select e from Entity e where e.property = :value"
+
+                    Here is the user input:
+            """;
+
+    static final record EnglishToHQLResponse(String hql) {
+    }
+
+    private static final String INTERACTIVE_USER_PROMPT = """
             The following HQL query:
             {{query}}
             returned the following data (in JSON format):
             {{data}}
 
             Based on the data above, answer this request in natural language:
+
             {{user_request}}
-            Your response must only contain one field called `answer` containing the natural language response.
+
+            The `naturalLanguageResponse` field should contain the natural language response.
             Do not include any HQL query in your response, nor suggest any further steps to take.
-            Example response: {"answer": "..."}
             """;
 
+    static final record InteractiveResponse(String naturalLanguageResponse) {
+    }
+
     /**
      * Execute an arbitrary {@code hql} query in the given {@code persistence unit}. The query might be both a selection or a
      * mutation statement. For selection queries, the result count is retrieved though a count query and the results, paginated
@@ -160,14 +173,15 @@ public CompletionStage<Map<String, String>> executeHQL(
 
             String metamodel = MetamodelJsonSerializerImpl.INSTANCE.toString(sf.getMetamodel());
 
-            CompletionStage<Map<String, String>> queryCompletionStage = a.assistBuilder()
+            CompletionStage<EnglishToHQLResponse> queryCompletionStage = a.assistBuilder()
                     .systemMessage(SYSTEM_MESSAGE)
-                    .userMessage(query)
+                    .userMessage(ENGLISH_TO_HQL_USER_PROMPT + query)
                     .addVariable("metamodel", metamodel)
+                    .responseType(EnglishToHQLResponse.class)
                     .assist();
 
             CompletionStage<DataSet> dataSetCompletionStage = queryCompletionStage.thenApply(response -> {
-                String hql = response.get("hql");
+                String hql = response.hql();
                 if (hql == null || hql.isBlank()) {
                     return new DataSet(null, null, -1, null, "The assistant did not return a valid HQL query.");
                 }
@@ -180,17 +194,18 @@ public CompletionStage<Map<String, String>> executeHQL(
                         // If there was an error executing the query, return it directly
                         return CompletableFuture.completedStage(toMap(dataSet));
                     }
-                    CompletionStage<Map<String, String>> interactiveCompletionStage = a.assistBuilder()
+                    CompletionStage<InteractiveResponse> interactiveCompletionStage = a.assistBuilder()
                             .systemMessage(SYSTEM_MESSAGE)
                             .addVariable("metamodel", metamodel)
-                            .userMessage(INTERACTIVE_PROMPT)
+                            .userMessage(INTERACTIVE_USER_PROMPT)
                             .addVariable("query", dataSet.query())
                             .addVariable("data", dataSet.data())
                             .addVariable("user_request", query)
+                            .responseType(InteractiveResponse.class)
                             .assist();
                     return interactiveCompletionStage.thenApply(response -> {
-                        String answer = response.get("answer");
-                        return messageDataset(dataSet.query(), answer, dataSet.resultCount());
+                        String naturalLanguageResponse = response.naturalLanguageResponse();
+                        return messageDataset(dataSet.query(), naturalLanguageResponse, dataSet.resultCount());
                     });
                 });
             } else {