10th Commit, favicon added, FastAPI back-end partially up.

README.md

@@ -1,43 +1,121 @@
 <!-- README.md -->
-# Agentic-Chat-bot-
-Agentic Chat-bot with RAG, Memory, and Privacy Considerations. 
+# Agentic Chatbot
 
-# Storefront Chatbot
+Agentic Chatbot with Retrieval-Augmented Generation (RAG), session memory, and privacy guardrails.  
+The project follows a **modular architecture** with:
+- Gradio UI for interactive demos
+- AIOHTTP backend with lightweight routes
+- Anonymous and logged-in flows
+- Guardrails for safety and PII redaction
+- Optional cloud providers (Azure, Hugging Face, OpenAI, Cohere, DeepAI)
 
-This repo follows a modular layout with a Gradio UI, NLU pipeline, anonymous and logged-in flows,
-guardrails, and optional Azure sentiment.
+---
 
 ## Quickstart
+
+Clone the repo, set up a venv, and install dependencies:
+
+```bash
+python -m venv .venv && source .venv/bin/activate
+pip install -r requirements.txt
+```
+
+Run in dev mode:
+
 ```bash
 make dev
 make run
-# open http://localhost:7860
+# open http://localhost:7860 (Gradio UI)
+```
+
+Or run the backend directly:
+
+```bash
+python app/app.py
+```
+
+---
+
+## Health Checks
+
+The AIOHTTP backend exposes simple endpoints:
+
+```bash
+curl http://127.0.0.1:3978/healthz
+# -> {"status":"ok"}
+
+curl -X POST http://127.0.0.1:3978/plain-chat   -H "Content-Type: application/json"   -d '{"text":"reverse hello"}'
+# -> {"reply":"olleh"}
 ```
 
+---
+
 ## Agentic Integration
-- Core bot: `agenticcore/chatbot/services.py`
-- Providers: `agenticcore/providers_unified.py`
-- CLI: `python -m agenticcore.cli agentic "hello"` (loads .env)
-- FastAPI demo: `uvicorn integrations.web.fastapi.web_agentic:app --reload`
-
-## Added Samples & Tests
-- chat.html → `app/assets/html/chat.html`
-- echo_bot.py → `integrations/botframework/bots/echo_bot.py`
-- ChatbotIntegration.ipynb → `notebooks/ChatbotIntegration.ipynb`
-- SimpleTraditionalChatbot.ipynb → `notebooks/SimpleTraditionalChatbot.ipynb`
-- smoke_test.py → `tests/smoke_test.py`
-- test_routes.py → `tests/test_routes.py`
-- quick_sanity.py → `tools/quick_sanity.py`
-- example.py → `examples/example.py`
-- service.py → `samples/service.py`
-- DEV_DOC.md → `docs/DEV_DOC.md`
-
-Run `pytest -q` for tests; open HTML in `app/assets/html/` to try local UIs.
-
-
----
-This is the **unified** storefront-chatbot bundle.
-Duplicates from earlier skeletons were removed; priority order was:
-1) storefront_chatbot_final_bundle
-2) storefront_chatbot_merged_with_agentic
-3) storefront_chatbot_skeleton
+
+- **Core bot:** `agenticcore/chatbot/services.py`  
+- **Providers:** `agenticcore/providers_unified.py`  
+- **CLI:** `python -m agenticcore.cli agentic "hello"` (loads `.env`)  
+- **FastAPI demo:**  
+  ```bash
+  uvicorn integrations.web.fastapi.web_agentic:app --reload --port 8000
+  ```
+
+---
+
+## Environment Variables
+
+Provider integrations are selected automatically, or you can pin one with `AI_PROVIDER`. Supported keys:
+
+- Hugging Face: `HF_API_KEY`, `HF_MODEL_SENTIMENT`
+- Azure: `MICROSOFT_AI_SERVICE_ENDPOINT`, `MICROSOFT_AI_API_KEY`
+- OpenAI: `OPENAI_API_KEY`
+- Cohere: `COHERE_API_KEY`
+- DeepAI: `DEEPAI_API_KEY`
+
+If no keys are set, the system falls back to **offline sentiment mode**.
+
+---
+
+## Samples & Tests
+
+- **UI samples:**  
+  - `app/assets/html/chat.html` – open in browser for local test  
+- **Bots:**  
+  - `integrations/botframework/bots/echo_bot.py`  
+- **Notebooks:**  
+  - `notebooks/ChatbotIntegration.ipynb`  
+  - `notebooks/SimpleTraditionalChatbot.ipynb`  
+- **Tests:**  
+  - `tests/smoke_test.py`  
+  - `tests/test_routes.py`  
+  - `tests/test_anon_bot.py`  
+- **Misc:**  
+  - `tools/quick_sanity.py`  
+  - `examples/example.py`  
+  - `samples/service.py`
+
+Run all tests:
+
+```bash
+pytest -q
+```
+
+---
+
+## Documentation
+
+- [Developer & Build/Test Guide](docs/Developer_Guide_Build_Test.md)
+
+---
+
+## Project Context
+
+This is the **unified storefront-chatbot bundle**. Earlier skeletons were merged and duplicates removed.  
+Priority order:  
+1. `storefront_chatbot_final_bundle`  
+2. `storefront_chatbot_merged_with_agentic`  
+3. `storefront_chatbot_skeleton`
+
+---
+
+_Developed for MSAI 631 – Human-Computer Interaction Group Project._

