From 7dbe4460b7a2bc0181cf767f36d5a59f7e79c453 Mon Sep 17 00:00:00 2001 From: Angel Lee Date: Mon, 29 Jul 2024 12:19:04 -0400 Subject: [PATCH] update document structure --- docs/01-Prepare/01-Data Preparation.mdx | 11 +++++++++ docs/01-Prepare/01-sample.mdx | 11 --------- docs/01-Prepare/02-Use Case Understanding.mdx | 11 +++++++++ docs/02-Create/01-Data Preprocessing.mdx | 23 +++++++++++++++++++ ...mdx => 02-Watson Discovery Setup copy.mdx} | 6 ++--- docs/02-Create/03-Watsonx Assistant Setup.mdx | 11 +++++++++ docs/03-Use Cases/01-Use Cases.mdx | 15 ++++++++++++ docs/03-Use Cases/01-sample.mdx | 9 -------- 8 files changed, 74 insertions(+), 23 deletions(-) create mode 100644 docs/01-Prepare/01-Data Preparation.mdx delete mode 100644 docs/01-Prepare/01-sample.mdx create mode 100644 docs/01-Prepare/02-Use Case Understanding.mdx create mode 100644 docs/02-Create/01-Data Preprocessing.mdx rename docs/02-Create/{01-sample.mdx => 02-Watson Discovery Setup copy.mdx} (66%) create mode 100644 docs/02-Create/03-Watsonx Assistant Setup.mdx create mode 100644 docs/03-Use Cases/01-Use Cases.mdx delete mode 100644 docs/03-Use Cases/01-sample.mdx diff --git a/docs/01-Prepare/01-Data Preparation.mdx b/docs/01-Prepare/01-Data Preparation.mdx new file mode 100644 index 0000000..3f75ac8 --- /dev/null +++ b/docs/01-Prepare/01-Data Preparation.mdx @@ -0,0 +1,11 @@ +--- +title: Data Preparation +description: Data Preparation +custom_edit_url: null +--- + +# Data Preparation + +- Staging work +- Setup +- Pre-requisites \ No newline at end of file diff --git a/docs/01-Prepare/01-sample.mdx b/docs/01-Prepare/01-sample.mdx deleted file mode 100644 index 0d9845c..0000000 --- a/docs/01-Prepare/01-sample.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Sample Page -description: sample page -custom_edit_url: null ---- - -# Sample Page - -- Staging work -- Setup -- Pre-requisites \ No newline at end of file diff --git a/docs/01-Prepare/02-Use Case Understanding.mdx b/docs/01-Prepare/02-Use Case Understanding.mdx new file mode 100644 index 0000000..1d5833d --- /dev/null +++ b/docs/01-Prepare/02-Use Case Understanding.mdx @@ -0,0 +1,11 @@ +--- +title: Use Case Understanding +description: Use Case Understanding +custom_edit_url: null +--- + +# Use Case Understanding + +- Staging work +- Setup +- Pre-requisites \ No newline at end of file diff --git a/docs/02-Create/01-Data Preprocessing.mdx b/docs/02-Create/01-Data Preprocessing.mdx new file mode 100644 index 0000000..910d27e --- /dev/null +++ b/docs/02-Create/01-Data Preprocessing.mdx @@ -0,0 +1,23 @@ +--- +title: Data Proprocessing +description: Data Proprocessing +custom_edit_url: null +--- + +# Data Proprocessing + +## 1. Introduction +Overview of data preprocessing for implemeting RAG. +## 2. Input Data +- Multiple Excel sheets with product information +- Columns: product numbers, names, and other relevant data +## 3. Data Merging +- Merging multiple Excel sheets into a single dataset +- Importance of data consistency and accuracy + - beware of Spaces in cell (e.g. "Yes" vs "Yes ") +## 4. Contextualizing Data for LLM and RAG +- Concatenating columns into a single paragraph to create a contextualized representation of product data +## 5. Preparing Data for Watson Discovery +- Saving data as CSV files as Watson Discovery separates each CSV row into independent documents +## 6. Conclusion +- Recap of data preprocessing steps \ No newline at end of file diff --git a/docs/02-Create/01-sample.mdx b/docs/02-Create/02-Watson Discovery Setup copy.mdx similarity index 66% rename from docs/02-Create/01-sample.mdx rename to docs/02-Create/02-Watson Discovery Setup copy.mdx index dea9742..e4938cd 100644 --- a/docs/02-Create/01-sample.mdx +++ b/docs/02-Create/02-Watson Discovery Setup copy.mdx @@ -1,10 +1,10 @@ --- -title: Sample Page -description: sample page +title: Watson Discovery Setup +description: Watson Discovery Setup custom_edit_url: null --- -# Sample Page +# Watson Discovery Setup Details regarding the technical solution. What did you do and how you did it. diff --git a/docs/02-Create/03-Watsonx Assistant Setup.mdx b/docs/02-Create/03-Watsonx Assistant Setup.mdx new file mode 100644 index 0000000..d8cee40 --- /dev/null +++ b/docs/02-Create/03-Watsonx Assistant Setup.mdx @@ -0,0 +1,11 @@ +--- +title: Watsonx Assistant Setup +description: Watsonx Assistant Setup +custom_edit_url: null +--- + +# Watsonx Assistant Setup + +Details regarding the technical solution. What did you do and how you did it. + +i.e. Deployment, installment, upgrade, configuration, automation. diff --git a/docs/03-Use Cases/01-Use Cases.mdx b/docs/03-Use Cases/01-Use Cases.mdx new file mode 100644 index 0000000..afc7f98 --- /dev/null +++ b/docs/03-Use Cases/01-Use Cases.mdx @@ -0,0 +1,15 @@ +--- +title: Use Cases +description: Use Cases +custom_edit_url: null +--- + +# Use Cases + +What are the use cases we delivered for the engagement? Explain the use cases in detail. +1. Product Related Questions + - Question and Answer using NeuralSeek RAG +2. Navigational Link + - dynamic links based on user input +3. Current Catalog Consumption + - display information and images of charts \ No newline at end of file diff --git a/docs/03-Use Cases/01-sample.mdx b/docs/03-Use Cases/01-sample.mdx deleted file mode 100644 index 6b8e374..0000000 --- a/docs/03-Use Cases/01-sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Sample Page -description: sample page -custom_edit_url: null ---- - -# Sample Page - -What are the use cases we delivered for the engagement? Explain the use cases in detail.