Merge pull request #68 from glroland/main

Fixes and Improvements to Prompt Module

Author: danieloh30

content/modules/ROOT/assets/images/prompt/email_response_address.png

@@ -391,19 +391,6 @@ If you run into challenges while drafting the prompt, ask your instructor for as
 
 === Test emails to speed up prompt development
 
-[IMPORTANT]
-====
-If you haven't created *a new Gen AI email service* in the previous module yet, create the new email service by running the following magic bash script in VS Code terminal. If you're still running the Quarkus dev mode, open a new terminal window to run the script.
-
-[.console-input]
-[source,shell,subs="+attributes,macros+"]
-----
-sh ${PROJECT_SOURCE}/scripts/create-email-ai-service.sh
-----
-
-Access the https://parasol-app-{user}-dev-parasol-app-{user}-dev.{openshift_cluster_ingress_domain}[Parasol web page^],to verify the Gen AI email service. To access the email service, click on the `Email Generate` tab on the left and use it in the following sections:
-====
-
 ==== Generate an email for `new claim #1` to the [email protected]
 
 [.console-input]
@@ -536,6 +523,19 @@ image::prompt/output_example_existing_2.png[output_example_existing_2]
 
 Now that you've developed a working prompt that can help satisfy leadership objectives with its first Generative AI initiative, you need to incorporate this logic into the Parasol Insurance application so that ongoing business value may be realized.  For this exercise that involves updating the Email Response REST service and UI to provide an recommended recipient, email subject, and automated response based on a given customer email.
 
+[IMPORTANT]
+====
+If you haven't created *a new Gen AI email service* in the previous module yet, create the new email service by running the following magic bash script in VS Code terminal. If you're still running the Quarkus dev mode, open a new terminal window to run the script.
+
+[.console-input]
+[source,shell,subs="+attributes,macros+"]
+----
+sh ${PROJECT_SOURCE}/scripts/create-email-ai-service.sh
+----
+
+Access the https://parasol-app-{user}-dev-parasol-app-{user}-dev.{openshift_cluster_ingress_domain}[Parasol web page^],to verify the Gen AI email service. To access the email service, click on the `Email Generate` tab on the left and use it in the following sections:
+====
+
 === Integrate Prompt with the Parasol Insurance Application
 
 Now that we've developed a robust prompt that helps address the Parasol Insurance use case for email handling, we must integrate that prompt into the Parasol application.
@@ -666,16 +666,23 @@ Add the following html to the `email-response` div block:
             </div>
 ----
 
-image::prompt/email_response_addresse.png[email_response_addresse]
+image::prompt/email_response_address.png[email_response_address]
 
 Additionally, we must add the address field to the REST Service's JSON Response.
 
-Open the `src/main/java/org/parasol/model/EmailResponse.java` file to `replace` the constructor with the following code.
+Open the `src/main/java/org/parasol/model/EmailResponse.java` file and `replace` the Java record signature with the following code.
+
+[IMPORTANT]
+====
+The new field you are adding for email address must be first in the EmailResponse method signature.
+
+LangChain4j uses this to suggest JSON response syntax to the LLM and our examples in the system prompt have the email address first in the response.  If the examples do not match LangChain4j's suggestion, the effect is that email address is sometimes left off the response and will be blank in the UI.
+====
 
 [.console-input]
 [source,java,subs="+attributes,macros+"]
 ----
-public record EmailResponse(String subject, String message, String address) { }
+public record EmailResponse(String address, String subject, String message) { }
 ----
 
 image::prompt/new-field-added-to-email-response.png[Add "address" field to EmailResponse Record]