Nihal2000 commited on
Commit
e12888b
Β·
verified Β·
1 Parent(s): ffc9670

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +9 -8
README.md CHANGED
@@ -33,7 +33,6 @@ Unlike traditional RAG (Retrieval Augmented Generation) apps, this project lever
33
  IngestTool[πŸ“₯ Ingestion Tool]
34
  SearchTool[πŸ” Search Tool]
35
  GenTool[✨ Generative Tool]
36
- VoiceTool[πŸ—£οΈ Voice Tool]
37
  PodTool[🎧 Podcast Tool]
38
  end
39
  end
@@ -59,14 +58,16 @@ Unlike traditional RAG (Retrieval Augmented Generation) apps, this project lever
59
  IngestTool --> DocStore
60
  SearchTool --> VecStore
61
  GenTool --> LLM
62
- VoiceTool --> ElevenLabs
63
- VoiceTool --> LlamaIndex
64
  PodTool --> ElevenLabs
65
  PodTool --> LLM
66
  ```
67
 
68
 
69
- ![Design](https://cdn-uploads.huggingface.co/production/uploads/66f1712d906c08084995f808/vtn6wxUOlzOFus0uxopVt.png)
 
 
 
70
 
71
  ## πŸš€ Quick Start
72
 
@@ -74,7 +75,7 @@ Check out [QUICKSTART.md](QUICKSTART.md) for detailed local setup instructions.
74
 
75
  1. **Clone & Install**:
76
  ```bash
77
- git clone https://huggingface.co/spaces/YOUR_USERNAME/AiDigitalLibraryAssistant
78
  pip install -r requirements.txt
79
  ```
80
  2. **Configure**: Add your `OPENAI_API_KEY` and `ELEVENLABS_API_KEY` to `.env`.
@@ -83,17 +84,17 @@ Check out [QUICKSTART.md](QUICKSTART.md) for detailed local setup instructions.
83
  ## πŸ’‘ How It Works
84
 
85
  ### 1. The MCP Core
86
- At the heart of the application is the `ContentOrganizerMCPServer`. It exposes atomic capabilities (Tools) that the frontend consumes. This means the same tools powering this UI could be connected to Claude Desktop or any other MCP client!
87
 
88
  ### 2. Voice & Podcast Generation
89
  We use **ElevenLabs** for state-of-the-art text-to-speech.
90
- - **Voice Mode**: Uses a dedicated LlamaIndex agent to maintain conversation context, converting speech-to-text, querying the library, and streaming audio back.
91
  - **Podcast Mode**: An LLM first generates a script based on your documents, then we use multi-speaker synthesis to create a realistic dialogue.
92
 
93
  ## πŸ† Hackathon Tracks
94
 
95
  We are submitting to:
96
- - **Building MCP**: For our custom `ContentOrganizer` MCP server implementation.
97
  - **MCP in Action (Consumer/Creative)**: For the innovative Podcast and Voice interfaces that make personal knowledge management accessible and fun.
98
 
99
  ## πŸ“œ License
 
33
  IngestTool[πŸ“₯ Ingestion Tool]
34
  SearchTool[πŸ” Search Tool]
35
  GenTool[✨ Generative Tool]
 
36
  PodTool[🎧 Podcast Tool]
37
  end
38
  end
 
58
  IngestTool --> DocStore
59
  SearchTool --> VecStore
60
  GenTool --> LLM
61
+ PodTool --> LlamaIndex
 
62
  PodTool --> ElevenLabs
63
  PodTool --> LLM
64
  ```
65
 
66
 
67
+
68
+
69
+ ![AI LIB](https://cdn-uploads.huggingface.co/production/uploads/66f1712d906c08084995f808/TSJexR45eNpUjHhbHDOag.png)
70
+
71
 
72
  ## πŸš€ Quick Start
73
 
 
75
 
76
  1. **Clone & Install**:
77
  ```bash
78
+ git clone https://huggingface.co/spaces/Nihal2000/AiDigitalLibraryAssistant
79
  pip install -r requirements.txt
80
  ```
81
  2. **Configure**: Add your `OPENAI_API_KEY` and `ELEVENLABS_API_KEY` to `.env`.
 
84
  ## πŸ’‘ How It Works
85
 
86
  ### 1. The MCP Core
87
+ At the heart of the application is the `AiDigitalLibraryAssistant`. It exposes atomic capabilities (Tools) that the frontend consumes. This means the same tools powering this UI could be connected to Claude Desktop or any other MCP client!
88
 
89
  ### 2. Voice & Podcast Generation
90
  We use **ElevenLabs** for state-of-the-art text-to-speech.
91
+ - **Podcast Mode**: Uses a dedicated LlamaIndex agent to maintain conversation context, converting speech-to-text, querying the library, and streaming audio back.
92
  - **Podcast Mode**: An LLM first generates a script based on your documents, then we use multi-speaker synthesis to create a realistic dialogue.
93
 
94
  ## πŸ† Hackathon Tracks
95
 
96
  We are submitting to:
97
+ - **Building MCP**: For our custom `AiDigitalLibraryAssistant` MCP server implementation.
98
  - **MCP in Action (Consumer/Creative)**: For the innovative Podcast and Voice interfaces that make personal knowledge management accessible and fun.
99
 
100
  ## πŸ“œ License