[Hack update] 068 - Open AI Apps

068-AzureOpenAIApps/.wordlist.txt

@@ -21,3 +21,4 @@ vectorized
 uploader
 Huachao
 queueing
+QEMU

068-AzureOpenAIApps/Coach/Solution-00.md

@@ -67,16 +67,36 @@ This information is subject to change over time, for the most up to date list of
 </details>
 
 ### Deployment
-Make sure the student uses the terminal window in GitHub Codespaces or the local workstation and **NOT** Azure Cloud Shell to do the deployment. If the student does the deployment from the Azure Cloud Shell by cloning the repo to the Cloud Shell and then running deployment script there, the `local.settings.json` file generated by the deployment script will be in the wrong place!  The student will either have to redeploy FROM their Codespace/Local Workstation or copy the `local.settings.json` for the `ContosoAIBackend` to their Codespace or local workstation manually FROM the Azure Cloud Shell if it ended up there. 
+Make sure the student uses the terminal window in GitHub Codespaces or the local workstation and **NOT** Azure Cloud Shell to do the deployment. If the student does the deployment from the Azure Cloud Shell by cloning the repo to the Cloud Shell and then running deployment script there, the `local.settings.json` file generated by the deployment script will be in the wrong place!  The student can run `genlocalsettings.sh` with the name of the resource group to create the local.settings.json in the correct environment. 
+
+Also, if a student edits the local.settings.json and accidentally removes a line or changes a value to an incorrect setting, they can re-run the `genlocalsettings.sh` script again to fix the problem. 
 
 ### Codespaces vs Local Workstation
 
