Updated README.md

Author: harshitjain17

README.md

@@ -1,7 +1,7 @@
 # JobAssist AI  
 **Empowering Coaches, Transforming Lives**  
 
-[![Deployed on Azure](https://img.shields.io/badge/Deployed%20on-Azure-blue?logo=microsoft-azure)](https://jobassistai-dhbzhtbxerdwedhh.eastus2-01.azurewebsites.net/)  
+![Deployed on Azure](https://img.shields.io/badge/Deployed%20on-Azure-blue?logo=microsoft-azure)  
 *Built for the Microsoft Innovation Challenge, March 2025*  
 
 ---
@@ -14,8 +14,6 @@ By facilitating job matching in sectors such as retail, healthcare, IT, and manu
 
 Developed as part of the **Microsoft Innovation Challenge in March 2025**, this Flask-based application harnesses Azure's advanced AI and cloud capabilities to address pressing real-world challenges. JobAssist AI reflects a commitment to inclusion, transforming it from an aspiration into actionable impact.
 
-**[Try it live here!](https://jobassistai-dhbzhtbxerdwedhh.eastus2-01.azurewebsites.net/)**  
-
 ---
 
 ## 🌟 The Problem We’re Solving  
@@ -37,16 +35,16 @@ JobAssist AI redefines this landscape by automating repetitive tasks, centralizi
 - **How**: Azure AI Search and OpenAI analyze stored guidelines in Blob Storage.
 - **Impact**: Minimizes administrative stress, keeping the focus on clients.
 
-### 2. Automated Documentation  
-- **What:** Upload notes, receive polished reports.  
-- **How:** Azure AI Document Intelligence extracts text, Azure OpenAI (GPT-4o) crafts HTML reports, and PDFs are stored in Blob Storage.  
-- **Impact:** Reduces paperwork time significantly, freeing coaches for client advocacy.
-
-### 3. Centralized Knowledge Base  
+### 2. Centralized Knowledge Base  
 - **What:** A comprehensive repository of strategies and contacts.  
 - **How:** Coaches log insights into Azure Cosmos DB; Azure AI Search enables instant retrieval.  
 - **Impact:** Preserves expertise, even as team members change.
 
+### 3. Automated Documentation  
+- **What:** Upload notes, receive polished reports.  
+- **How:** Azure AI Document Intelligence extracts text, Azure OpenAI (GPT-4o) crafts HTML reports, and PDFs are stored in Blob Storage.  
+- **Impact:** Reduces paperwork time significantly, freeing coaches for client advocacy.
+
 ### 4. Personalized Task Guidance  
 - **What:** Detailed, step-by-step task guides customized for each client.  
 - **How:** Azure OpenAI generates instructions; Azure Speech Services provides audio for accessibility.  
@@ -67,9 +65,35 @@ JobAssist AI integrates a robust set of Azure services with a Flask frontend:
 - **Azure Functions**: Workflow automation.
 - **Azure Key Vault**: Secures sensitive credentials.
 
-### System Architecture Diagram  
+### System Architecture Diagrams
+
+#### Overall System Architecture
+The following diagram provides a high-level overview of JobAssist AI’s architecture:
 ![JobAssist AI System Architecture](docs/JobAssistAI-system-architecture.png)
 
+#### Feature-Specific Architectures  
+Below are detailed architecture diagrams for each key feature, illustrating their specific workflows:
+
+- **AI Assistant**  
+  This diagram shows how Azure AI Search and Azure OpenAI work together to provide real-time answers to compliance questions by analyzing guidelines stored in Blob Storage.  
+  ![AI Assistant Architecture](docs/JobAssistAI-system-architecture-ai-assistant.png)
+
+- **Automated Documentation**  
+  This diagram illustrates the flow of handwritten notes through Azure AI Document Intelligence for text extraction, Azure OpenAI (GPT-4o) for report generation, and Blob Storage for storing the final PDFs.  
+  ![Document Processing Architecture](docs/JobAssistAI-system-architecture-document-processing.png)
+
+- **Centralized Knowledge Base**  
+  This diagram depicts how coaches log insights into Azure Cosmos DB, with Azure AI Search enabling instant retrieval for a comprehensive repository of strategies and contacts.  
+  ![Knowledge Base Architecture](docs/JobAssistAI-system-architecture-knowledge-base.png)
+
+- **Save Voice Insights**  
+  This diagram outlines the process of transcribing audio files, categorizing insights, and saving them in Azure Cosmos DB for AI-powered searches, supporting formats like WAV, MP3, OGG, and FLAC.  
+  ![Save Voice Insights Architecture](docs/JobAssistAI-system-architecture-save-voice-insights.png)
+
+- **Personalized Task Guidance**  
+  This diagram shows how Azure OpenAI generates step-by-step task instructions from user input, with Azure Speech Services providing audio output for accessibility.  
+  ![Task Breakdown Architecture](docs/JobAssistAI-system-architecture-task-breakdown.png)
+
 ---
 
 ## 📂 Project Structure  
@@ -105,24 +129,34 @@ JobAssistAI/
 ## 🔧 Azure Functions Deep Dive  
 
 ### `jobassistai-document-processing`  
-**Purpose**: Turns handwritten notes into polished PDFs.  
-- **Flow**: Extracts text → Generates HTML reports → Converts to PDF → Stores in Blob Storage.  
-- **Diagram**: *[Insert architecture diagram here]*  
+- **Purpose**: Turns handwritten notes into polished PDFs.  
+- **Flow**: Extracts text → Generates HTML reports → Converts to PDF → Stores in Blob Storage.
 - **Details**: See [its README](azure-functions/jobassistai-document-processing/README.md).  
 
 ### `jobassistai-http-trigger-openai`  
-**Purpose**: Powers AI responses with OpenAI + optional Azure Search citations.  
-- **Flow**: Takes user prompts → Fetches system prompts → Returns JSON responses.  
-- **Diagram**: *[Insert architecture diagram here]*  
+- **Purpose**: Powers AI responses with OpenAI + optional Azure Search citations.  
+- **Flow**: Takes user prompts → Fetches system prompts → Returns JSON responses.
 - **Details**: See [its README](azure-functions/jobassistai-http-trigger-openai/README.md).  
 
 ### `jobassistai-http-trigger-tts`  
-**Purpose**: Converts text instructions to audio with Azure SpeechSDK.  
-- **Flow**: Accepts JSON text → Outputs MP3 audio.  
-- **Diagram**: *[Insert architecture diagram here]*  
+- **Purpose**: Converts text instructions to audio with Azure SpeechSDK.  
+- **Flow**: Accepts JSON text → Outputs MP3 audio.
 - **Details**: See [its README](azure-functions/jobassistai-http-trigger-tts/README.md).  
 
-*More functions (`save-insights`, `save-voice-insights`, `search-insights`) coming soon!*  
+### `jobassistai-save-insights` 
+- **Purpose**: Saves insights in Azure Cosmos DB for AI powered searches.
+- **Flow**: Accepts JSON text → Outputs response message in text format.
+- **Details**: See [its README](azure-functions/jobassistai-save-insights/README.md).
+
+### `jobassistai-save-voice-insights` 
+- **Purpose**: Transcribes the audio files, categorize text to insights (category and details) and save in Azure Cosmos DB for AI powered searches.
+- **Flow**: Accepts audio in `WAV`, `MP3`, `OGG` and `FLAC` format and returns response message in text format.
+- **Details**: See [its README](azure-functions/jobassistai-save-voice-insights/README.md).
+
+### `jobassistai-search-insights` 
+- **Purpose**: Converts natural language queries to embeddings and uses Azure AI Search & Azure OpenAI to retrieve relevant information.
+- **Flow**: Accepts search query in JSON format and returns relevant insights in JSON format.
+- **Details**: See [its README](azure-functions/jobassistai-search-insights/README.md).
 
 ---
 
@@ -143,8 +177,8 @@ We’re committed to ethical AI. For a detailed look at how JobAssist AI upholds
 ### Steps  
 1. **Clone the Repo**  
    ```bash
-   git clone https://github.com/yourusername/jobassistai.git
-   cd jobassistai
+   git clone https://github.com/harshitjain17/JobAssist-AI.git
+   cd JobAssist-AI
 2. **Set Up Virtual Environment**
    ```bash
    python -m venv venv
@@ -156,10 +190,18 @@ We’re committed to ethical AI. For a detailed look at how JobAssist AI upholds
 4. **Configure Environment Variables**
    Create a .env file in the root directory:
    ```bash
-   AZURE_STORAGE_CONNECTION_STRING="your_connection_string"
-   AZURE_OPENAI_KEY="your_openai_key"
-   AZURE_COSMOS_ENDPOINT="your_cosmos_endpoint"
-   AZURE_SEARCH_KEY="your_search_key"
+   AZURE_STORAGE_CONNECTION_STRING="your_connection_string" # Connection string for Azure Blob Storage
+   AZURE_OPENAI_KEY="your_openai_key"                       # API key for Azure OpenAI to enable GPT-4o
+   AZURE_COSMOS_ENDPOINT="your_cosmos_endpoint"             # Endpoint URL for Azure Cosmos DB
+   AZURE_SEARCH_KEY="your_search_key"                       # API key for Azure AI Search
+   FUNCTION_HTTP_OPENAI_URL=""                              # URL for the Azure Function handling OpenAI-powered responses
+   FUNCTION_HTTP_OPENAI_WITH_INDEX_URL=""                   # URL for the Azure Function handling OpenAI responses with Azure Search citations
+   FUNCTION_HTTP_TEXT_TO_SPEECH_URL=""                      # URL for the Azure Function converting text to speech
+   FUNCTION_SAVE_INSIGHTS_URL=""                            # URL for the Azure Function saving insights to Azure Cosmos DB
+   FUNCTION_COSMOSDB_URL=""                                 # URL for the Azure Function interacting with Azure Cosmos DB for data operations
+   FUNCTION_SEARCH_INSIGHTS_URL=""                          # URL for the Azure Function handling search queries to retrieve insights
+   SYSTEM_ROLE_TASKBREAKDOWN="taskbreakdown"                # System role identifier for task breakdown feature to customize OpenAI behavior
+   SYSTEM_ROLE_CHAT="chat"                                  # System role identifier for chat feature to customize OpenAI behavior
 5. **Run Locally**
    ```bash
    python app.py  # Flask app