agenticcore/web_agentic.py

@@ -1,22 +1,51 @@
 # /agenticcore/web_agentic.py
 from fastapi import FastAPI, Query
-from fastapi.responses import HTMLResponse
+from fastapi.responses import HTMLResponse, FileResponse
+from fastapi.staticfiles import StaticFiles  # <-- ADD THIS
 from agenticcore.chatbot.services import ChatBot
+import pathlib
+import os
 
 app = FastAPI(title="AgenticCore Web UI")
 
-# 1. Simple HTML form at /
+# 1) Simple HTML form at /
 @app.get("/", response_class=HTMLResponse)
 def index():
     return """
-    <form action="/agentic" method="get">
+    <head>
+      <link rel="icon" type="image/png" href="/static/favicon.png">
+      <title>AgenticCore</title>
+    </head>
+    <form action="/agentic" method="get" style="padding:16px;">
         <input type="text" name="msg" placeholder="Type a message" style="width:300px">
         <input type="submit" value="Send">
     </form>
     """
 
-# 2. Agentic endpoint
+# 2) Agentic endpoint
 @app.get("/agentic")
 def run_agentic(msg: str = Query(..., description="Message to send to ChatBot")):
     bot = ChatBot()
     return bot.reply(msg)
+
+# --- Static + favicon setup ---
+
+# TIP: we're inside <repo>/agenticcore/web_agentic.py
+# repo root = parents[1]
+repo_root = pathlib.Path(__file__).resolve().parents[1]
+
+# Put static assets under app/assets/html
+assets_path = repo_root / "app" / "assets" / "html"
+assets_path_str = str(assets_path)
+
+# Mount /static so /static/favicon.png works
+app.mount("/static", StaticFiles(directory=assets_path_str), name="static")
+
+# Serve /favicon.ico (browsers request this path)
+@app.get("/favicon.ico", include_in_schema=False)
+async def favicon():
+    png = assets_path / "favicon.ico"
+    if png.exists():
+        return FileResponse(str(ico), media_type="image/ico")
+    # Graceful fallback: return an empty 204 if icon missing
+    return HTMLResponse(status_code=204, content="")

docs/DEV_DOC.md

@@ -1,5 +1,4 @@
-<!-- /docs/slides/DEV_DOC.md -->
-
+<!-- /docs/DEV_DOC.md -->
 ## 3. Functional Requirements
 
 This section describes the functional requirements for connecting a chatbot to an AI-as-a-Service (AIaaS) platform. It defines the expected system behavior, outlines constraints, and sets measurable acceptance criteria. Requirements are grouped into system context, core functions, supporting functions, and non-functional aspects.

docs/Developer_Guide_Build_Test.md

@@ -0,0 +1,121 @@
+<!-- /docs/Developer_Guide_Build_Test.md -->
+# Developer & Build/Test Guide
+
+## Purpose & Scope
+This document combines the Developer Guide and Build & Test Guide. It explains the repository structure, endpoints, CLI, providers, and step‑by‑step build/test instructions.
+
+---
+
+## Architecture Overview
+- **UI:** Gradio Blocks UI and plain HTML testers.
+- **Router/Logic:** Routes text to anon/logged-in/agentic paths.
+- **NLU:** Intent router and prompt manager.
+- **Memory:** Session handling and optional RAG retriever.
+- **Guardrails:** PII redaction and safety filters.
+- **Providers:** Cloud/offline AI providers.
+
+---
+
+## Repository Layout
+- `app/` – AIOHTTP server + UI components.
+- `anon_bot/` – Anonymous rule-based bot.
+- `logged_in_bot/` – Provider-backed logic.
+- `nlu/` – Pipeline, router, prompts.
+- `memory/` – Session store + retriever.
+- `guardrails/` – PII/safety enforcement.
+- `agenticcore/` – Unified provider integrations.
+
+---
+
+## Services & Routes
+- `GET /healthz` – health check.
+- `POST /plain-chat` – anon chat endpoint.
+- `POST /api/messages` – Bot Framework activities.
+- `GET /agentic` (FastAPI) – provider-backed demo.
+
+### Health Check Examples
+```bash
+curl http://127.0.0.1:3978/healthz
+curl -X POST http://127.0.0.1:3978/plain-chat -H "Content-Type: application/json" -d '{"text":"reverse hello"}'
+```
+
+---
+
+## CLI
+- `python -m agenticcore.cli agentic "hello"`
+- `python -m agenticcore.cli status`
+
+---
+
+## Providers
+Configured via environment variables (HF, Azure, OpenAI, Cohere, DeepAI). Offline fallback included.
+
+### Environment Variables
+- Hugging Face: `HF_API_KEY`, `HF_MODEL_SENTIMENT`
+- Azure: `MICROSOFT_AI_SERVICE_ENDPOINT`, `MICROSOFT_AI_API_KEY`
+- OpenAI: `OPENAI_API_KEY`
+- Cohere: `COHERE_API_KEY`
+- DeepAI: `DEEPAI_API_KEY`
+
+If no keys are set, the system falls back to **offline sentiment mode**.
+
+---
+
+## Build Instructions
+
+### Setup
+```bash
+python -m venv .venv && source .venv/bin/activate
+pip install -r requirements.txt
+```
+
+### Run AIOHTTP Backend
+```bash
+python app/app.py
+```
+
+### Run Gradio UI
+```bash
+export APP_MODE=gradio
+python app/app.py
+```
+
+### Run FastAPI Demo
+```bash
+uvicorn agenticcore.web_agentic:app --reload --port 8000
+```
+
+---
+
+## Testing
+
+### Automated Tests
+```bash
+pytest -q
+pytest -q tests/test_anon_bot.py
+pytest -q tests/test_routes.py
+```
+
+### Manual Tests
+```bash
+curl http://127.0.0.1:3978/healthz
+curl -X POST http://127.0.0.1:3978/plain-chat -H "Content-Type: application/json" -d '{"text":"reverse hello"}'
+```
+
+---
+
+## Troubleshooting
+- Missing provider keys → falls back to offline.
+- HTML tester fails → confirm backend running.
+- If provider calls fail → run CLI with `status` to confirm API keys.
+
+---
+
+## Security Defaults
+- No keys in repo.
+- Anon mode is offline.
+- Logged-in mode applies guardrails.
+
+---
+
+_Audience: Contributors & Developers_

docs/architecture.md

@@ -1,4 +1,4 @@
-<!-- /docs/slides/architecture.md -->
+<!-- /docs/architecture.md -->
 # Architecture
 
 This system follows a **modular chatbot architecture** built around a clear flow of data from the user interface to external services and back. The design emphasizes separation of concerns, allowing each module to handle a specific responsibility while keeping the overall system simple to test and extend.

docs/design.md

@@ -1,4 +1,4 @@
-<!-- /docs/slides/design.md -->
+<!-- /docs/design.md -->
 # Design Notes
 
 These notes document the reasoning behind major design choices, focusing on **API usage**, **security considerations**, and **tradeoffs** made during development.

docs/favicon.png~

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:54d47bcf0b688fd281e89f6931653e2cd5116c6930d2f3c4e911fc994a7b00ad
+size 1495668

scripts/run_backend.bat

@@ -0,0 +1,7 @@
+@echo off
+set APP_MODE=aiohttp
+set PORT=%1
+if "%PORT%"=="" set PORT=3978
+set HOST=%2
+if "%HOST%"=="" set HOST=127.0.0.1
+python app\app.py

scripts/run_backend.ps1

@@ -0,0 +1,8 @@
+param(
+  [string]$Port = "3978",
+  [string]$Host = "127.0.0.1"
+)
+$env:APP_MODE = "aiohttp"
+$env:PORT = $Port
+$env:HOST = $Host
+python app\app.py

scripts/run_fastapi.bat

@@ -0,0 +1,6 @@
+@echo off
+set PORT=%1
+if "%PORT%"=="" set PORT=8000
+set HOST=%2
+if "%HOST%"=="" set HOST=127.0.0.1
+uvicorn agenticcore.web_agentic:app --reload --host %HOST% --port %PORT%

scripts/run_fastapi.ps1

@@ -0,0 +1,5 @@
+param(
+  [string]$Port = "8000",
+  [string]$Host = "127.0.0.1"
+)
+uvicorn agenticcore.web_agentic:app --reload --host $Host --port $Port

scripts/run_gradio.bat

@@ -0,0 +1,7 @@
+@echo off
+set APP_MODE=gradio
+set PORT=%1
+if "%PORT%"=="" set PORT=7860
+set HOST=%2
+if "%HOST%"=="" set HOST=127.0.0.1
+python app\app.py

scripts/run_gradio.ps1

@@ -0,0 +1,8 @@
+param(
+  [string]$Port = "7860",
+  [string]$Host = "127.0.0.1"
+)
+$env:APP_MODE = "gradio"
+$env:PORT = $Port
+$env:HOST = $Host
+python app\app.py