-We **strongly** recommend students use GitHub Codespaces as their development environment over a local workstation.
+We recommend students use GitHub Codespaces as their development environment over a local workstation and is the only option if a student does not have admin privileges on their machine.
+
+Running a local Devcontainer will require Docker Desktop to be installed. 
+
+Students should avoid doing the local workstation setup natively in their OS (not in a container) because there is the potential to adversely affect their local workstation (especially if they accidentally change the default Python version on Linux/Mac/WSL). There can be a lot of variations in terms of the student's OS version, already installed software packages like Python, Node, etc. that may cause them to lose time trying to get their environment working. If they insist, they would need these software packages to be installed:
+
+- [Windows Subsystem for Linux](../../000-HowToHack/WTH-Common-Prerequisites.md#windows-subsystem-for-linux) (for Windows users)
+- [Azure CLI](../../000-HowToHack/WTH-Common-Prerequisites.md#azure-cli)
+- [Visual Studio Code](../../000-HowToHack/WTH-Common-Prerequisites.md#visual-studio-code)
 
->[!NOTE]
->As of July 2024, the Challenge 0 instructions for how to set up a local workstation have NOT been tested!
+**NOTE:** For Windows users, we recommend that the following tools be installed in their WSL environment, and NOT on Windows itself. (This includes the Azure CLI itself, which is listed above.) 
 
-Students should avoid doing the local workstation setup because there is the potential to adversely affect their local workstation (especially if they accidentally change the default Python version on Linux/Mac/WSL). There can be a lot of variations in terms of the student's OS version, already installed software packages like Python, Node, etc. that may cause them to lose time trying to get their environment working. 
+- [Node v20.11.0](https://nodejs.org/en/download) - Only v20.11.0
+- Make sure [NPM 10.2.4](https://nodejs.org/en/download) - Comes with Node Installation
+- Install [Angular CLI](https://angular.io/cli#installing-angular-cli) globally
+- Install the [Azure Functions Core Tools](https://www.npmjs.com/package/azure-functions-core-tools#installing) V4 Globally Using NPM
+- Install [Python 3.11](https://www.python.org/downloads/)
+- Install [Python Package Install PIP](https://pypi.org/project/pip/)
+- Create a Python virtual environment for Python 3.11 <br>
+  ```bash
+  python3.11 -m venv .venv
+  source .venv/bin/activate
+  python3.11 -m pip install --upgrade pip
+  ```
 
 #### CORS Error When Running the Front End App
 

068-AzureOpenAIApps/Coach/Solution-03.md

@@ -17,4 +17,22 @@ Note: When cleaning up the resource group or resource, you should ensure you del
 
 For the extraction make sure the student selects the answer and assigns it to the field rather than the question itself. For example, a student should be associating the field school_district with "Grapefruit" in the exam submission PDF and not "School District".
 
-Here is a sample prompt that the student can use to get back an exam submission: "My student ID is 1234568. I'm a registered student. Don't check if I'm a registered student. Can you tell me my grade on my last exam? I don't have the exam submission ID". It may take a few tries before you get the answer. 
+Here is a sample system prompt for Murphy that the student can use that will solve the "One moment please" issue:
+```text
+You are a customer service representative from the Contoso Islands School Board.
+
+Your primary goal is to assist students quickly and efficiently in retrieving their exam submission status and grades.
+
+1. Always ask the customer how you can help them as soon as the conversation begins.
+2. Promptly request the student id to verify if the student is registered. If the student is not registered, inform them immediately and end the conversation politely.
+3. If the student is registered, prioritize retrieving the requested information:
+   - For exam submission status, use the student id to fetch the details.
+   - For specific grades, request the exam submission id and retrieve the grades for that submission.
+4. Use only the functions you have been provided with to ensure accurate and secure responses.
+5. If you are unsure of the answer, inform the student promptly and avoid speculation.
+6. Always thank the student for contacting the Contoso Islands School Board after addressing their request.
+
+Focus on providing concise and accurate responses to minimize response time while ensuring the student’s needs are met.
+Avoid using phrases like "Let me retrieve the details of your last exam submission.
+One moment, please." Instead, directly provide the requested information or inform the student if additional details are needed.
+```

068-AzureOpenAIApps/Student/Challenge-00-lab.md

@@ -80,40 +80,27 @@ If you want to setup your environment on your local workstation, expand the sect
 <details markdown=1>
 <summary markdown="span">Click to expand/collapse Local Workstation Requirements</summary>
 
-To work on your local workstation, please ensure you have the following tools and resources before hacking:
-- [Windows Subsystem for Linux](../../000-HowToHack/WTH-Common-Prerequisites.md#windows-subsystem-for-linux)
-- [Managing Cloud Resources](../../000-HowToHack/WTH-Common-Prerequisites.md#managing-cloud-resources)
-  - [Azure Portal](../../000-HowToHack/WTH-Common-Prerequisites.md#azure-portal)
-  - [Azure CLI](../../000-HowToHack/WTH-Common-Prerequisites.md#azure-cli)
-    - [Note for Windows Users](../../000-HowToHack/WTH-Common-Prerequisites.md#note-for-windows-users)
-    - [Azure PowerShell CmdLets](../../000-HowToHack/WTH-Common-Prerequisites.md#azure-powershell-cmdlets)
-  - [Azure Cloud Shell](../../000-HowToHack/WTH-Common-Prerequisites.md#azure-cloud-shell)
-- [Visual Studio Code](../../000-HowToHack/WTH-Common-Prerequisites.md#visual-studio-code)
-
-**NOTE:** For Windows users, we recommend that the following tools be installed in your WSL environment, and NOT on Windows itself. (This includes the Azure CLI itself, which is listed above.) 
-
-- [Node v20.11.0](https://nodejs.org/en/download) - Only v20.11.0
-- Make sure [NPM 10.2.4](https://nodejs.org/en/download) - Comes with Node Installation
-- Install [Angular CLI](https://angular.io/cli#installing-angular-cli) globally
-- Install the [Azure Functions Core Tools](https://www.npmjs.com/package/azure-functions-core-tools#installing) V4 Globally Using NPM
-- Install [Python 3.11](https://www.python.org/downloads/)
-- Install [Python Package Install PIP](https://pypi.org/project/pip/)
-- Create a Python virtual environment for Python 3.11 <br>
-  ```bash
-  python3.11 -m venv .venv
-  source .venv/bin/activate
-  python3.11 -m pip install --upgrade pip
-  ```
-
-
 #### Student Resources
 
 The sample application code, Azure deployment scripts, and sample data sources for this hack are available in a Student Resources package.
 
-- [Download and unpack the Resources.zip](https://aka.ms/openaiapps/resources) package to your local workstation.
+- [Download and unpack the Resources.zip](https://aka.ms/wth/openaiapps/resources) package to your local workstation.
 
 The rest of the challenges will refer to the relative paths inside the `Resources.zip` file where you can find the various resources to complete the challenges.
 
+#### Set Up Local Dev Container
+
+You will next be setting up your local workstation so that it can use dev containers. A Dev Container is a Docker-based environment designed to provide a consistent and reproducible development setup. The VS Code Dev Containers extension lets you easily open projects inside a containerized environment. 
+
+**NOTE:** On Windows, Dev Containers run in the Windows Subsystem for Linux (WSL). As of May 2025, WSL on Windows ARM64 does not currently support running the Azure Function Core Tools needed for this hackathon in x86_64 emulation using QEMU. IF you are using a Windows on ARM device, you will need to use a GitHub Codespace instead.
+
+On Windows and Mac OS (**NOTE:** only tested on Apple Silicon):
+- Download and install Docker Desktop
+- (Mac OS only) In Docker Desktop settings, choose Apple Virtualization Framework for the Virtual Machine Manager. Also, click the checkbox to use Rosetta for x86_64/amd64 emulation on Apple Silicon
+- (Windows only) Install the Windows Subsystem for Linux along with a Linux distribution such as Ubuntu. You will need to copy the `Resources.zip` to your Linux home directory and unzip it there. 
+- Open the root folder of the Student resource package in Visual Studio Code
+- You should get prompted to re-open the folder in a Dev Container. You can do that by clicking the Yes button, but if you miss it or hit no, you can also use the Command Palette in VS Code and select `Dev Containers: Reopen in Container`
+
 </details>
 
 ### Setup Citrus Bus Application

068-AzureOpenAIApps/Student/Challenge-00-nolab.md

@@ -77,41 +77,28 @@ If you want to setup your environment on your local workstation, expand the sect
 
 <details markdown=1>
 <summary markdown="span">Click to expand/collapse Local Workstation Requirements</summary>
-
-To work on your local workstation, please ensure you have the following tools and resources before hacking:
-- [Windows Subsystem for Linux](../../000-HowToHack/WTH-Common-Prerequisites.md#windows-subsystem-for-linux)
-- [Managing Cloud Resources](../../000-HowToHack/WTH-Common-Prerequisites.md#managing-cloud-resources)
-  - [Azure Portal](../../000-HowToHack/WTH-Common-Prerequisites.md#azure-portal)
-  - [Azure CLI](../../000-HowToHack/WTH-Common-Prerequisites.md#azure-cli)
-    - [Note for Windows Users](../../000-HowToHack/WTH-Common-Prerequisites.md#note-for-windows-users)
-    - [Azure PowerShell CmdLets](../../000-HowToHack/WTH-Common-Prerequisites.md#azure-powershell-cmdlets)
-  - [Azure Cloud Shell](../../000-HowToHack/WTH-Common-Prerequisites.md#azure-cloud-shell)
-- [Visual Studio Code](../../000-HowToHack/WTH-Common-Prerequisites.md#visual-studio-code)
-
-**NOTE:** For Windows users, we recommend that the following tools be installed in your WSL environment, and NOT on Windows itself. (This includes the Azure CLI itself, which is listed above.) 
-
-- [Node v20.11.0](https://nodejs.org/en/download) - Only v20.11.0
-- Make sure [NPM 10.2.4](https://nodejs.org/en/download) - Comes with Node Installation
-- Install [Angular CLI](https://angular.io/cli#installing-angular-cli) globally
-- Install the [Azure Functions Core Tools](https://www.npmjs.com/package/azure-functions-core-tools#installing) V4 Globally Using NPM
-- Install [Python 3.11](https://www.python.org/downloads/)
-- Install [Python Package Install PIP](https://pypi.org/project/pip/)
-- Create a Python virtual environment for Python 3.11 <br>
-  ```bash
-  python3.11 -m venv .venv
-  source .venv/bin/activate
-  python3.11 -m pip install --upgrade pip
-  ```
 
-
 #### Student Resources
 
 The sample application code, Azure deployment scripts, and sample data sources for this hack are available in a Student Resources package.
 
-- [Download and unpack the Resources.zip](https://aka.ms/openaiapps/resources) package to your local workstation.
+- [Download and unpack the Resources.zip](https://aka.ms/wth/openaiapps/resources) package to your local workstation.
 
 The rest of the challenges will refer to the relative paths inside the `Resources.zip` file where you can find the various resources to complete the challenges.
 
+#### Set Up Local Dev Container
+
+You will next be setting up your local workstation so that it can use dev containers. A Dev Container is a Docker-based environment designed to provide a consistent and reproducible development setup. The VS Code Dev Containers extension lets you easily open projects inside a containerized environment. 
+
+**NOTE:** On Windows, Dev Containers run in the Windows Subsystem for Linux (WSL). As of May 2025, WSL on Windows ARM64 does not currently support running the Azure Function Core Tools needed for this hackathon in x86_64 emulation using QEMU. IF you are using a Windows on ARM device, you will need to use a GitHub Codespace instead.
+
+On Windows and Mac OS (**NOTE:** only tested on Apple Silicon):
+- Download and install Docker Desktop
+- (Mac OS only) In Docker Desktop settings, choose Apple Virtualization Framework for the Virtual Machine Manager. Also, click the checkbox to use Rosetta for x86_64/amd64 emulation on Apple Silicon
+- (Windows only) Install the Windows Subsystem for Linux along with a Linux distribution such as Ubuntu. You will need to copy the `Resources.zip` to your Linux home directory and unzip it there. 
+- Open the root folder of the Student resource package in Visual Studio Code
+- You should get prompted to re-open the folder in a Dev Container. You can do that by clicking the Yes button, but if you miss it or hit no, you can also use the Command Palette in VS Code and select `Dev Containers: Reopen in Container`
+
 </details>
 
 ### Setup Citrus Bus Application

068-AzureOpenAIApps/Student/Challenge-02.md

@@ -53,9 +53,9 @@ In this challenge, you will be asked to configure the system message and tools u
 
 #### Configuring Your Virtual Assistants
 
- In your `/ContosoAIAppsBackend` folder there is an `/assistant_configurations` folder that contains two files: one json and one text file
+ In your `/ContosoAIAppsBackend` folder there is an `/assistant_configurations` folder that contains two files: one JSON and one text file. 
 
- The text file (`.txt`) shares the same name as the AI assistant and this is where you enter the system message instructing the AI assistant how it should behave.
+ The text file (`.txt`) shares the same name as the AI assistant and this is where you enter the system message instructing the AI assistant how it should behave. You should be modifying each text file using the description of what each assistant does (hint: they are each described above).
 
  The JSON file (`.json`) share the same name as the AI assistant and this is where we define all the tools that the AI assistant is going to use when interacting with the users.
 
@@ -175,8 +175,8 @@ Once you have proved the backend is responding properly using the REST Client, y
 
 To complete the challenge successfully, the solution should demonstrate the following:
 - Ensure that the application is able to handle the natural language inputs from the customer
-- Configure the assistants that receives that question/query from the customer and responses.
-- The assistant should be able to keep track of the conversation history during the session and remember important details about the customer making the inquiry or reservation. This should be true for at least the last 3 to 5 sentences input from the customer. 
+- Configure the assistants that receives that question/query from the customer and responses
+- The assistant should be able to keep track of the conversation history during the session and remember important details about the customer making the inquiry or reservation. This should be true for at least the last 3 to 5 sentences input from the customer
 - The virtual assistant should be able to handle natural language inputs and be trained to understand different variations of the questions related to the tour status. 
 - It should also be able to all the scenarios identified as capabilities for each assistant
 - For read/write scenarios, the changes requested by the customer/user should be captured and saved correctly to the databases.

068-AzureOpenAIApps/Student/Challenge-03.md

@@ -168,6 +168,8 @@ Once you have verified that these documents have been parsed and the data has be
 - Murphy: answers questions about exams, grades and exam submissions from students.
 - Priscilla: answers questions about things to do on Contoso Islands as well as make recommendations to guests based on their activity preferences.
 
+When working with the assistants, you may get a response that says something like "One moment, please. I’ll retrieve the details for you now". If that happens, you can try your prompt again. However, a better way would be to change the system prompt so that doesn't happen. Can you think of a way to modify the system prompt to prevent that? Alternatively, ask your coach for a system prompt that avoids you having to wait if you are running short on time. 
+
 ## Success Criteria
 
 During this challenge you will:

068-AzureOpenAIApps/Student/Resources/ContosoAIAppsBackend/.gitignore

@@ -168,3 +168,5 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+.python_packages

068-AzureOpenAIApps/Student/Resources/ContosoAIAppsBackend/document-intelligence-dictionary.json.example

@@ -9,10 +9,10 @@
       "school_district": "school_district",
       "school_name": "school_name",
       "exam_date": "exam_date",
-      "question_1": "q1",
-      "question_2": "q2",
-      "question_3": "q3",
-      "question_4": "q4"
+      "question_1": "question_1",
+      "question_2": "question_2",
+      "question_3": "question_3",
+      "question_4": "question_4"
     }
   },
   {
@@ -25,10 +25,10 @@
       "school_district": "school_district",
       "school_name": "school_name",
       "exam_date": "exam_date",
-      "question_1": "q1",
-      "question_2": "q2",
-      "question_3": "q3",
-      "question_4": "q4"
+      "question_1": "question_1",
+      "question_2": "question_2",
+      "question_3": "question_3",
+      "question_4": "question_4"
     }
   },
   {
@@ -41,11 +41,11 @@
       "school_district": "school_district",
       "school_name": "school_name",
       "exam_date": "exam_date",
-      "question_1": "q1",
-      "question_2": "q2",
-      "question_3": "q3",
-      "question_4": "q4",
-      "question_5": "q5"
+      "question_1": "question_1",
+      "question_2": "question_2",
+      "question_3": "question_3",
+      "question_4": "question_4",
+      "question_5": "question_5"
     }
   },
   {