nothingworry commited on
Commit
f5cdb7d
Β·
1 Parent(s): 345b8ff

update the readme file

Browse files
Files changed (1) hide show
  1. README.md +19 -7
README.md CHANGED
@@ -17,12 +17,14 @@ This Hugging Face Space provides a Gradio interface to interact with the Integra
17
  ## Features
18
 
19
  - πŸ€– **Autonomous MCP Agents** – Tool-aware FastAPI agent that plans across RAG, Web, Admin, and LLM actions
20
- - πŸ“š **Knowledge Base Ingestion** – Upload raw text, URLs, or documents (PDF/DOCX/TXT/MD) directly from the Gradio UI
 
21
  - πŸ›‘οΈ **Admin Rules Management** – Dedicated tab to add/delete governance rules; all rules are persisted in SQLite for demo purposes and enforced during every chat request
22
  - πŸ“Š **Admin Analytics** – Snapshot of tenant activity, tool usage, red-flag triggers, and overall query volume
23
  - 🌐 **Live Web Search** – DuckDuckGo-based MCP server with English-biased results
24
- - 🏒 **Multi-Tenant Isolation** – Every request requires a tenant ID; backend enforces isolation for chat, ingestion, and admin ops
25
  - πŸ”„ **Multi-Tool Selection** – MCP agent orchestrator picks the right tool chain (RAG + Web + LLM, etc.)
 
26
 
27
  ---
28
 
@@ -56,11 +58,11 @@ This Hugging Face Space provides a Gradio interface to interact with the Integra
56
  The Gradio UI exposes four tabs once you launch `app.py`:
57
 
58
  1. **Chat** – enter your Tenant ID, ask questions, and see multi-tool MCP responses.
59
- 2. **Document Ingestion** – toggle between Raw Text, URL, or File Upload to populate the tenant RAG index.
60
- 3. **Admin Analytics** – click β€œFetch Analytics Snapshot” to view overview/tool-usage/red-flag/activity metrics.
61
  4. **Admin Rules & Compliance** – upload/delete governance rules that are stored via the backend `/admin/rules` API.
62
 
63
- **Tip:** Every action requires a tenant ID, so fill that field before using any tab.
64
 
65
  ### Frontend (Next.js) Operator Console
66
 
@@ -69,10 +71,17 @@ The companion Next.js frontend (`frontend/`) now exposes dedicated pages for eac
69
  | URL | Description |
70
  | --- | --- |
71
  | `/` | Landing page with hero + quick access panels |
72
- | `/ingestion` | Data ingestion walkthrough (text/URL/files) |
73
  | `/chat` | Chat console wrapper around the MCP agent |
74
  | `/analytics` | Analytics overview and explainer |
75
  | `/admin-rules` | Admin rule ingestion explainer |
 
 
 
 
 
 
 
76
 
77
  Run the console locally with:
78
  ```bash
@@ -80,7 +89,7 @@ cd frontend
80
  npm install
81
  npm run dev
82
  ```
83
- Then open `http://localhost:3000`. The navbar links on the landing page route to each section, and you can link directly to those URLs for demo purposes.
84
 
85
  ---
86
 
@@ -91,6 +100,9 @@ Then open `http://localhost:3000`. The navbar links on the landing page route to
91
  | Chat with agent | `POST /agent/message` | Body includes `tenant_id`, `message`, optional history |
92
  | Ingest document (text/URL) | `POST /rag/ingest-document` | Accepts `source_type`, `content`, metadata |
93
  | Ingest file | `POST /rag/ingest-file` | Multipart upload with `x-tenant-id` header |
 
 
 
94
  | List analytics | `GET /analytics/overview` etc. | Used for Admin Analytics tab |
95
  | Manage rules | `GET/POST/DELETE /admin/rules` | Backend now persists rules in SQLite demo store |
96
 
 
17
  ## Features
18
 
19
  - πŸ€– **Autonomous MCP Agents** – Tool-aware FastAPI agent that plans across RAG, Web, Admin, and LLM actions
