ReadMe.md

# VidInsight AI: AI-Powered YouTube Content Analyzer

## Overview
VidInsight AI is an AI-powered application designed to analyze YouTube videos for a given subject, extract insights, provide transcriptions, topic, summary, key-points and a new content idea! 
The application is built to assist:
- content creators,
- educators & researchers, and
- everyday users in understanding video content quickly and effectively.

---
This ReadMe file documents the current phase of the project and will be updated as new features are implemented.

**Current Features (Asif's Code):**

	1.	YouTube Video Retrieval:
    	•	Fetches up to 10 YouTube videos based on a user-provided topic.
    	•	Filters videos based on criteria such as keywords, view counts, and trusted channels.
    	•	Selects the top 3 videos based on relevance and view counts.
    
	2.	Transcription:
    	•	Transcribes audio from the top 3 selected videos using OpenAI’s Whisper model.
    	•	Saves the complete transcripts in an `output` folder for further processing.
    
	3.	User Interface:
    	•	Input
        	•	Provides a user-friendly interface built with Gradio.
    	•	Output
        	•	Displays video details (title, channel, views) and a preview of the transcription.
        	•	Analysis (Topic, Summary & Key Points)
        	•	Content Idea with comprehensive details
---

## Project Structure

VidInsight-AI/\
├── app.py                                 # Gradio web interface for user interaction\
├── config.py                              # Configuration file for API keys and filters\
├── fetch_youtube_videos.py                # Fetches and filters YouTube videos\
├── transcribe_videos.py                   # Transcribes videos and saves transcripts\
├── summary.py                             # Generates summaries from transcriptions\
├── YouTubeAgent.py                        # Creates content ideas using Gemini AI\
├── main.py                                # CLI-based alternative to run the app\
├── requirements.txt                       # Project dependencies\
├── keys1.env                              # Environment variables (API keys)\
└── output/                                # Folder for saved transcripts\
&nbsp;&nbsp;&nbsp; └── <video_id>.txt     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; # Transcripts saved as text files\

### Key Components:
	1.	Interface Files:
    	•	`app.py`: Web interface using Gradio
    	•	`main.py`: Command-line interface
	2.	Core Processing Files:
    	•	`fetch_youtube_videos.py`: Video retrieval
    	•	`transcribe_videos.py`: Audio transcription
    	•	`summary.py`: Content summarization
    	•	`YouTubeAgent.py`: Content idea generation
	3.	Configuration Files:
    	•	`config.py`: Settings and filters
    	•	`keys1.env`: API keys
    	•	`requirements.txt`: Dependencies
	4.	Output Directory:
    	•	`output/`: Stores generated transcripts

---

## Setup Instructions (need to be completed)

1. Prerequisites\
	•	Python 3.8 or higher\
	•	FFmpeg installed on the system (for audio processing)
	•	A YouTube Data API key (create one via Google Cloud Console)
	•	A GEMINI API key 
	•	A TAVILY API key 

3. Installation
	1.	Clone the repository:
      ```python
      git clone <repository_url>
      ```
   	2.	Install required dependencies:

   	3.	Set up your API key:
	•	Create a `.env` file or update `keys1.env` with your YouTube API key:
    ```python
    YOUTUBE_API_KEY="your_api_key_here"
    GEMINI_API_KEY="your_api_key_here"
    TAVILY_API_KEY="your_api_key_here"
    ```
   \
    
4. Running the Application\
	•	Using the Gradio Interface:
    ```python
    python app.py
    ```
    \
   •	Using the CLI:
    ```python
    python main.py
    ```
---

## Usage

#### Gradio App
	1.	Enter a topic in the “Enter learning topic” field (e.g., “Machine Learning”).
	2.	Click “Submit” to fetch and analyze videos.
	3.	View results, including:
    	•	Video title, channel name, view count.
    	•	A preview of the transcription.
    	•	The path to the saved transcript file.
    	•	Topic, Summary, and Key-Points
    	•	A New Content Idea with Compreehensive Details    
#### Output Folder
	•	Complete transcripts are saved in the `output/` folder as `.txt` files.
	•	File names are based on unique YouTube video IDs (e.g., `ukzFI9rgwfU.txt`).

---

## Configuration

The `config.py` file allows customization of filtering criteria:
```python
FILTER_CONFIG = {
    "videoDuration": "medium",  # Focus on videos between 4 and 20 minutes
    "order": "relevance",       # Sort by relevance
    "trusted_channels": {
        "Khan Academy": "UC4a-Gbdw7vOaccHmFo40b9g",
        "edX": "UCEBb1b_L6zDS3xTUrIALZOw",
        "Coursera": "UC58aowNEXHHnflR_5YTtP4g",
    },
    "teaching_keywords": {"tutorial", "lesson", "course", "how-to", "introduction", "basics"},
    "non_teaching_keywords": {"fun", "experiment", "joke", "prank", "vlog"},
    "max_results": 10,          # Maximum number of videos fetched from YouTube API
    "min_view_count": 10000     # Minimum view count for relevance
}
```

---

## Known Issues
	1.	If no results are found or an error occurs during video fetching, the app displays an error message in JSON format.
	2.	Ensure that valid topics are entered; overly broad or unrelated topics may not yield meaningful results.

---

## Future Features        
	1.	Multilingual Support (Future):
    	•	Add support for transcription in other languages (e.g., Spanish, French).
        
	2.	Interactive Q&A (Future):
    	•	Allow users to ask questions about analyzed video content.

---

## 🛠️ Technology Stack

| Task  | Technology |
| -------- | ------- |
| Video Retrieval | YouTube Data API, google-api-python-client   |
| Transcription | yt-dlp, OpenAI Whisper     |
| Summarization  | Gemini AI, LangChain  |
| Content Generation | Gemini AI, LangChain   |
| Vectorizaton | ____  |
| Vector Database | ____  |


---
## 📌 Contributors
	•	Asif Khan – Developer and Project Lead
    •	Kade Thomas – Summarization Specialist
    •	Amit Gaikwad - Vector Database Specialist
    •	Simranpreet Saini – AI Agent Specialist
    •	Jason Brooks – Documentation Specialist

---
## 🙏 Acknowledgements 
- Special thanks to Firas Obeid for being an advisor on the project
- Special thanks to OpenAI, Hugging Face, and YouTube API, Gemini API, and Tavily API for providing the tools that made this project possible. 🚀