WMS 11885: Build a Better ChatBot LiveLab - typos corrections to the documentation (#546)

* init new workshop

Signed-off-by: Mark Nelson <[email protected]>

* 1st edit

* renamed .md

* Update manifest.json

* ToC

* refactoring

* refactoring

* set OCI credentials added

* Lab 1 Update

* Lab 1 update

* Lab 2 updated

* Lab 5 updated

* Lab 5 updated

* Lab 5 updated

* Lab 5 updated

* Update testbed.png

* Update evaluating.md

* Objectives updated

* Intros updated

* Lab 6 updated

* Title updated

* lab 3 updated

* Update RAG.md

* Update RAG.md

* changed images directory

* Add .gitkeep to track images folder

* Add files via upload

* updated introduction

* Update get-started.md

* Update get-started.md

* updated get-started

* updated introduction and get started

* general update

* updated api-server

* Update server.md

* Update server.md

* corrections

* updated explore.md

* Update explore.md

* Update explore.md

* Update explore.md

* updated evaluating.md

* generic updateds

* corrections

* corrected typos

* Update introduction.md

* references update

* update acknowledgments

* updated source document

* Add files via upload

* source document related content changed

* Add files via upload

* updated RAG.md

* Update server.md

* Update experimenting.md

* help.md created

* minor fixes

* Add files via upload

* general review

* estimated times for lab1&lab2

* estimated times added to lab3-6

* General updates

* alias podman=docker added

* Update get-started.md

* volume version+OCI credentials as optional

* Update introduction.md

* Update get-started.md

* Update get-started.md

* Update get-started.md

* copy button added

* note indentation added

* Update explore.md

* Create getting_started-30_testset.json

* updates

* updates to 1.1

* re-directoring

* clean-up

* test

* refactoring

* Update manifest.json

* Update manifest.json

* updated explore.md

* updated explore.md

* updated prepare.md

* updated rag.md

* updated explore.md

* Update explore.md

* Update explore.md

* prepare.md adapted for Sandbox version

* updated introduction.md and server.md for sanbox version

* Rename sandbox to tenancy

* spelling and linting

* Adding deploy section

* Deploy using IaC

* cleanup and fixes

* linting, spelling

* minor changes

* typo fix

* linting

* numbers

* desktop linting, spelling

* lint

* manifest update

* updates

* manifest updates

* Corrected typos

* Update evaluating.md

* numbered list corrected

* typos corrected

---------

Signed-off-by: Mark Nelson <[email protected]>
Co-authored-by: Mark Nelson <[email protected]>
Co-authored-by: Andy Tael <[email protected]>

Author: 3 people

ai-optimizer/tenancy/deploy/deploy.md

@@ -22,7 +22,7 @@ This lab assumes you have:
 
 ## Task 1: Start the Oracle Resource Manager job
 
-1. Got to the [Oracle AI Optimizer and Toolkit GitHub](https://github.com/oracle-samples/ai-optimizer).
+1. Go to the [Oracle AI Optimizer and Toolkit GitHub](https://github.com/oracle-samples/ai-optimizer).
 
 1. Click on the **Deploy to Oracle Cloud** Button. This will take you to the **Create Stack** page in Oracle Cloud.
 

ai-optimizer/tenancy/evaluating/evaluating.md

@@ -46,8 +46,8 @@ The AI Optimizer allows you to generate as many questions and answers as you nee
 
 1. Leave the default option for:
 
-* Q&A Language Model: **gpt-4o-mini**
-* Q&A Embedding Model: **text-embedding-3-small**
+    * Q&A Language Model: **gpt-4o-mini**
+    * Q&A Embedding Model: **text-embedding-3-small**
 
 1. Click on **Generate Q&A** button and wait until the process is over:
 
@@ -81,10 +81,10 @@ Now you are ready to perform an evaluation on the Q&As you generated in the prev
 
 1. In the left-hand menu:
 
-* Under **Language Model Parameters**, select **gpt-4o-mini** from the **Chat model** dropdown list.
-* Ensure **Enable RAG?** is selected (if it wasn't already)
-* In the **Select Alias** dropdown list, choose the **TEST2** value.
-* Leave all other parameters unchanged
+    * Under **Language Model Parameters**, select **gpt-4o-mini** from the **Chat model** dropdown list.
+    * Ensure **Enable RAG?** is selected (if it wasn't already)
+    * In the **Select Alias** dropdown list, choose the **TEST2** value.
+    * Leave all other parameters unchanged
 
 1. With **gpt-4o-mini** selected as the evaluation model, click the **Start Evaluation** button and wait a few seconds. All questions from your dataset will be submitted to the chatbot using the configuration defined in the left pane:
 
@@ -96,10 +96,11 @@ Now you are ready to perform an evaluation on the Q&As you generated in the prev
 
   This section displays:
 
-* The chatbot's **Evaluation Settings**, as configured in the left-hand pane before launching the massive test.
-* The **RAG Settings** including the database and vector store used, the name of the embedding **model** used, and all associated parameters (e.g., **chunk size**, **top-k**).
-* The **Overall Correctness Score**, representing the percentage of questions for which the LLM judged the chatbot's response as correct compared to the reference answer
-* The **Correctness By Topic**, which breaks down the results based on the automatically generated topics assigned to each Q&A pair in the dataset.
+  * The chatbot's **Evaluation Settings**, as configured in the left-hand pane before launching the massive test.
+  * The **RAG Settings** including the database and vector store used, the name of the embedding **model** used, and all associated parameters (e.g., **chunk size**, **top-k**).
+  * The **Overall Correctness Score**, representing the percentage of questions for which the LLM judged the chatbot's response as correct compared to the reference answer
+  * The **Correctness By Topic**, which breaks down the results based on the automatically generated topics assigned to each Q&A pair in the dataset.
+
 
   The second section of the report contains details on each question submitted, with a focus on the **Failures** collection and the **Full Report** list. To view all fields, scroll horizontally. In the image below, the second frame has been scrolled to the right:
 

ai-optimizer/tenancy/explore/explore.md

@@ -31,14 +31,14 @@ Let's check if the DB is correctly connected.
 
 1. To configure the Oracle Database 23ai Free, you will need to enter the credentials:
 
-   * Enter the Database Username
-   * Enter the Database Connection String
-   * Enter the Database Password for the database user
-   * Save
-
-   Since you are following the Tenancy version of this LiveLab, you should find everything set-up already:
-
-   ![Database configuration](images/database-config.png)
+    * Enter the Database Username
+    * Enter the Database Connection String
+    * Enter the Database Password for the database user
+    * Save
+
+  Since you are following the Tenancy version of this LiveLab, you should find everything set-up already:
+  
+  ![Database configuration](images/database-config.png)
 
 1. Since you are using an Autonomous Database, you can activate the SelectAI functionality. You will need to create a [Select AI](https://www.oracle.com/it/autonomous-database/select-ai/) profile and eventually you'll find the list of active profiles within the tenancy:
 

ai-optimizer/tenancy/prepare/prepare.md

@@ -36,17 +36,17 @@ In the *Split/Embed* tab, the framework allows you to upload various types of do
 
   Additionally, you can select different distance metrics and index types to experiment with various vector representations of the same document, allowing you to identify the configuration that best meets your needs.
 
-3. Select your document source
+1. Select your document source
 
   Once the embedding model has been selected, scroll down to the *Load and Split Documents* section to upload the document you wish to store in your **Oracle Database 23ai**.
 
   ![populate-vector-store](images/populate-vector-store.png)
 
   You can choose from three different file sources:
 
-* **OCI**: Navigate through your tenancy to select documents from the Object Storage. Ensure that your OCI credentials are properly configured in advance.
-* **Local**: Upload a document directly from your local environment.
-* **Web**: Import a document from a publicly accessible web URL.
+    * **OCI**: Navigate through your tenancy to select documents from the Object Storage. Ensure that your OCI credentials are properly configured in advance.
+    * **Local**: Upload a document directly from your local environment.
+    * **Web**: Import a document from a publicly accessible web URL.
 
   In this example, we will embed a document from the web, available at [this link](https://docs.oracle.com/en/database/oracle/oracle-database/23/vecse/ai-vector-search-users-guide.pdf). We will give the alias ***TEST1*** to this vector store.