20
+ - πŸ“š **Knowledge Base Management** – Upload raw text, URLs, or documents (PDF/DOCX/TXT/MD) and manage your ingested content with delete functionality
21
+ - πŸ—‘οΈ **Document Deletion** – Delete individual documents or bulk delete all documents for a tenant with confirmation dialogs
22
  - πŸ›‘οΈ **Admin Rules Management** – Dedicated tab to add/delete governance rules; all rules are persisted in SQLite for demo purposes and enforced during every chat request
23
  - πŸ“Š **Admin Analytics** – Snapshot of tenant activity, tool usage, red-flag triggers, and overall query volume
24
  - 🌐 **Live Web Search** – DuckDuckGo-based MCP server with English-biased results
25
+ - 🏒 **Multi-Tenant Isolation** – Centralized tenant ID management with persistent storage; backend enforces strict isolation for chat, ingestion, and admin ops
26
  - πŸ”„ **Multi-Tool Selection** – MCP agent orchestrator picks the right tool chain (RAG + Web + LLM, etc.)
27
+ - ⚑ **Improved Error Handling** – Better error messages, connection error detection, and retry mechanisms
28
 
29
  ---
30
 
 
58
  The Gradio UI exposes four tabs once you launch `app.py`:
59
 
60
  1. **Chat** – enter your Tenant ID, ask questions, and see multi-tool MCP responses.
61
+ 2. **Document Ingestion** – toggle between Raw Text, URL, or File Upload to populate the tenant RAG index. View and manage your ingested documents with delete functionality.
62
+ 3. **Admin Analytics** – click "Fetch Analytics Snapshot" to view overview/tool-usage/red-flag/activity metrics.
63
  4. **Admin Rules & Compliance** – upload/delete governance rules that are stored via the backend `/admin/rules` API.
64
 
65
+ **Tip:** Every action requires a tenant ID. The tenant ID is now managed centrally and persists across page refreshes.
66
 
67
  ### Frontend (Next.js) Operator Console
68
 
 
71
  | URL | Description |
72
  | --- | --- |
73
  | `/` | Landing page with hero + quick access panels |
74
+ | `/ingestion` | Data ingestion walkthrough (text/URL/files) with document management |
75
  | `/chat` | Chat console wrapper around the MCP agent |
76
  | `/analytics` | Analytics overview and explainer |
77
  | `/admin-rules` | Admin rule ingestion explainer |
78
+ | `/knowledge-base` | View all ingested documents with search, filter, and delete functionality |
79
+
80
+ **Key Features:**
81
+ - **Centralized Tenant ID Management** – Tenant ID is managed globally via React Context and persists in localStorage
82
+ - **Document Management** – View, search, filter, and delete documents from the knowledge base
83
+ - **Improved Error Handling** – Clear error messages with retry options for failed operations
84
+ - **Real-time Updates** – Document lists automatically refresh after ingestion or deletion
85
 
86
  Run the console locally with:
87
  ```bash
 
89
  npm install
90
  npm run dev
91
  ```
92
+ Then open `http://localhost:3000`. The navbar links on the landing page route to each section, and you can link directly to those URLs for demo purposes. The tenant ID selector is available in the navbar on all pages.
93
 
94
  ---
95
 
 
100
  | Chat with agent | `POST /agent/message` | Body includes `tenant_id`, `message`, optional history |
101
  | Ingest document (text/URL) | `POST /rag/ingest-document` | Accepts `source_type`, `content`, metadata |
102
  | Ingest file | `POST /rag/ingest-file` | Multipart upload with `x-tenant-id` header |
103
+ | List documents | `GET /rag/list` | Returns all documents for a tenant with pagination |
104
+ | Delete document | `DELETE /rag/delete/{document_id}` | Deletes a specific document by ID |
105
+ | Delete all documents | `DELETE /rag/delete-all` | Deletes all documents for a tenant |
106
  | List analytics | `GET /analytics/overview` etc. | Used for Admin Analytics tab |
107
  | Manage rules | `GET/POST/DELETE /admin/rules` | Backend now persists rules in SQLite demo store |
108