Nihal2000 commited on
Commit
7573623
Β·
verified Β·
1 Parent(s): ddf962b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +127 -0
README.md CHANGED
@@ -110,6 +110,133 @@ Turn your reading list into a playlist! The **Podcast Studio** is a flagship fea
110
  - **Multi-Speaker Synthesis**: Leverages **ElevenLabs** to bring the script to life with distinct, realistic voices for each host.
111
  - **Customizable**: Choose your style (Educational, Casual, Teaching) and duration.
112
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
113
  ## πŸ† Hackathon Tracks
114
 
115
  We are submitting to:
 
110
  - **Multi-Speaker Synthesis**: Leverages **ElevenLabs** to bring the script to life with distinct, realistic voices for each host.
111
  - **Customizable**: Choose your style (Educational, Casual, Teaching) and duration.
112
 
113
+
114
+ ### ✨ Features
115
+ ## πŸ“š Document Management
116
+
117
+ Multi-format Support: PDF, DOCX, TXT, and image files (PNG, JPG, JPEG)
118
+ Intelligent OCR: Automatic text extraction from images and scanned documents
119
+ Semantic Chunking: Documents automatically split into meaningful segments for better retrieval
120
+ Metadata Tracking: Comprehensive document metadata including file size, type, creation date, and custom tags
121
+ Vector Embeddings: All documents indexed with dense vector embeddings for semantic search
122
+
123
+ ## πŸ” Advanced Search
124
+
125
+ Semantic Search: Find documents by meaning, not just keywords
126
+ Configurable Results: Adjust the number of results (1-20) based on your needs
127
+ Relevance Scoring: Each result includes a confidence score
128
+ Source Attribution: Direct links to source documents with highlighted excerpts
129
+
130
+ ## 🎨 Content Studio
131
+ Transform your documents with 8 powerful AI tools:
132
+
133
+ Summarize: Generate concise, detailed, bullet-point, or executive summaries
134
+ Generate Outline: Create structured outlines from topics or documents (3-10 sections)
135
+ Explain Concept: Get explanations tailored to different audiences (general, technical, beginner, expert)
136
+ Paraphrase: Rewrite text in various styles (formal, casual, academic, simple, technical)
137
+ Categorize: Automatically classify content into user-defined categories
138
+ Key Insights: Extract the most important points from any document
139
+ Generate Questions: Create comprehension, analysis, application, creative, or factual questions
140
+ Extract Key Info: Pull out structured information (entities, dates, facts) in JSON format
141
+
142
+ ## 🏷️ Smart Tagging
143
+
144
+ AI-Generated Tags: Automatically generate 3-15 relevant tags for any document
145
+ Persistent Storage: Tags saved directly to document metadata
146
+ Batch Processing: Tag multiple documents or custom text snippets
147
+
148
+ ## ❓ RAG-Powered Q&A
149
+
150
+ Context-Aware Answers: Ask questions and get answers grounded in your documents
151
+ Source Citations: Every answer includes relevant source excerpts
152
+ Confidence Scoring: Transparency about answer reliability
153
+ Multi-Document Synthesis: Answers can draw from multiple documents simultaneously
154
+
155
+ ## πŸŽ™οΈ Podcast Studio
156
+ Convert documents into engaging audio conversations:
157
+
158
+ AI Voice Generation: Ultra-realistic voices powered by ElevenLabs
159
+ Two-Host Format: Dynamic dialogue between two AI personalities
160
+ Multiple Styles: Conversational, educational, technical, or casual
161
+ Custom Duration: 5-30 minute podcasts
162
+ Voice Selection: Choose from 7+ professional AI voices
163
+ Full Transcripts: Complete text transcripts for every generated podcast
164
+ Podcast Library: Browse, play, and manage all generated podcasts
165
+
166
+ ## πŸ“Š Dashboard & Analytics
167
+
168
+ Real-time Stats: Track total documents, vector chunks, and storage usage
169
+ Recent Activity: View recently added documents at a glance
170
+ System Health: Monitor vector store, LLM service, and voice service status
171
+
172
+ ## Data Flow
173
+
174
+ ## Document Ingestion:
175
+ - Files β†’ OCR β†’ Text Extraction β†’ Chunking β†’ Embedding Generation β†’ Vector Store
176
+ ## Semantic Search:
177
+ - Query β†’ Embedding β†’ Vector Search β†’ Relevance Ranking β†’ Results
178
+ ## RAG Q&A:
179
+ - Question β†’ Search β†’ Context Retrieval β†’ LLM Generation β†’ Answer + Sources
180
+ ## Podcast Generation:
181
+ - Documents β†’ Content Analysis β†’ Script Generation β†’ Voice Synthesis β†’ Audio File
182
+
183
+ ### Basic Workflow
184
+ 1. Upload Documents
185
+ Navigate to the "πŸ“„ Upload Documents" tab:
186
+
187
+ Click "Select a document" or drag-and-drop files
188
+ Supported formats: PDF, DOCX, TXT, PNG, JPG, JPEG
189
+ Click "πŸš€ Process & Add to Library"
190
+ Wait for processing to complete (OCR runs automatically for images)
191
+ Note the Document ID from the output
192
+
193
+ 2. Search Your Library
194
+ Go to "πŸ” Search Documents":
195
+
196
+ Enter a natural language query (e.g., "What are the key findings about climate change?")
197
+ Adjust "Number of Results" slider (1-20)
198
+ Click "πŸ” Search"
199
+ Review results with relevance scores and source excerpts
200
+
201
+ 3. Ask Questions
202
+ Navigate to "❓ Ask Questions":
203
+
204
+ Type your question about uploaded documents
205
+ Click "❓ Get Answer"
206
+ Receive AI-generated answer with source citations
207
+ Check confidence level and review source documents
208
+
209
+ 4. Generate Content
210
+ Open "πŸ“ Content Studio":
211
+
212
+ Select a document from dropdown OR paste custom text
213
+ Choose a task from the dropdown:
214
+
215
+ Summarize, Outline, Explain, Paraphrase, etc.
216
+
217
+
218
+ Configure task-specific options in "βš™οΈ Advanced Options"
219
+ Click "πŸš€ Run Task"
220
+ Copy or download the generated content
221
+
222
+ 5. Create Podcasts
223
+ Visit "🎧 Podcast Studio":
224
+
225
+ Select 1-5 documents using checkboxes
226
+ Choose Style (conversational, educational, technical, casual)
227
+ Set Duration (5-30 minutes)
228
+ Select voices for Host 1 and Host 2
229
+ Click "πŸŽ™οΈ Generate Podcast"
230
+ Listen to the generated audio and read the transcript
231
+ Browse past podcasts in the Podcast Library
232
+
233
+ 6. Generate Tags
234
+ Go to "🏷️ Generate Tags":
235
+
236
+ Select a document OR paste custom text
237
+ Adjust "Number of Tags" slider (3-15)
238
+ Click "🏷️ Generate Tags"
239
+
240
  ## πŸ† Hackathon Tracks
241
 
242
  We are submitting to: